From 6b810775bfb032b3af0f098b3386b017192dda93 Mon Sep 17 00:00:00 2001 From: "Aspose.Email Team" Date: Sun, 6 Jun 2021 12:51:18 -0500 Subject: [PATCH 1/3] SDK version 21.4.0.149 generated --- sdk/AsposeEmailCloudSdk/models/ai_name_component.py | 8 ++++++++ sdk/docs/AiNameGenderizeRequest.md | 8 ++++---- sdk/setup.py | 2 +- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/sdk/AsposeEmailCloudSdk/models/ai_name_component.py b/sdk/AsposeEmailCloudSdk/models/ai_name_component.py index 3aae10e..64e206a 100644 --- a/sdk/AsposeEmailCloudSdk/models/ai_name_component.py +++ b/sdk/AsposeEmailCloudSdk/models/ai_name_component.py @@ -146,6 +146,10 @@ def score(self, score: float): """ if score is None: raise ValueError("Invalid value for `score`, must not be `None`") + if score is not None and score > 1.0: + raise ValueError("Invalid value for `score`, must be a value less than or equal to `1.0`") + if score is not None and score < 0.0: + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0.0`") self._score = score @property @@ -168,6 +172,10 @@ def position(self, position: int): """ if position is None: raise ValueError("Invalid value for `position`, must not be `None`") + if position is not None and position > 2147483647: + raise ValueError("Invalid value for `position`, must be a value less than or equal to `2147483647`") + if position is not None and position < 0: + raise ValueError("Invalid value for `position`, must be a value greater than or equal to `0`") self._position = position def to_dict(self): diff --git a/sdk/docs/AiNameGenderizeRequest.md b/sdk/docs/AiNameGenderizeRequest.md index bbbbe12..46acb4f 100644 --- a/sdk/docs/AiNameGenderizeRequest.md +++ b/sdk/docs/AiNameGenderizeRequest.md @@ -7,10 +7,10 @@ Request model for AiNameApi.genderize Name | Type | Description | Notes ---- | ---- | ----------- | ----- **name** |**str** |A name to genderize. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] +**encoding** |**str** |A character encoding name. |[optional] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] **style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] ## Example diff --git a/sdk/setup.py b/sdk/setup.py index 21517fb..9160ad1 100644 --- a/sdk/setup.py +++ b/sdk/setup.py @@ -8,7 +8,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "aspose-email-cloud" -VERSION = "21.4.0.140" +VERSION = "21.4.0.149" # To install the library, run the following # # python setup.py install From 6c99652e5798517788ae80da0d87de993d49aab3 Mon Sep 17 00:00:00 2001 From: "Aspose.Email Team" Date: Thu, 10 Jun 2021 14:03:40 -0500 Subject: [PATCH 2/3] SDK version 21.4.0.150 generated --- sdk/setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/setup.py b/sdk/setup.py index 9160ad1..c2ae651 100644 --- a/sdk/setup.py +++ b/sdk/setup.py @@ -8,7 +8,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "aspose-email-cloud" -VERSION = "21.4.0.149" +VERSION = "21.4.0.150" # To install the library, run the following # # python setup.py install From ce2c641ce21b988b5207aef77bae825bd8820886 Mon Sep 17 00:00:00 2001 From: Marat Gumerov Date: Tue, 20 Jul 2021 01:48:11 +0400 Subject: [PATCH 3/3] Markdown documentation removed --- sdk/docs/AiBcrApi.md | 229 ---- sdk/docs/AiBcrApi_list.md | 8 - sdk/docs/AiBcrImage.md | 14 - sdk/docs/AiBcrImageStorageFile.md | 25 - sdk/docs/AiBcrOptions.md | 15 - sdk/docs/AiBcrParseRequest.md | 21 - sdk/docs/AiBcrParseStorageRequest.md | 31 - sdk/docs/AiGroup.md | 7 - sdk/docs/AiNameApi.md | 983 ----------------- sdk/docs/AiNameApi_list.md | 17 - sdk/docs/AiNameCompleteRequest.md | 20 - sdk/docs/AiNameComponent.md | 17 - sdk/docs/AiNameComponentList.md | 36 - sdk/docs/AiNameCulturalContext.md | 18 - sdk/docs/AiNameExpandRequest.md | 20 - sdk/docs/AiNameExtracted.md | 28 - sdk/docs/AiNameExtractedComponent.md | 15 - sdk/docs/AiNameExtractedList.md | 14 - sdk/docs/AiNameFormatRequest.md | 22 - sdk/docs/AiNameFormatted.md | 22 - sdk/docs/AiNameGenderHypothesis.md | 21 - sdk/docs/AiNameGenderHypothesisList.md | 14 - sdk/docs/AiNameGenderizeRequest.md | 20 - sdk/docs/AiNameMatchParsedRequest.md | 54 - sdk/docs/AiNameMatchRequest.md | 22 - sdk/docs/AiNameMatchResult.md | 25 - sdk/docs/AiNameMismatch.md | 23 - sdk/docs/AiNameParseEmailAddressRequest.md | 20 - sdk/docs/AiNameParseRequest.md | 22 - sdk/docs/AiNameParsedRequest.md | 38 - sdk/docs/AiNameWeighted.md | 15 - sdk/docs/AiNameWeightedVariants.md | 27 - sdk/docs/AlternateView.md | 37 - sdk/docs/AssociatedPerson.md | 16 - sdk/docs/Attachment.md | 19 - sdk/docs/AttachmentBase.md | 17 - sdk/docs/CalendarApi.md | 999 ------------------ sdk/docs/CalendarApi_list.md | 16 - sdk/docs/CalendarAsAlternateRequest.md | 40 - sdk/docs/CalendarAsFileRequest.md | 38 - sdk/docs/CalendarConvertRequest.md | 17 - sdk/docs/CalendarDto.md | 57 - sdk/docs/CalendarFromFileRequest.md | 15 - sdk/docs/CalendarGetAsAlternateRequest.md | 22 - sdk/docs/CalendarGetAsFileRequest.md | 21 - sdk/docs/CalendarGetListRequest.md | 21 - sdk/docs/CalendarGetRequest.md | 19 - sdk/docs/CalendarReminder.md | 21 - sdk/docs/CalendarSaveRequest.md | 42 - sdk/docs/CalendarStorageList.md | 43 - sdk/docs/ClientAccountApi.md | 407 ------- sdk/docs/ClientAccountApi_list.md | 10 - sdk/docs/ClientAccountBaseRequest.md | 14 - sdk/docs/ClientAccountGetMultiRequest.md | 19 - sdk/docs/ClientAccountGetRequest.md | 19 - sdk/docs/ClientAccountSaveMultiRequest.md | 49 - sdk/docs/ClientAccountSaveRequest.md | 37 - sdk/docs/ClientFolderApi.md | 191 ---- sdk/docs/ClientFolderApi_list.md | 9 - sdk/docs/ClientFolderCreateRequest.md | 27 - sdk/docs/ClientFolderDeleteRequest.md | 25 - sdk/docs/ClientFolderGetListRequest.md | 21 - sdk/docs/ClientGroup.md | 9 - sdk/docs/ClientMessageApi.md | 753 ------------- sdk/docs/ClientMessageApi_list.md | 16 - sdk/docs/ClientMessageAppendFileRequest.md | 26 - sdk/docs/ClientMessageAppendRequest.md | 50 - sdk/docs/ClientMessageBaseRequest.md | 15 - sdk/docs/ClientMessageDeleteRequest.md | 26 - sdk/docs/ClientMessageFetchFileRequest.md | 25 - sdk/docs/ClientMessageFetchRequest.md | 27 - sdk/docs/ClientMessageListRequest.md | 29 - sdk/docs/ClientMessageMoveRequest.md | 28 - sdk/docs/ClientMessageSendFileRequest.md | 23 - sdk/docs/ClientMessageSendRequest.md | 46 - sdk/docs/ClientMessageSetIsReadRequest.md | 26 - sdk/docs/ClientThreadApi.md | 374 ------- sdk/docs/ClientThreadApi_list.md | 11 - sdk/docs/ClientThreadBaseRequest.md | 15 - sdk/docs/ClientThreadDeleteRequest.md | 26 - sdk/docs/ClientThreadGetListRequest.md | 23 - sdk/docs/ClientThreadGetMessagesRequest.md | 23 - sdk/docs/ClientThreadMoveRequest.md | 28 - sdk/docs/ClientThreadSetIsReadRequest.md | 28 - sdk/docs/CloudStorageGroup.md | 8 - sdk/docs/ContactApi.md | 889 ---------------- sdk/docs/ContactApi_list.md | 14 - sdk/docs/ContactAsFileRequest.md | 50 - sdk/docs/ContactConvertRequest.md | 19 - sdk/docs/ContactDto.md | 83 -- sdk/docs/ContactFromFileRequest.md | 17 - sdk/docs/ContactGetAsFileRequest.md | 23 - sdk/docs/ContactGetListRequest.md | 23 - sdk/docs/ContactGetRequest.md | 21 - sdk/docs/ContactList.md | 50 - sdk/docs/ContactPhoto.md | 16 - sdk/docs/ContactSaveRequest.md | 54 - sdk/docs/ContactStorageList.md | 55 - sdk/docs/ContentType.md | 18 - sdk/docs/ContentTypeParameter.md | 15 - sdk/docs/CopyFileRequest.md | 22 - sdk/docs/CopyFolderRequest.md | 21 - sdk/docs/CreateFolderRequest.md | 17 - sdk/docs/CustomerEvent.md | 15 - sdk/docs/DailyRecurrencePatternDto.md | 14 - sdk/docs/DeleteFileRequest.md | 18 - sdk/docs/DeleteFolderRequest.md | 19 - sdk/docs/DiscUsage.md | 22 - sdk/docs/DiscoverEmailConfigRequest.md | 16 - sdk/docs/DisposableEmailApi.md | 69 -- sdk/docs/DisposableEmailApi_list.md | 7 - .../DisposableEmailIsDisposableRequest.md | 15 - sdk/docs/DownloadFileRequest.md | 18 - sdk/docs/EmailAccountConfig.md | 21 - sdk/docs/EmailAccountConfigList.md | 58 - sdk/docs/EmailAddress.md | 19 - sdk/docs/EmailApi.md | 811 -------------- sdk/docs/EmailApi_list.md | 14 - sdk/docs/EmailAsFileRequest.md | 41 - sdk/docs/EmailClientAccount.md | 37 - sdk/docs/EmailClientAccountCredentials.md | 15 - .../EmailClientAccountOauthCredentials.md | 18 - .../EmailClientAccountPasswordCredentials.md | 15 - sdk/docs/EmailClientMultiAccount.md | 45 - sdk/docs/EmailConfigApi.md | 443 -------- sdk/docs/EmailConfigApi_list.md | 9 - sdk/docs/EmailConfigDiscoverOauthRequest.md | 26 - .../EmailConfigDiscoverPasswordRequest.md | 21 - sdk/docs/EmailConfigDiscoverRequest.md | 16 - sdk/docs/EmailConvertRequest.md | 19 - sdk/docs/EmailDto.md | 70 -- sdk/docs/EmailFromFileRequest.md | 17 - sdk/docs/EmailGetAsFileRequest.md | 21 - sdk/docs/EmailGetListRequest.md | 23 - sdk/docs/EmailGetRequest.md | 21 - sdk/docs/EmailList.md | 14 - sdk/docs/EmailSaveRequest.md | 46 - sdk/docs/EmailStorageList.md | 46 - sdk/docs/EmailThread.md | 69 -- sdk/docs/EmailThreadList.md | 42 - ...numWithCustomOfAssociatedPersonCategory.md | 13 - .../EnumWithCustomOfEmailAddressCategory.md | 13 - sdk/docs/EnumWithCustomOfEventCategory.md | 13 - ...numWithCustomOfInstantMessengerCategory.md | 13 - .../EnumWithCustomOfPhoneNumberCategory.md | 13 - .../EnumWithCustomOfPostalAddressCategory.md | 13 - sdk/docs/EnumWithCustomOfUrlCategory.md | 13 - sdk/docs/Error.md | 17 - sdk/docs/ErrorDetails.md | 15 - sdk/docs/FileApi.md | 289 ----- sdk/docs/FileApi_list.md | 11 - sdk/docs/FileVersion.md | 16 - sdk/docs/FileVersions.md | 27 - sdk/docs/FilesList.md | 25 - sdk/docs/FilesUploadResult.md | 15 - sdk/docs/FolderApi.md | 297 ------ sdk/docs/FolderApi_list.md | 11 - sdk/docs/GetDiscUsageRequest.md | 15 - sdk/docs/GetFileVersionsRequest.md | 17 - sdk/docs/GetFilesListRequest.md | 17 - sdk/docs/InstantMessengerAddress.md | 16 - sdk/docs/LinkedResource.md | 15 - sdk/docs/ListResponseOfAiNameComponent.md | 12 - sdk/docs/ListResponseOfAiNameExtracted.md | 12 - .../ListResponseOfAiNameGenderHypothesis.md | 12 - sdk/docs/ListResponseOfContactDto.md | 12 - sdk/docs/ListResponseOfEmailAccountConfig.md | 12 - sdk/docs/ListResponseOfEmailDto.md | 12 - sdk/docs/ListResponseOfEmailThread.md | 12 - sdk/docs/ListResponseOfMailMessageBase.md | 12 - sdk/docs/ListResponseOfMailServerFolder.md | 12 - sdk/docs/ListResponseOfStorageFileLocation.md | 12 - ...ListResponseOfStorageModelOfCalendarDto.md | 12 - .../ListResponseOfStorageModelOfContactDto.md | 12 - .../ListResponseOfStorageModelOfEmailDto.md | 12 - sdk/docs/MailAddress.md | 17 - sdk/docs/MailMessageBase.md | 20 - sdk/docs/MailMessageBase64.md | 22 - sdk/docs/MailMessageBaseList.md | 14 - sdk/docs/MailMessageDto.md | 41 - sdk/docs/MailMessageMapi.md | 48 - sdk/docs/MailServerFolder.md | 15 - sdk/docs/MailServerFolderList.md | 14 - sdk/docs/MapiAttachmentDto.md | 22 - sdk/docs/MapiBinaryPropertyDto.md | 15 - sdk/docs/MapiBooleanPropertyDto.md | 15 - sdk/docs/MapiCalendarApi.md | 617 ----------- sdk/docs/MapiCalendarApi_list.md | 11 - sdk/docs/MapiCalendarAsFileRequest.md | 49 - sdk/docs/MapiCalendarAttendeesDto.md | 17 - .../MapiCalendarDailyRecurrencePatternDto.md | 15 - sdk/docs/MapiCalendarDto.md | 64 -- sdk/docs/MapiCalendarEventRecurrenceDto.md | 19 - sdk/docs/MapiCalendarExceptionInfoDto.md | 27 - sdk/docs/MapiCalendarFromFileRequest.md | 15 - sdk/docs/MapiCalendarGetRequest.md | 19 - sdk/docs/MapiCalendarRecurrencePatternDto.md | 27 - sdk/docs/MapiCalendarSaveRequest.md | 53 - sdk/docs/MapiCalendarTimeZoneDto.md | 15 - sdk/docs/MapiCalendarTimeZoneInfoDto.md | 20 - sdk/docs/MapiCalendarTimeZoneRuleDto.md | 22 - .../MapiCalendarWeeklyRecurrencePatternDto.md | 15 - ...darYearlyAndMonthlyRecurrencePatternDto.md | 17 - sdk/docs/MapiContactApi.md | 495 --------- sdk/docs/MapiContactApi_list.md | 11 - sdk/docs/MapiContactAsFileRequest.md | 34 - sdk/docs/MapiContactDto.md | 40 - sdk/docs/MapiContactElectronicAddressDto.md | 19 - ...iContactElectronicAddressPropertySetDto.md | 22 - sdk/docs/MapiContactEventPropertySetDto.md | 15 - sdk/docs/MapiContactFromFileRequest.md | 17 - sdk/docs/MapiContactGetRequest.md | 21 - sdk/docs/MapiContactNamePropertySetDto.md | 23 - sdk/docs/MapiContactOtherPropertySetDto.md | 21 - .../MapiContactPersonalInfoPropertySetDto.md | 32 - sdk/docs/MapiContactPhotoDto.md | 14 - sdk/docs/MapiContactPhysicalAddressDto.md | 22 - ...apiContactPhysicalAddressPropertySetDto.md | 16 - .../MapiContactProfessionalPropertySetDto.md | 20 - sdk/docs/MapiContactSaveRequest.md | 38 - .../MapiContactTelephonePropertySetDto.md | 32 - sdk/docs/MapiDateTimePropertyDto.md | 15 - sdk/docs/MapiElectronicAddressDto.md | 18 - sdk/docs/MapiFileAsPropertyDto.md | 15 - sdk/docs/MapiGroup.md | 8 - sdk/docs/MapiImportancePropertyDto.md | 15 - sdk/docs/MapiIntPropertyDto.md | 15 - sdk/docs/MapiKnownPropertyDescriptor.md | 15 - sdk/docs/MapiLegacyFreeBusyPropertyDto.md | 15 - sdk/docs/MapiMessageApi.md | 627 ----------- sdk/docs/MapiMessageApi_list.md | 11 - sdk/docs/MapiMessageAsFileRequest.md | 49 - sdk/docs/MapiMessageDto.md | 71 -- sdk/docs/MapiMessageFromFileRequest.md | 17 - sdk/docs/MapiMessageGetRequest.md | 21 - sdk/docs/MapiMessageItemBaseDto.md | 30 - sdk/docs/MapiMessageSaveRequest.md | 53 - sdk/docs/MapiMultiIntPropertyDto.md | 15 - sdk/docs/MapiMultiStringPropertyDto.md | 15 - .../MapiPhysicalAddressIndexPropertyDto.md | 15 - sdk/docs/MapiPidLidPropertyDescriptor.md | 16 - sdk/docs/MapiPidNamePropertyDescriptor.md | 15 - sdk/docs/MapiPidPropertyDescriptor.md | 18 - sdk/docs/MapiPidTagPropertyDescriptor.md | 16 - sdk/docs/MapiPropertyDescriptor.md | 20 - sdk/docs/MapiPropertyDto.md | 22 - sdk/docs/MapiRecipientDto.md | 26 - sdk/docs/MapiResponseTypePropertyDto.md | 23 - sdk/docs/MapiStringPropertyDto.md | 23 - sdk/docs/Models.md | 248 ----- sdk/docs/MonthlyRecurrencePatternDto.md | 26 - sdk/docs/MoveFileRequest.md | 22 - sdk/docs/MoveFolderRequest.md | 21 - sdk/docs/NameValuePair.md | 22 - sdk/docs/ObjectExist.md | 21 - sdk/docs/ObjectExistsRequest.md | 18 - sdk/docs/PhoneNumber.md | 25 - sdk/docs/PostalAddress.md | 38 - sdk/docs/README.md | 28 - sdk/docs/RecurrencePatternDto.md | 25 - sdk/docs/ReminderAttendee.md | 20 - sdk/docs/ReminderTrigger.md | 23 - sdk/docs/StorageApi.md | 289 ----- sdk/docs/StorageApi_list.md | 10 - sdk/docs/StorageExist.md | 20 - sdk/docs/StorageExistsRequest.md | 16 - sdk/docs/StorageFile.md | 27 - sdk/docs/StorageFileLocation.md | 23 - sdk/docs/StorageFileLocationList.md | 24 - sdk/docs/StorageFolderLocation.md | 22 - sdk/docs/StorageModelOfCalendarDto.md | 13 - sdk/docs/StorageModelOfContactDto.md | 13 - sdk/docs/StorageModelOfEmailClientAccount.md | 13 - .../StorageModelOfEmailClientMultiAccount.md | 13 - sdk/docs/StorageModelOfEmailDto.md | 13 - sdk/docs/StorageModelOfMapiCalendarDto.md | 13 - sdk/docs/StorageModelOfMapiContactDto.md | 13 - sdk/docs/StorageModelOfMapiMessageDto.md | 13 - sdk/docs/TaskRegeneratingPatternDto.md | 24 - sdk/docs/UploadFileRequest.md | 19 - sdk/docs/Url.md | 25 - sdk/docs/ValueTOfBoolean.md | 12 - sdk/docs/ValueTOfString.md | 12 - sdk/docs/WeeklyRecurrencePatternDto.md | 26 - sdk/docs/YearlyRecurrencePatternDto.md | 27 - 285 files changed, 15046 deletions(-) delete mode 100644 sdk/docs/AiBcrApi.md delete mode 100644 sdk/docs/AiBcrApi_list.md delete mode 100644 sdk/docs/AiBcrImage.md delete mode 100644 sdk/docs/AiBcrImageStorageFile.md delete mode 100644 sdk/docs/AiBcrOptions.md delete mode 100644 sdk/docs/AiBcrParseRequest.md delete mode 100644 sdk/docs/AiBcrParseStorageRequest.md delete mode 100644 sdk/docs/AiGroup.md delete mode 100644 sdk/docs/AiNameApi.md delete mode 100644 sdk/docs/AiNameApi_list.md delete mode 100644 sdk/docs/AiNameCompleteRequest.md delete mode 100644 sdk/docs/AiNameComponent.md delete mode 100644 sdk/docs/AiNameComponentList.md delete mode 100644 sdk/docs/AiNameCulturalContext.md delete mode 100644 sdk/docs/AiNameExpandRequest.md delete mode 100644 sdk/docs/AiNameExtracted.md delete mode 100644 sdk/docs/AiNameExtractedComponent.md delete mode 100644 sdk/docs/AiNameExtractedList.md delete mode 100644 sdk/docs/AiNameFormatRequest.md delete mode 100644 sdk/docs/AiNameFormatted.md delete mode 100644 sdk/docs/AiNameGenderHypothesis.md delete mode 100644 sdk/docs/AiNameGenderHypothesisList.md delete mode 100644 sdk/docs/AiNameGenderizeRequest.md delete mode 100644 sdk/docs/AiNameMatchParsedRequest.md delete mode 100644 sdk/docs/AiNameMatchRequest.md delete mode 100644 sdk/docs/AiNameMatchResult.md delete mode 100644 sdk/docs/AiNameMismatch.md delete mode 100644 sdk/docs/AiNameParseEmailAddressRequest.md delete mode 100644 sdk/docs/AiNameParseRequest.md delete mode 100644 sdk/docs/AiNameParsedRequest.md delete mode 100644 sdk/docs/AiNameWeighted.md delete mode 100644 sdk/docs/AiNameWeightedVariants.md delete mode 100644 sdk/docs/AlternateView.md delete mode 100644 sdk/docs/AssociatedPerson.md delete mode 100644 sdk/docs/Attachment.md delete mode 100644 sdk/docs/AttachmentBase.md delete mode 100644 sdk/docs/CalendarApi.md delete mode 100644 sdk/docs/CalendarApi_list.md delete mode 100644 sdk/docs/CalendarAsAlternateRequest.md delete mode 100644 sdk/docs/CalendarAsFileRequest.md delete mode 100644 sdk/docs/CalendarConvertRequest.md delete mode 100644 sdk/docs/CalendarDto.md delete mode 100644 sdk/docs/CalendarFromFileRequest.md delete mode 100644 sdk/docs/CalendarGetAsAlternateRequest.md delete mode 100644 sdk/docs/CalendarGetAsFileRequest.md delete mode 100644 sdk/docs/CalendarGetListRequest.md delete mode 100644 sdk/docs/CalendarGetRequest.md delete mode 100644 sdk/docs/CalendarReminder.md delete mode 100644 sdk/docs/CalendarSaveRequest.md delete mode 100644 sdk/docs/CalendarStorageList.md delete mode 100644 sdk/docs/ClientAccountApi.md delete mode 100644 sdk/docs/ClientAccountApi_list.md delete mode 100644 sdk/docs/ClientAccountBaseRequest.md delete mode 100644 sdk/docs/ClientAccountGetMultiRequest.md delete mode 100644 sdk/docs/ClientAccountGetRequest.md delete mode 100644 sdk/docs/ClientAccountSaveMultiRequest.md delete mode 100644 sdk/docs/ClientAccountSaveRequest.md delete mode 100644 sdk/docs/ClientFolderApi.md delete mode 100644 sdk/docs/ClientFolderApi_list.md delete mode 100644 sdk/docs/ClientFolderCreateRequest.md delete mode 100644 sdk/docs/ClientFolderDeleteRequest.md delete mode 100644 sdk/docs/ClientFolderGetListRequest.md delete mode 100644 sdk/docs/ClientGroup.md delete mode 100644 sdk/docs/ClientMessageApi.md delete mode 100644 sdk/docs/ClientMessageApi_list.md delete mode 100644 sdk/docs/ClientMessageAppendFileRequest.md delete mode 100644 sdk/docs/ClientMessageAppendRequest.md delete mode 100644 sdk/docs/ClientMessageBaseRequest.md delete mode 100644 sdk/docs/ClientMessageDeleteRequest.md delete mode 100644 sdk/docs/ClientMessageFetchFileRequest.md delete mode 100644 sdk/docs/ClientMessageFetchRequest.md delete mode 100644 sdk/docs/ClientMessageListRequest.md delete mode 100644 sdk/docs/ClientMessageMoveRequest.md delete mode 100644 sdk/docs/ClientMessageSendFileRequest.md delete mode 100644 sdk/docs/ClientMessageSendRequest.md delete mode 100644 sdk/docs/ClientMessageSetIsReadRequest.md delete mode 100644 sdk/docs/ClientThreadApi.md delete mode 100644 sdk/docs/ClientThreadApi_list.md delete mode 100644 sdk/docs/ClientThreadBaseRequest.md delete mode 100644 sdk/docs/ClientThreadDeleteRequest.md delete mode 100644 sdk/docs/ClientThreadGetListRequest.md delete mode 100644 sdk/docs/ClientThreadGetMessagesRequest.md delete mode 100644 sdk/docs/ClientThreadMoveRequest.md delete mode 100644 sdk/docs/ClientThreadSetIsReadRequest.md delete mode 100644 sdk/docs/CloudStorageGroup.md delete mode 100644 sdk/docs/ContactApi.md delete mode 100644 sdk/docs/ContactApi_list.md delete mode 100644 sdk/docs/ContactAsFileRequest.md delete mode 100644 sdk/docs/ContactConvertRequest.md delete mode 100644 sdk/docs/ContactDto.md delete mode 100644 sdk/docs/ContactFromFileRequest.md delete mode 100644 sdk/docs/ContactGetAsFileRequest.md delete mode 100644 sdk/docs/ContactGetListRequest.md delete mode 100644 sdk/docs/ContactGetRequest.md delete mode 100644 sdk/docs/ContactList.md delete mode 100644 sdk/docs/ContactPhoto.md delete mode 100644 sdk/docs/ContactSaveRequest.md delete mode 100644 sdk/docs/ContactStorageList.md delete mode 100644 sdk/docs/ContentType.md delete mode 100644 sdk/docs/ContentTypeParameter.md delete mode 100644 sdk/docs/CopyFileRequest.md delete mode 100644 sdk/docs/CopyFolderRequest.md delete mode 100644 sdk/docs/CreateFolderRequest.md delete mode 100644 sdk/docs/CustomerEvent.md delete mode 100644 sdk/docs/DailyRecurrencePatternDto.md delete mode 100644 sdk/docs/DeleteFileRequest.md delete mode 100644 sdk/docs/DeleteFolderRequest.md delete mode 100644 sdk/docs/DiscUsage.md delete mode 100644 sdk/docs/DiscoverEmailConfigRequest.md delete mode 100644 sdk/docs/DisposableEmailApi.md delete mode 100644 sdk/docs/DisposableEmailApi_list.md delete mode 100644 sdk/docs/DisposableEmailIsDisposableRequest.md delete mode 100644 sdk/docs/DownloadFileRequest.md delete mode 100644 sdk/docs/EmailAccountConfig.md delete mode 100644 sdk/docs/EmailAccountConfigList.md delete mode 100644 sdk/docs/EmailAddress.md delete mode 100644 sdk/docs/EmailApi.md delete mode 100644 sdk/docs/EmailApi_list.md delete mode 100644 sdk/docs/EmailAsFileRequest.md delete mode 100644 sdk/docs/EmailClientAccount.md delete mode 100644 sdk/docs/EmailClientAccountCredentials.md delete mode 100644 sdk/docs/EmailClientAccountOauthCredentials.md delete mode 100644 sdk/docs/EmailClientAccountPasswordCredentials.md delete mode 100644 sdk/docs/EmailClientMultiAccount.md delete mode 100644 sdk/docs/EmailConfigApi.md delete mode 100644 sdk/docs/EmailConfigApi_list.md delete mode 100644 sdk/docs/EmailConfigDiscoverOauthRequest.md delete mode 100644 sdk/docs/EmailConfigDiscoverPasswordRequest.md delete mode 100644 sdk/docs/EmailConfigDiscoverRequest.md delete mode 100644 sdk/docs/EmailConvertRequest.md delete mode 100644 sdk/docs/EmailDto.md delete mode 100644 sdk/docs/EmailFromFileRequest.md delete mode 100644 sdk/docs/EmailGetAsFileRequest.md delete mode 100644 sdk/docs/EmailGetListRequest.md delete mode 100644 sdk/docs/EmailGetRequest.md delete mode 100644 sdk/docs/EmailList.md delete mode 100644 sdk/docs/EmailSaveRequest.md delete mode 100644 sdk/docs/EmailStorageList.md delete mode 100644 sdk/docs/EmailThread.md delete mode 100644 sdk/docs/EmailThreadList.md delete mode 100644 sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md delete mode 100644 sdk/docs/EnumWithCustomOfEmailAddressCategory.md delete mode 100644 sdk/docs/EnumWithCustomOfEventCategory.md delete mode 100644 sdk/docs/EnumWithCustomOfInstantMessengerCategory.md delete mode 100644 sdk/docs/EnumWithCustomOfPhoneNumberCategory.md delete mode 100644 sdk/docs/EnumWithCustomOfPostalAddressCategory.md delete mode 100644 sdk/docs/EnumWithCustomOfUrlCategory.md delete mode 100644 sdk/docs/Error.md delete mode 100644 sdk/docs/ErrorDetails.md delete mode 100644 sdk/docs/FileApi.md delete mode 100644 sdk/docs/FileApi_list.md delete mode 100644 sdk/docs/FileVersion.md delete mode 100644 sdk/docs/FileVersions.md delete mode 100644 sdk/docs/FilesList.md delete mode 100644 sdk/docs/FilesUploadResult.md delete mode 100644 sdk/docs/FolderApi.md delete mode 100644 sdk/docs/FolderApi_list.md delete mode 100644 sdk/docs/GetDiscUsageRequest.md delete mode 100644 sdk/docs/GetFileVersionsRequest.md delete mode 100644 sdk/docs/GetFilesListRequest.md delete mode 100644 sdk/docs/InstantMessengerAddress.md delete mode 100644 sdk/docs/LinkedResource.md delete mode 100644 sdk/docs/ListResponseOfAiNameComponent.md delete mode 100644 sdk/docs/ListResponseOfAiNameExtracted.md delete mode 100644 sdk/docs/ListResponseOfAiNameGenderHypothesis.md delete mode 100644 sdk/docs/ListResponseOfContactDto.md delete mode 100644 sdk/docs/ListResponseOfEmailAccountConfig.md delete mode 100644 sdk/docs/ListResponseOfEmailDto.md delete mode 100644 sdk/docs/ListResponseOfEmailThread.md delete mode 100644 sdk/docs/ListResponseOfMailMessageBase.md delete mode 100644 sdk/docs/ListResponseOfMailServerFolder.md delete mode 100644 sdk/docs/ListResponseOfStorageFileLocation.md delete mode 100644 sdk/docs/ListResponseOfStorageModelOfCalendarDto.md delete mode 100644 sdk/docs/ListResponseOfStorageModelOfContactDto.md delete mode 100644 sdk/docs/ListResponseOfStorageModelOfEmailDto.md delete mode 100644 sdk/docs/MailAddress.md delete mode 100644 sdk/docs/MailMessageBase.md delete mode 100644 sdk/docs/MailMessageBase64.md delete mode 100644 sdk/docs/MailMessageBaseList.md delete mode 100644 sdk/docs/MailMessageDto.md delete mode 100644 sdk/docs/MailMessageMapi.md delete mode 100644 sdk/docs/MailServerFolder.md delete mode 100644 sdk/docs/MailServerFolderList.md delete mode 100644 sdk/docs/MapiAttachmentDto.md delete mode 100644 sdk/docs/MapiBinaryPropertyDto.md delete mode 100644 sdk/docs/MapiBooleanPropertyDto.md delete mode 100644 sdk/docs/MapiCalendarApi.md delete mode 100644 sdk/docs/MapiCalendarApi_list.md delete mode 100644 sdk/docs/MapiCalendarAsFileRequest.md delete mode 100644 sdk/docs/MapiCalendarAttendeesDto.md delete mode 100644 sdk/docs/MapiCalendarDailyRecurrencePatternDto.md delete mode 100644 sdk/docs/MapiCalendarDto.md delete mode 100644 sdk/docs/MapiCalendarEventRecurrenceDto.md delete mode 100644 sdk/docs/MapiCalendarExceptionInfoDto.md delete mode 100644 sdk/docs/MapiCalendarFromFileRequest.md delete mode 100644 sdk/docs/MapiCalendarGetRequest.md delete mode 100644 sdk/docs/MapiCalendarRecurrencePatternDto.md delete mode 100644 sdk/docs/MapiCalendarSaveRequest.md delete mode 100644 sdk/docs/MapiCalendarTimeZoneDto.md delete mode 100644 sdk/docs/MapiCalendarTimeZoneInfoDto.md delete mode 100644 sdk/docs/MapiCalendarTimeZoneRuleDto.md delete mode 100644 sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md delete mode 100644 sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md delete mode 100644 sdk/docs/MapiContactApi.md delete mode 100644 sdk/docs/MapiContactApi_list.md delete mode 100644 sdk/docs/MapiContactAsFileRequest.md delete mode 100644 sdk/docs/MapiContactDto.md delete mode 100644 sdk/docs/MapiContactElectronicAddressDto.md delete mode 100644 sdk/docs/MapiContactElectronicAddressPropertySetDto.md delete mode 100644 sdk/docs/MapiContactEventPropertySetDto.md delete mode 100644 sdk/docs/MapiContactFromFileRequest.md delete mode 100644 sdk/docs/MapiContactGetRequest.md delete mode 100644 sdk/docs/MapiContactNamePropertySetDto.md delete mode 100644 sdk/docs/MapiContactOtherPropertySetDto.md delete mode 100644 sdk/docs/MapiContactPersonalInfoPropertySetDto.md delete mode 100644 sdk/docs/MapiContactPhotoDto.md delete mode 100644 sdk/docs/MapiContactPhysicalAddressDto.md delete mode 100644 sdk/docs/MapiContactPhysicalAddressPropertySetDto.md delete mode 100644 sdk/docs/MapiContactProfessionalPropertySetDto.md delete mode 100644 sdk/docs/MapiContactSaveRequest.md delete mode 100644 sdk/docs/MapiContactTelephonePropertySetDto.md delete mode 100644 sdk/docs/MapiDateTimePropertyDto.md delete mode 100644 sdk/docs/MapiElectronicAddressDto.md delete mode 100644 sdk/docs/MapiFileAsPropertyDto.md delete mode 100644 sdk/docs/MapiGroup.md delete mode 100644 sdk/docs/MapiImportancePropertyDto.md delete mode 100644 sdk/docs/MapiIntPropertyDto.md delete mode 100644 sdk/docs/MapiKnownPropertyDescriptor.md delete mode 100644 sdk/docs/MapiLegacyFreeBusyPropertyDto.md delete mode 100644 sdk/docs/MapiMessageApi.md delete mode 100644 sdk/docs/MapiMessageApi_list.md delete mode 100644 sdk/docs/MapiMessageAsFileRequest.md delete mode 100644 sdk/docs/MapiMessageDto.md delete mode 100644 sdk/docs/MapiMessageFromFileRequest.md delete mode 100644 sdk/docs/MapiMessageGetRequest.md delete mode 100644 sdk/docs/MapiMessageItemBaseDto.md delete mode 100644 sdk/docs/MapiMessageSaveRequest.md delete mode 100644 sdk/docs/MapiMultiIntPropertyDto.md delete mode 100644 sdk/docs/MapiMultiStringPropertyDto.md delete mode 100644 sdk/docs/MapiPhysicalAddressIndexPropertyDto.md delete mode 100644 sdk/docs/MapiPidLidPropertyDescriptor.md delete mode 100644 sdk/docs/MapiPidNamePropertyDescriptor.md delete mode 100644 sdk/docs/MapiPidPropertyDescriptor.md delete mode 100644 sdk/docs/MapiPidTagPropertyDescriptor.md delete mode 100644 sdk/docs/MapiPropertyDescriptor.md delete mode 100644 sdk/docs/MapiPropertyDto.md delete mode 100644 sdk/docs/MapiRecipientDto.md delete mode 100644 sdk/docs/MapiResponseTypePropertyDto.md delete mode 100644 sdk/docs/MapiStringPropertyDto.md delete mode 100644 sdk/docs/Models.md delete mode 100644 sdk/docs/MonthlyRecurrencePatternDto.md delete mode 100644 sdk/docs/MoveFileRequest.md delete mode 100644 sdk/docs/MoveFolderRequest.md delete mode 100644 sdk/docs/NameValuePair.md delete mode 100644 sdk/docs/ObjectExist.md delete mode 100644 sdk/docs/ObjectExistsRequest.md delete mode 100644 sdk/docs/PhoneNumber.md delete mode 100644 sdk/docs/PostalAddress.md delete mode 100644 sdk/docs/README.md delete mode 100644 sdk/docs/RecurrencePatternDto.md delete mode 100644 sdk/docs/ReminderAttendee.md delete mode 100644 sdk/docs/ReminderTrigger.md delete mode 100644 sdk/docs/StorageApi.md delete mode 100644 sdk/docs/StorageApi_list.md delete mode 100644 sdk/docs/StorageExist.md delete mode 100644 sdk/docs/StorageExistsRequest.md delete mode 100644 sdk/docs/StorageFile.md delete mode 100644 sdk/docs/StorageFileLocation.md delete mode 100644 sdk/docs/StorageFileLocationList.md delete mode 100644 sdk/docs/StorageFolderLocation.md delete mode 100644 sdk/docs/StorageModelOfCalendarDto.md delete mode 100644 sdk/docs/StorageModelOfContactDto.md delete mode 100644 sdk/docs/StorageModelOfEmailClientAccount.md delete mode 100644 sdk/docs/StorageModelOfEmailClientMultiAccount.md delete mode 100644 sdk/docs/StorageModelOfEmailDto.md delete mode 100644 sdk/docs/StorageModelOfMapiCalendarDto.md delete mode 100644 sdk/docs/StorageModelOfMapiContactDto.md delete mode 100644 sdk/docs/StorageModelOfMapiMessageDto.md delete mode 100644 sdk/docs/TaskRegeneratingPatternDto.md delete mode 100644 sdk/docs/UploadFileRequest.md delete mode 100644 sdk/docs/Url.md delete mode 100644 sdk/docs/ValueTOfBoolean.md delete mode 100644 sdk/docs/ValueTOfString.md delete mode 100644 sdk/docs/WeeklyRecurrencePatternDto.md delete mode 100644 sdk/docs/YearlyRecurrencePatternDto.md diff --git a/sdk/docs/AiBcrApi.md b/sdk/docs/AiBcrApi.md deleted file mode 100644 index cf75e12..0000000 --- a/sdk/docs/AiBcrApi.md +++ /dev/null @@ -1,229 +0,0 @@ -# AsposeEmailCloudSdk.AiBcrApi (EmailCloud.ai.bcr) - -AI Business card recognition operations. - - -## parse - -Description: Parse images to vCard document models - -Returns: List of vCards - -Method call example: -```python -result = api.ai.bcr.parse(request) -``` - -### Parameter: request - -Description: parse method request. - -See parameter model documentation at [AiBcrParseRequest](AiBcrParseRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiBcrParseRequest( - file='/path/to/image.png', - countries='us', - languages='en', - is_single=True) -``` - -
- -### Result - -Description: List of vCards - -Return type: [**ContactList**](ContactList.md) - -
- Result example - -```python -result = models.ContactList( - value=[ - models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiBcrParseRequest( - file='/path/to/image.png', - countries='us', - languages='en', - is_single=True) - -// Call method: -result = api.ai.bcr.parse(request) - -// Result example: -result = models.ContactList( - value=[ - models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## parse_storage - -Description: Parse images from storage to vCard files - -Returns: List of vCard files located on storage - -Method call example: -```python -result = api.ai.bcr.parse_storage(request) -``` - -### Parameter: request - -Description: Request with images located on storage - -See parameter model documentation at [AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) - -
- Parameter initialization example: - -```python -request = models.AiBcrParseStorageRequest( - out_folder=models.StorageFolderLocation( - storage='First Storage', - folder_path='VCard/files/produced/by/parser/will/be/placed/here'), - images=[ - models.AiBcrImageStorageFile( - file=models.StorageFileLocation( - file_name='VCardScanImage.jpg', - storage='First Storage', - folder_path='image/location/on/storage'), - is_single=True)]) -``` - -
- -### Result - -Description: List of vCard files located on storage - -Return type: [**StorageFileLocationList**](StorageFileLocationList.md) - -
- Result example - -```python -result = models.StorageFileLocationList( - value=[ - models.StorageFileLocation( - file_name='fileOnStorage.txt', - storage='First Storage', - folder_path='file/location/folder/on/storage')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiBcrParseStorageRequest( - out_folder=models.StorageFolderLocation( - storage='First Storage', - folder_path='VCard/files/produced/by/parser/will/be/placed/here'), - images=[ - models.AiBcrImageStorageFile( - file=models.StorageFileLocation( - file_name='VCardScanImage.jpg', - storage='First Storage', - folder_path='image/location/on/storage'), - is_single=True)]) - -// Call method: -result = api.ai.bcr.parse_storage(request) - -// Result example: -result = models.StorageFileLocationList( - value=[ - models.StorageFileLocation( - file_name='fileOnStorage.txt', - storage='First Storage', - folder_path='file/location/folder/on/storage')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiBcrApi_list.md b/sdk/docs/AiBcrApi_list.md deleted file mode 100644 index 3d42de2..0000000 --- a/sdk/docs/AiBcrApi_list.md +++ /dev/null @@ -1,8 +0,0 @@ -## Documentation for AiBcrApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**parse**](AiBcrApi.md#parse)| **PUT** /email/AiBcr/parse| Parse images to vCard document models -[**parse_storage**](AiBcrApi.md#parse_storage)| **PUT** /email/AiBcr/parse-storage| Parse images from storage to vCard files diff --git a/sdk/docs/AiBcrImage.md b/sdk/docs/AiBcrImage.md deleted file mode 100644 index 4fe003d..0000000 --- a/sdk/docs/AiBcrImage.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.AiBcrImage - -Image for recognition - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**is_single** |**bool** |Determines that image contains single VCard or more. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiBcrImageStorageFile.md b/sdk/docs/AiBcrImageStorageFile.md deleted file mode 100644 index 8c9f88e..0000000 --- a/sdk/docs/AiBcrImageStorageFile.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.AiBcrImageStorageFile - -Image from storage for recognition - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file** |[**StorageFileLocation**](StorageFileLocation.md) |Image location | - -Parent class: [AiBcrImage](AiBcrImage.md) - - -## Example -```python -ai_bcr_image_storage_file = models.AiBcrImageStorageFile( - file=models.StorageFileLocation( - file_name='VCardScanImage.jpg', - storage='First Storage', - folder_path='image/location/on/storage'), - is_single=True) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiBcrOptions.md b/sdk/docs/AiBcrOptions.md deleted file mode 100644 index 2315f0a..0000000 --- a/sdk/docs/AiBcrOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.AiBcrOptions - -Recognition options. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**languages** |**str** |Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. |[optional] -**countries** |**str** |Comma-separated codes of countries. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiBcrParseRequest.md b/sdk/docs/AiBcrParseRequest.md deleted file mode 100644 index 1ed6e24..0000000 --- a/sdk/docs/AiBcrParseRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# AiBcrParseRequest - -Request model for AiBcrApi.parse - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file** |**str** |File to parse | -**countries** |**str** |Comma-separated codes of countries. |[optional] [default to ] -**languages** |**str** |Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. |[optional] [default to ] -**is_single** |**bool** |Determines that image contains single VCard or more. |[optional] [default to true] - -## Example -```python -request = models.AiBcrParseRequest( - file='/path/to/image.png', - countries='us', - languages='en', - is_single=True) -``` diff --git a/sdk/docs/AiBcrParseStorageRequest.md b/sdk/docs/AiBcrParseStorageRequest.md deleted file mode 100644 index 3ec8ff1..0000000 --- a/sdk/docs/AiBcrParseStorageRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -# AsposeEmailCloudSdk.models.AiBcrParseStorageRequest - -Parse business card images from Storage request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**out_folder** |[**StorageFolderLocation**](StorageFolderLocation.md) |Parse output folder location on storage | -**images** |[**list[AiBcrImageStorageFile]**](AiBcrImageStorageFile.md) |Images to parse. | -**options** |[**AiBcrOptions**](AiBcrOptions.md) |Recognition options. |[optional] - - - -## Example -```python -ai_bcr_parse_storage_request = models.AiBcrParseStorageRequest( - out_folder=models.StorageFolderLocation( - storage='First Storage', - folder_path='VCard/files/produced/by/parser/will/be/placed/here'), - images=[ - models.AiBcrImageStorageFile( - file=models.StorageFileLocation( - file_name='VCardScanImage.jpg', - storage='First Storage', - folder_path='image/location/on/storage'), - is_single=True)]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiGroup.md b/sdk/docs/AiGroup.md deleted file mode 100644 index ca00df8..0000000 --- a/sdk/docs/AiGroup.md +++ /dev/null @@ -1,7 +0,0 @@ -# EmailCloud.Ai -AI powered operations. - -API | Description ---- | ----------- -[EmailCloud.ai.**bcr**](AiBcrApi_list.md) | AI Business card recognition operations. -[EmailCloud.ai.**name**](AiNameApi_list.md) | AI Name operations. diff --git a/sdk/docs/AiNameApi.md b/sdk/docs/AiNameApi.md deleted file mode 100644 index c6ff65f..0000000 --- a/sdk/docs/AiNameApi.md +++ /dev/null @@ -1,983 +0,0 @@ -# AsposeEmailCloudSdk.AiNameApi (EmailCloud.ai.name) - -AI Name operations. - - -## complete - -Description: The call proposes k most probable names for given starting characters. - -Returns: List of name variations. - -Method call example: -```python -result = api.ai.name.complete(request) -``` - -### Parameter: request - -Description: complete method request. - -See parameter model documentation at [AiNameCompleteRequest](AiNameCompleteRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameCompleteRequest( - name='Dav') -``` - -
- -### Result - -Description: List of name variations. - -Return type: [**AiNameWeightedVariants**](AiNameWeightedVariants.md) - -
- Result example - -```python -result = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameCompleteRequest( - name='Dav') - -// Call method: -result = api.ai.name.complete(request) - -// Result example: -result = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## expand - -Description: Expands a person's name into a list of possible alternatives using options for expanding instructions. - -Returns: List of name variations. - -Method call example: -```python -result = api.ai.name.expand(request) -``` - -### Parameter: request - -Description: expand method request. - -See parameter model documentation at [AiNameExpandRequest](AiNameExpandRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameExpandRequest( - name='John Cane') -``` - -
- -### Result - -Description: List of name variations. - -Return type: [**AiNameWeightedVariants**](AiNameWeightedVariants.md) - -
- Result example - -```python -result = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameExpandRequest( - name='John Cane') - -// Call method: -result = api.ai.name.expand(request) - -// Result example: -result = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## expand_parsed - -Description: Expands a person's parsed name into a list of possible alternatives using options for expanding instructions. - -Returns: List of name variations. - -Method call example: -```python -result = api.ai.name.expand_parsed(request) -``` - -### Parameter: request - -Description: Parsed name with options. - -See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) - -
- Parameter initialization example: - -```python -request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - -
- -### Result - -Description: List of name variations. - -Return type: [**AiNameWeightedVariants**](AiNameWeightedVariants.md) - -
- Result example - -```python -result = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) - -// Call method: -result = api.ai.name.expand_parsed(request) - -// Result example: -result = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## format - -Description: Formats a person's name in correct case and name order using options for formatting instructions. - -Returns: Formatted name. - -Method call example: -```python -result = api.ai.name.format(request) -``` - -### Parameter: request - -Description: format method request. - -See parameter model documentation at [AiNameFormatRequest](AiNameFormatRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameFormatRequest( - name='Mr. John Michael Cane', - format='%t%L%f%m') -``` - -
- -### Result - -Description: Formatted name. - -Return type: [**AiNameFormatted**](AiNameFormatted.md) - -
- Result example - -```python -result = models.AiNameFormatted( - name='Mr. Cane J. M.', - comments='format: %t%L%f%m; source: parsed format') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameFormatRequest( - name='Mr. John Michael Cane', - format='%t%L%f%m') - -// Call method: -result = api.ai.name.format(request) - -// Result example: -result = models.AiNameFormatted( - name='Mr. Cane J. M.', - comments='format: %t%L%f%m; source: parsed format') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## format_parsed - -Description: Formats a person's parsed name in correct case and name order using options for formatting instructions. - -Returns: Formatted name. - -Method call example: -```python -result = api.ai.name.format_parsed(request) -``` - -### Parameter: request - -Description: Parsed name with options. - -See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) - -
- Parameter initialization example: - -```python -request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - -
- -### Result - -Description: Formatted name. - -Return type: [**AiNameFormatted**](AiNameFormatted.md) - -
- Result example - -```python -result = models.AiNameFormatted( - name='Mr. Cane J. M.', - comments='format: %t%L%f%m; source: parsed format') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) - -// Call method: -result = api.ai.name.format_parsed(request) - -// Result example: -result = models.AiNameFormatted( - name='Mr. Cane J. M.', - comments='format: %t%L%f%m; source: parsed format') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## genderize - -Description: Detect person's gender from name string. - -Returns: Hypotheses about person's gender. - -Method call example: -```python -result = api.ai.name.genderize(request) -``` - -### Parameter: request - -Description: genderize method request. - -See parameter model documentation at [AiNameGenderizeRequest](AiNameGenderizeRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameGenderizeRequest( - name='John Cane') -``` - -
- -### Result - -Description: Hypotheses about person's gender. - -Return type: [**AiNameGenderHypothesisList**](AiNameGenderHypothesisList.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameGenderizeRequest( - name='John Cane') - -// Call method: -result = api.ai.name.genderize(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## genderize_parsed - -Description: Detect person's gender from parsed name. - -Returns: Hypotheses about person's gender. - -Method call example: -```python -result = api.ai.name.genderize_parsed(request) -``` - -### Parameter: request - -Description: Gender detection request data. - -See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) - -
- Parameter initialization example: - -```python -request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - -
- -### Result - -Description: Hypotheses about person's gender. - -Return type: [**AiNameGenderHypothesisList**](AiNameGenderHypothesisList.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) - -// Call method: -result = api.ai.name.genderize_parsed(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## match - -Description: Compare people's names. Uses options for comparing instructions. - -Returns: Match result. - -Method call example: -```python -result = api.ai.name.match(request) -``` - -### Parameter: request - -Description: match method request. - -See parameter model documentation at [AiNameMatchRequest](AiNameMatchRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameMatchRequest( - name='John Michael Cane', - other_name='Cane J.') -``` - -
- -### Result - -Description: Match result. - -Return type: [**AiNameMatchResult**](AiNameMatchResult.md) - -
- Result example - -```python -result = models.AiNameMatchResult( - similarity=0.6, - mismatches=[ - models.AiNameMismatch( - category='Gender', - explanation='no_match')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameMatchRequest( - name='John Michael Cane', - other_name='Cane J.') - -// Call method: -result = api.ai.name.match(request) - -// Result example: -result = models.AiNameMatchResult( - similarity=0.6, - mismatches=[ - models.AiNameMismatch( - category='Gender', - explanation='no_match')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## match_parsed - -Description: Compare people's parsed names and attributes. Uses options for comparing instructions. - -Returns: Match result. - -Method call example: -```python -result = api.ai.name.match_parsed(request) -``` - -### Parameter: request - -Description: Parsed names to match. - -See parameter model documentation at [AiNameMatchParsedRequest](AiNameMatchParsedRequest.md) - -
- Parameter initialization example: - -```python -request = models.AiNameMatchParsedRequest( - other_parsed_name=[ - models.AiNameComponent( - value='J', - category='FirstInitial', - score=1), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=3), - models.AiNameComponent( - value='%f%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)], - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - -
- -### Result - -Description: Match result. - -Return type: [**AiNameMatchResult**](AiNameMatchResult.md) - -
- Result example - -```python -result = models.AiNameMatchResult( - similarity=0.6, - mismatches=[ - models.AiNameMismatch( - category='Gender', - explanation='no_match')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameMatchParsedRequest( - other_parsed_name=[ - models.AiNameComponent( - value='J', - category='FirstInitial', - score=1), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=3), - models.AiNameComponent( - value='%f%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)], - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) - -// Call method: -result = api.ai.name.match_parsed(request) - -// Result example: -result = models.AiNameMatchResult( - similarity=0.6, - mismatches=[ - models.AiNameMismatch( - category='Gender', - explanation='no_match')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## parse - -Description: Parse name to components. - -Returns: List of name components. - -Method call example: -```python -result = api.ai.name.parse(request) -``` - -### Parameter: request - -Description: parse method request. - -See parameter model documentation at [AiNameParseRequest](AiNameParseRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameParseRequest( - name='John Cane', - language='eng', - location='USA') -``` - -
- -### Result - -Description: List of name components. - -Return type: [**AiNameComponentList**](AiNameComponentList.md) - -
- Result example - -```python -result = models.AiNameComponentList( - value=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameParseRequest( - name='John Cane', - language='eng', - location='USA') - -// Call method: -result = api.ai.name.parse(request) - -// Result example: -result = models.AiNameComponentList( - value=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## parse_email_address - -Description: Parse person's name out of an email address. - -Returns: Match result. - -Method call example: -```python -result = api.ai.name.parse_email_address(request) -``` - -### Parameter: request - -Description: parse_email_address method request. - -See parameter model documentation at [AiNameParseEmailAddressRequest](AiNameParseEmailAddressRequest.md). - -
- Parameter initialization example: - -```python -request = models.AiNameParseEmailAddressRequest( - email_address='john-cane@gmail.com') -``` - -
- -### Result - -Description: Match result. - -Return type: [**AiNameExtractedList**](AiNameExtractedList.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.AiNameParseEmailAddressRequest( - email_address='john-cane@gmail.com') - -// Call method: -result = api.ai.name.parse_email_address(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameApi_list.md b/sdk/docs/AiNameApi_list.md deleted file mode 100644 index 87b148d..0000000 --- a/sdk/docs/AiNameApi_list.md +++ /dev/null @@ -1,17 +0,0 @@ -## Documentation for AiNameApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**complete**](AiNameApi.md#complete)| **GET** /email/AiName/complete| The call proposes k most probable names for given starting characters. -[**expand**](AiNameApi.md#expand)| **GET** /email/AiName/expand| Expands a person's name into a list of possible alternatives using options for expanding instructions. -[**expand_parsed**](AiNameApi.md#expand_parsed)| **PUT** /email/AiName/expand-parsed| Expands a person's parsed name into a list of possible alternatives using options for expanding instructions. -[**format**](AiNameApi.md#format)| **GET** /email/AiName/format| Formats a person's name in correct case and name order using options for formatting instructions. -[**format_parsed**](AiNameApi.md#format_parsed)| **PUT** /email/AiName/format-parsed| Formats a person's parsed name in correct case and name order using options for formatting instructions. -[**genderize**](AiNameApi.md#genderize)| **GET** /email/AiName/genderize| Detect person's gender from name string. -[**genderize_parsed**](AiNameApi.md#genderize_parsed)| **PUT** /email/AiName/genderize-parsed| Detect person's gender from parsed name. -[**match**](AiNameApi.md#match)| **GET** /email/AiName/match| Compare people's names. Uses options for comparing instructions. -[**match_parsed**](AiNameApi.md#match_parsed)| **PUT** /email/AiName/match-parsed| Compare people's parsed names and attributes. Uses options for comparing instructions. -[**parse**](AiNameApi.md#parse)| **GET** /email/AiName/parse| Parse name to components. -[**parse_email_address**](AiNameApi.md#parse_email_address)| **GET** /email/AiName/parse-email-address| Parse person's name out of an email address. diff --git a/sdk/docs/AiNameCompleteRequest.md b/sdk/docs/AiNameCompleteRequest.md deleted file mode 100644 index ca479b2..0000000 --- a/sdk/docs/AiNameCompleteRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# AiNameCompleteRequest - -Request model for AiNameApi.complete - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**name** |**str** |A name to complete. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameCompleteRequest( - name='Dav') -``` diff --git a/sdk/docs/AiNameComponent.md b/sdk/docs/AiNameComponent.md deleted file mode 100644 index 9d8e5be..0000000 --- a/sdk/docs/AiNameComponent.md +++ /dev/null @@ -1,17 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameComponent - -Parsed name component - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Component value |[optional] -**category** |**str** |Name component category. Enum, available values: Unknown, Mononym, Score, Format, FirstInitial, FirstName, MiddleInitial, MiddleName, MiddleNickname, MiddleSobriquet, MiddleMaidenName, MiddlePatronym, MiddleMatronym, LastInitial, LastName, LastNobiliaryParticle, LastNominalConjunction, LastPaternalSurname, LastMaternalSurname, PrefixTitle, PostfixGenerationalTitle, PostfixPostnominalLetters, ArabicIsm, ArabicKunya, ArabicNasab, ArabicSlaqab, ArabicNisbah | -**score** |**float** |Score from 0.0 to 1.0 | -**position** |**int** |Component position from 0 | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameComponentList.md b/sdk/docs/AiNameComponentList.md deleted file mode 100644 index 24638a7..0000000 --- a/sdk/docs/AiNameComponentList.md +++ /dev/null @@ -1,36 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameComponentList - -List of name components - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfAiNameComponent](ListResponseOfAiNameComponent.md) - - -## Example -```python -ai_name_component_list = models.AiNameComponentList( - value=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameCulturalContext.md b/sdk/docs/AiNameCulturalContext.md deleted file mode 100644 index f2de3d0..0000000 --- a/sdk/docs/AiNameCulturalContext.md +++ /dev/null @@ -1,18 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameCulturalContext - -AiName cultural context - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) |[optional] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France |[optional] -**script** |**str** |A writing system code; starts with the ISO-15924 script name |[optional] -**encoding** |**str** |A character encoding name |[optional] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameExpandRequest.md b/sdk/docs/AiNameExpandRequest.md deleted file mode 100644 index 86e81fd..0000000 --- a/sdk/docs/AiNameExpandRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# AiNameExpandRequest - -Request model for AiNameApi.expand - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**name** |**str** |A name to expand. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameExpandRequest( - name='John Cane') -``` diff --git a/sdk/docs/AiNameExtracted.md b/sdk/docs/AiNameExtracted.md deleted file mode 100644 index 7276a61..0000000 --- a/sdk/docs/AiNameExtracted.md +++ /dev/null @@ -1,28 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameExtracted - -Extracted name - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |[**list[AiNameExtractedComponent]**](AiNameExtractedComponent.md) |Extracted name components |[optional] -**score** |**float** |Extracted name score | - - - -## Example -```python -ai_name_extracted = models.AiNameExtracted( - name=[ - models.AiNameExtractedComponent( - category='Surname', - value='Cane'), - models.AiNameExtractedComponent( - category='SomeName', - value='John')], - score=0.5) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameExtractedComponent.md b/sdk/docs/AiNameExtractedComponent.md deleted file mode 100644 index c56bb2e..0000000 --- a/sdk/docs/AiNameExtractedComponent.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameExtractedComponent - -Extracted name component - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |**str** |Extracted from email address name component category. Enum, available values: Unknown, GivenName, Surname, SomeName, NoName, Initial | -**value** |**str** |Extracted value |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameExtractedList.md b/sdk/docs/AiNameExtractedList.md deleted file mode 100644 index e42e75a..0000000 --- a/sdk/docs/AiNameExtractedList.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameExtractedList - -Extracted name list. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfAiNameExtracted](ListResponseOfAiNameExtracted.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameFormatRequest.md b/sdk/docs/AiNameFormatRequest.md deleted file mode 100644 index 8184b57..0000000 --- a/sdk/docs/AiNameFormatRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# AiNameFormatRequest - -Request model for AiNameApi.format - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**name** |**str** |A name to format. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] -**format** |**str** |Format of the name. Predefined format can be used by ID, or custom format can be specified. Predefined formats: /format/default/ (= '%t%F%m%N%L%p') /format/FN+LN/ (= '%F%L') /format/title+FN+LN/ (= '%t%F%L') /format/FN+MN+LN/ (= '%F%M%N%L') /format/title+FN+MN+LN/ (= '%t%F%M%N%L') /format/FN+MI+LN/ (= '%F%m%N%L') /format/title+FN+MI+LN/ (= '%t%F%m%N%L') /format/LN/ (= '%L') /format/title+LN/ (= '%t%L') /format/LN+FN+MN/ (= '%L,%F%M%N') /format/LN+title+FN+MN/ (= '%L,%t%F%M%N') /format/LN+FN+MI/ (= '%L,%F%m%N') /format/LN+title+FN+MI/ (= '%L,%t%F%m%N') Custom format string - custom combination of characters and the next term placeholders: '%t' - Title (prefix) '%F' - First name '%f' - First initial '%M' - Middle name(s) '%m' - Middle initial(s) '%N' - Nickname '%L' - Last name '%l' - Last initial '%p' - Postfix If no value for format option was provided, its default value is '%t%F%m%N%L%p' |[optional] [default to ] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameFormatRequest( - name='Mr. John Michael Cane', - format='%t%L%f%m') -``` diff --git a/sdk/docs/AiNameFormatted.md b/sdk/docs/AiNameFormatted.md deleted file mode 100644 index 687b8c6..0000000 --- a/sdk/docs/AiNameFormatted.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameFormatted - -Formatted name - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Formatted name value |[optional] -**comments** |**str** |Usually empty; can contain extra message describing some issue occurred during the formatting |[optional] - - - -## Example -```python -ai_name_formatted = models.AiNameFormatted( - name='Mr. Cane J. M.', - comments='format: %t%L%f%m; source: parsed format') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameGenderHypothesis.md b/sdk/docs/AiNameGenderHypothesis.md deleted file mode 100644 index 36fcea2..0000000 --- a/sdk/docs/AiNameGenderHypothesis.md +++ /dev/null @@ -1,21 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameGenderHypothesis - -Name gender hypothesis - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gender** |**str** |Recognized name gender. Enum, available values: Male, Female, Unknown | -**score** |**float** |Hypothesis score | - - - -## Example -```python -ai_name_gender_hypothesis = models.AiNameGenderHypothesis( - score=0.8) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameGenderHypothesisList.md b/sdk/docs/AiNameGenderHypothesisList.md deleted file mode 100644 index af87482..0000000 --- a/sdk/docs/AiNameGenderHypothesisList.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameGenderHypothesisList - -Hypotheses about person's gender - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfAiNameGenderHypothesis](ListResponseOfAiNameGenderHypothesis.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameGenderizeRequest.md b/sdk/docs/AiNameGenderizeRequest.md deleted file mode 100644 index 46acb4f..0000000 --- a/sdk/docs/AiNameGenderizeRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# AiNameGenderizeRequest - -Request model for AiNameApi.genderize - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**name** |**str** |A name to genderize. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] -**encoding** |**str** |A character encoding name. |[optional] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameGenderizeRequest( - name='John Cane') -``` diff --git a/sdk/docs/AiNameMatchParsedRequest.md b/sdk/docs/AiNameMatchParsedRequest.md deleted file mode 100644 index 86701f8..0000000 --- a/sdk/docs/AiNameMatchParsedRequest.md +++ /dev/null @@ -1,54 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameMatchParsedRequest - -Two parsed names to match request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**other_parsed_name** |[**list[AiNameComponent]**](AiNameComponent.md) |Other parsed name to match | - -Parent class: [AiNameParsedRequest](AiNameParsedRequest.md) - - -## Example -```python -ai_name_match_parsed_request = models.AiNameMatchParsedRequest( - other_parsed_name=[ - models.AiNameComponent( - value='J', - category='FirstInitial', - score=1), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=3), - models.AiNameComponent( - value='%f%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)], - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameMatchRequest.md b/sdk/docs/AiNameMatchRequest.md deleted file mode 100644 index fad06a8..0000000 --- a/sdk/docs/AiNameMatchRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# AiNameMatchRequest - -Request model for AiNameApi.match - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**name** |**str** |A name to match. | -**other_name** |**str** |Another name to match. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameMatchRequest( - name='John Michael Cane', - other_name='Cane J.') -``` diff --git a/sdk/docs/AiNameMatchResult.md b/sdk/docs/AiNameMatchResult.md deleted file mode 100644 index 80fcf59..0000000 --- a/sdk/docs/AiNameMatchResult.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameMatchResult - -Two names match result - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**similarity** |**float** |Similarity score | -**mismatches** |[**list[AiNameMismatch]**](AiNameMismatch.md) |Detailed description of mismatches |[optional] - - - -## Example -```python -ai_name_match_result = models.AiNameMatchResult( - similarity=0.6, - mismatches=[ - models.AiNameMismatch( - category='Gender', - explanation='no_match')]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameMismatch.md b/sdk/docs/AiNameMismatch.md deleted file mode 100644 index fc31c73..0000000 --- a/sdk/docs/AiNameMismatch.md +++ /dev/null @@ -1,23 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameMismatch - -Names mismatch detailed description - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |**str** |Mismatch type. Enum, available values: Unknown, FirstName, MiddleName, MiddleLastName, MiddleNickname, Gender, Context | -**similarity** |**float** |Similarity score | -**explanation** |**str** |Explanation or mismatch subtype |[optional] - - - -## Example -```python -ai_name_mismatch = models.AiNameMismatch( - category='Gender', - explanation='no_match') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameParseEmailAddressRequest.md b/sdk/docs/AiNameParseEmailAddressRequest.md deleted file mode 100644 index 4850653..0000000 --- a/sdk/docs/AiNameParseEmailAddressRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# AiNameParseEmailAddressRequest - -Request model for AiNameApi.parse_email_address - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**email_address** |**str** |Email address to parse. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameParseEmailAddressRequest( - email_address='john-cane@gmail.com') -``` diff --git a/sdk/docs/AiNameParseRequest.md b/sdk/docs/AiNameParseRequest.md deleted file mode 100644 index 9e66915..0000000 --- a/sdk/docs/AiNameParseRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# AiNameParseRequest - -Request model for AiNameApi.parse - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**name** |**str** |A name to parse. | -**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] -**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] -**encoding** |**str** |A character encoding name. |[optional] [default to ] -**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] -**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] - -## Example -```python -request = models.AiNameParseRequest( - name='John Cane', - language='eng', - location='USA') -``` diff --git a/sdk/docs/AiNameParsedRequest.md b/sdk/docs/AiNameParsedRequest.md deleted file mode 100644 index 7753ba5..0000000 --- a/sdk/docs/AiNameParsedRequest.md +++ /dev/null @@ -1,38 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameParsedRequest - -Parsed name request model - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cultural_context** |[**AiNameCulturalContext**](AiNameCulturalContext.md) |AiName parser cultural context |[optional] -**format** |**str** |Format of the name. Predefined format can be used by ID, or custom format can be specified. Predefined formats: /format/default/ (= '%t%F%m%N%L%p') /format/FN+LN/ (= '%F%L') /format/title+FN+LN/ (= '%t%F%L') /format/FN+MN+LN/ (= '%F%M%N%L') /format/title+FN+MN+LN/ (= '%t%F%M%N%L') /format/FN+MI+LN/ (= '%F%m%N%L') /format/title+FN+MI+LN/ (= '%t%F%m%N%L') /format/LN/ (= '%L') /format/title+LN/ (= '%t%L') /format/LN+FN+MN/ (= '%L,%F%M%N') /format/LN+title+FN+MN/ (= '%L,%t%F%M%N') /format/LN+FN+MI/ (= '%L,%F%m%N') /format/LN+title+FN+MI/ (= '%L,%t%F%m%N') Custom format string - custom combination of characters and the next term placeholders: '%t' - Title (prefix) '%F' - First name '%f' - First initial '%M' - Middle name(s) '%m' - Middle initial(s) '%N' - Nickname '%L' - Last name '%l' - Last initial '%p' - Postfix If no value for format option was provided, its default value is '%t%F%m%N%L%p' |[optional] -**parsed_name** |[**list[AiNameComponent]**](AiNameComponent.md) |Parsed name | - - - -## Example -```python -ai_name_parsed_request = models.AiNameParsedRequest( - parsed_name=[ - models.AiNameComponent( - value='John', - category='FirstName', - score=0.95), - models.AiNameComponent( - value='Cane', - category='LastName', - score=0.5, - position=5), - models.AiNameComponent( - value='%F%L', - category='Format'), - models.AiNameComponent( - value='0.5', - category='Score', - score=0.5)]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameWeighted.md b/sdk/docs/AiNameWeighted.md deleted file mode 100644 index 5c3a1bb..0000000 --- a/sdk/docs/AiNameWeighted.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameWeighted - -Name with score - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Name |[optional] -**score** |**float** |Score of name | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AiNameWeightedVariants.md b/sdk/docs/AiNameWeightedVariants.md deleted file mode 100644 index 5e328b5..0000000 --- a/sdk/docs/AiNameWeightedVariants.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.AiNameWeightedVariants - -Name variants - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**names** |[**list[AiNameWeighted]**](AiNameWeighted.md) |List of name variations |[optional] -**comments** |**str** |Usually empty; can contain extra message describing some issue occurred during processing |[optional] - - - -## Example -```python -ai_name_weighted_variants = models.AiNameWeightedVariants( - names=[ - models.AiNameWeighted( - name='J. Cane', - score=1), - models.AiNameWeighted( - name='Mr. Cane', - score=0.75)]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AlternateView.md b/sdk/docs/AlternateView.md deleted file mode 100644 index 0e1cb2d..0000000 --- a/sdk/docs/AlternateView.md +++ /dev/null @@ -1,37 +0,0 @@ -# AsposeEmailCloudSdk.models.AlternateView - -Represents the format to view a message. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**base_uri** |**str** |Base URI. |[optional] -**linked_resources** |[**list[LinkedResource]**](LinkedResource.md) |Embedded resources referred to by this alternate view. |[optional] - -Parent class: [AttachmentBase](AttachmentBase.md) - - -## Example -```python -alternate_view = models.AlternateView( - base64_data='', - content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', - content_type=models.ContentType( - char_set='utf-8', - media_type='text/calendar', - name='meeting.ics', - parameters=[ - models.ContentTypeParameter( - name='Method', - value='REQUEST'), - models.ContentTypeParameter( - name='Name', - value='meeting.ics'), - models.ContentTypeParameter( - name='charset', - value='utf-8')])) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AssociatedPerson.md b/sdk/docs/AssociatedPerson.md deleted file mode 100644 index 6015d15..0000000 --- a/sdk/docs/AssociatedPerson.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.AssociatedPerson - -Describes associated person. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Associated person's name. |[optional] -**category** |[**EnumWithCustomOfAssociatedPersonCategory**](EnumWithCustomOfAssociatedPersonCategory.md) |Associated person's category. |[optional] -**preferred** |**bool** |Defines whether associated person is preferred. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/Attachment.md b/sdk/docs/Attachment.md deleted file mode 100644 index 2434a03..0000000 --- a/sdk/docs/Attachment.md +++ /dev/null @@ -1,19 +0,0 @@ -# AsposeEmailCloudSdk.models.Attachment - -Document attachment. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content_disposition** |**str** |Content-Disposition header. Read only. |[optional] -**is_embedded_message** |**bool** |Determines if attachment is an embedded message. Read only. | -**name** |**str** |Attachment name. |[optional] -**name_encoding** |**str** |Encoding of attachment name. |[optional] -**preferred_text_encoding** |**str** |Preferred text encoding. |[optional] - -Parent class: [AttachmentBase](AttachmentBase.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/AttachmentBase.md b/sdk/docs/AttachmentBase.md deleted file mode 100644 index e91443d..0000000 --- a/sdk/docs/AttachmentBase.md +++ /dev/null @@ -1,17 +0,0 @@ -# AsposeEmailCloudSdk.models.AttachmentBase - -AttachmentBase class - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**base64_data** |**str** |Attachment file content as Base64 string. |[optional] -**content_id** |**str** |Attachment content id |[optional] -**content_type** |[**ContentType**](ContentType.md) |Content type |[optional] -**headers** |**dict(str, str)** |Attachment headers. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarApi.md b/sdk/docs/CalendarApi.md deleted file mode 100644 index 76d6109..0000000 --- a/sdk/docs/CalendarApi.md +++ /dev/null @@ -1,999 +0,0 @@ -# AsposeEmailCloudSdk.CalendarApi (EmailCloud.calendar) - -iCalendar document operations. - - -## as_alternate - -Description: Convert iCalendar to AlternateView - -Returns: iCalendar document represented as AlternateView - -Method call example: -```python -result = api.calendar.as_alternate(request) -``` - -### Parameter: request - -Description: iCalendar to AlternateView request - -See parameter model documentation at [CalendarAsAlternateRequest](CalendarAsAlternateRequest.md) - -
- Parameter initialization example: - -```python -request = models.CalendarAsAlternateRequest( - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary'), - sequence_id='cf4ffb6c-895d-4e58-bdb4-0a3918e96a43') -``` - -
- -### Result - -Description: iCalendar document represented as AlternateView - -Return type: [**AlternateView**](AlternateView.md) - -
- Result example - -```python -result = models.AlternateView( - base64_data='', - content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', - content_type=models.ContentType( - char_set='utf-8', - media_type='text/calendar', - name='meeting.ics', - parameters=[ - models.ContentTypeParameter( - name='Method', - value='REQUEST'), - models.ContentTypeParameter( - name='Name', - value='meeting.ics'), - models.ContentTypeParameter( - name='charset', - value='utf-8')])) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarAsAlternateRequest( - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary'), - sequence_id='cf4ffb6c-895d-4e58-bdb4-0a3918e96a43') - -// Call method: -result = api.calendar.as_alternate(request) - -// Result example: -result = models.AlternateView( - base64_data='', - content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', - content_type=models.ContentType( - char_set='utf-8', - media_type='text/calendar', - name='meeting.ics', - parameters=[ - models.ContentTypeParameter( - name='Method', - value='REQUEST'), - models.ContentTypeParameter( - name='Name', - value='meeting.ics'), - models.ContentTypeParameter( - name='charset', - value='utf-8')])) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_file - -Description: Converts calendar model to specified format and returns as file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.calendar.as_file(request) -``` - -### Parameter: request - -Description: Calendar model and format to convert. - -See parameter model documentation at [CalendarAsFileRequest](CalendarAsFileRequest.md) - -
- Parameter initialization example: - -```python -request = models.CalendarAsFileRequest( - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary')) -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarAsFileRequest( - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary')) - -// Call method: -result = api.calendar.as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_mapi - -Description: Converts CalendarDto to MapiCalendarDto. - -Returns: MAPI model calendar representation. - -Method call example: -```python -result = api.calendar.as_mapi(calendar_dto) -``` - -### Parameter: calendar_dto - -Description: iCalendar model calendar representation. - -See parameter model documentation at [CalendarDto](CalendarDto.md) - -
- Parameter initialization example: - -```python -calendar_dto = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` - -
- -### Result - -Description: MAPI model calendar representation. - -Return type: [**MapiCalendarDto**](MapiCalendarDto.md) - -
- Result example - -```python -result = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -calendar_dto = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') - -// Call method: -result = api.calendar.as_mapi(calendar_dto) - -// Result example: -result = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## convert - -Description: Converts calendar document to specified format and returns as file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.calendar.convert(request) -``` - -### Parameter: request - -Description: convert method request. - -See parameter model documentation at [CalendarConvertRequest](CalendarConvertRequest.md). - -
- Parameter initialization example: - -```python -request = models.CalendarConvertRequest( - format='Ics', - file='/path/to/calendar.msg') -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarConvertRequest( - format='Ics', - file='/path/to/calendar.msg') - -// Call method: -result = api.calendar.convert(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## from_file - -Description: Converts calendar document to a model representation. - -Returns: iCalendar model. - -Method call example: -```python -result = api.calendar.from_file(request) -``` - -### Parameter: request - -Description: from_file method request. - -See parameter model documentation at [CalendarFromFileRequest](CalendarFromFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.CalendarFromFileRequest( - file='/path/to/calendar.ics') -``` - -
- -### Result - -Description: iCalendar model. - -Return type: [**CalendarDto**](CalendarDto.md) - -
- Result example - -```python -result = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarFromFileRequest( - file='/path/to/calendar.ics') - -// Call method: -result = api.calendar.from_file(request) - -// Result example: -result = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get - -Description: Get calendar file from storage. - -Returns: iCalendar model. - -Method call example: -```python -result = api.calendar.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [CalendarGetRequest](CalendarGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.CalendarGetRequest( - file_name='calendar.ics', - folder='calendar/location/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: iCalendar model. - -Return type: [**CalendarDto**](CalendarDto.md) - -
- Result example - -```python -result = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarGetRequest( - file_name='calendar.ics', - folder='calendar/location/on/storage', - storage='First Storage') - -// Call method: -result = api.calendar.get(request) - -// Result example: -result = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_as_alternate - -Description: Get iCalendar from storage as AlternateView - -Returns: iCalendar document represented as AlternateView - -Method call example: -```python -result = api.calendar.get_as_alternate(request) -``` - -### Parameter: request - -Description: get_as_alternate method request. - -See parameter model documentation at [CalendarGetAsAlternateRequest](CalendarGetAsAlternateRequest.md). - -
- Parameter initialization example: - -```python -request = models.CalendarGetAsAlternateRequest( - file_name='calendar.ics', - calendar_action='Create', - folder='calendar/location/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: iCalendar document represented as AlternateView - -Return type: [**AlternateView**](AlternateView.md) - -
- Result example - -```python -result = models.AlternateView( - base64_data='', - content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', - content_type=models.ContentType( - char_set='utf-8', - media_type='text/calendar', - name='meeting.ics', - parameters=[ - models.ContentTypeParameter( - name='Method', - value='REQUEST'), - models.ContentTypeParameter( - name='Name', - value='meeting.ics'), - models.ContentTypeParameter( - name='charset', - value='utf-8')])) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarGetAsAlternateRequest( - file_name='calendar.ics', - calendar_action='Create', - folder='calendar/location/on/storage', - storage='First Storage') - -// Call method: -result = api.calendar.get_as_alternate(request) - -// Result example: -result = models.AlternateView( - base64_data='', - content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', - content_type=models.ContentType( - char_set='utf-8', - media_type='text/calendar', - name='meeting.ics', - parameters=[ - models.ContentTypeParameter( - name='Method', - value='REQUEST'), - models.ContentTypeParameter( - name='Name', - value='meeting.ics'), - models.ContentTypeParameter( - name='charset', - value='utf-8')])) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_as_file - -Description: Converts calendar document from storage to specified format and returns as file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.calendar.get_as_file(request) -``` - -### Parameter: request - -Description: get_as_file method request. - -See parameter model documentation at [CalendarGetAsFileRequest](CalendarGetAsFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.CalendarGetAsFileRequest( - file_name='calendar.msg', - format='Ics', - storage='First Storage', - folder='calendar/file/location/on/storage') -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarGetAsFileRequest( - file_name='calendar.msg', - format='Ics', - storage='First Storage', - folder='calendar/file/location/on/storage') - -// Call method: -result = api.calendar.get_as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_list - -Description: Get iCalendar list from storage folder. - -Returns: iCalendar document list. - -Method call example: -```python -result = api.calendar.get_list(request) -``` - -### Parameter: request - -Description: get_list method request. - -See parameter model documentation at [CalendarGetListRequest](CalendarGetListRequest.md). - -
- Parameter initialization example: - -```python -request = models.CalendarGetListRequest( - folder='some/folder/on/storage', - items_per_page=10, - page_number=0, - storage='First Storage') -``` - -
- -### Result - -Description: iCalendar document list. - -Return type: [**CalendarStorageList**](CalendarStorageList.md) - -
- Result example - -```python -result = models.CalendarStorageList( - value=[ - models.StorageModelOfCalendarDto( - storage_file=models.StorageFileLocation( - file_name='calendar.ics', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary'))]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarGetListRequest( - folder='some/folder/on/storage', - items_per_page=10, - page_number=0, - storage='First Storage') - -// Call method: -result = api.calendar.get_list(request) - -// Result example: -result = models.CalendarStorageList( - value=[ - models.StorageModelOfCalendarDto( - storage_file=models.StorageFileLocation( - file_name='calendar.ics', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary'))]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Save iCalendar - -Method call example: -```python -api.calendar.save(request) -``` - -### Parameter: request - -Description: iCalendar create/update request - -See parameter model documentation at [CalendarSaveRequest](CalendarSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.CalendarSaveRequest( - storage_file=models.StorageFileLocation( - file_name='calendar.ics', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CalendarSaveRequest( - storage_file=models.StorageFileLocation( - file_name='calendar.ics', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary')) - -// Call method: -api.calendar.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarApi_list.md b/sdk/docs/CalendarApi_list.md deleted file mode 100644 index 8d4d95e..0000000 --- a/sdk/docs/CalendarApi_list.md +++ /dev/null @@ -1,16 +0,0 @@ -## Documentation for CalendarApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**as_alternate**](CalendarApi.md#as_alternate)| **PUT** /email/Calendar/as-alternate| Convert iCalendar to AlternateView -[**as_file**](CalendarApi.md#as_file)| **PUT** /email/Calendar/as-file| Converts calendar model to specified format and returns as file. -[**as_mapi**](CalendarApi.md#as_mapi)| **PUT** /email/Calendar/as-mapi| Converts CalendarDto to MapiCalendarDto. -[**convert**](CalendarApi.md#convert)| **PUT** /email/Calendar/convert| Converts calendar document to specified format and returns as file. -[**from_file**](CalendarApi.md#from_file)| **PUT** /email/Calendar/from-file| Converts calendar document to a model representation. -[**get**](CalendarApi.md#get)| **GET** /email/Calendar| Get calendar file from storage. -[**get_as_alternate**](CalendarApi.md#get_as_alternate)| **GET** /email/Calendar/as-alternate| Get iCalendar from storage as AlternateView -[**get_as_file**](CalendarApi.md#get_as_file)| **GET** /email/Calendar/as-file| Converts calendar document from storage to specified format and returns as file. -[**get_list**](CalendarApi.md#get_list)| **GET** /email/Calendar/list| Get iCalendar list from storage folder. -[**save**](CalendarApi.md#save)| **PUT** /email/Calendar| Save iCalendar diff --git a/sdk/docs/CalendarAsAlternateRequest.md b/sdk/docs/CalendarAsAlternateRequest.md deleted file mode 100644 index 50922c3..0000000 --- a/sdk/docs/CalendarAsAlternateRequest.md +++ /dev/null @@ -1,40 +0,0 @@ -# AsposeEmailCloudSdk.models.CalendarAsAlternateRequest - -Convert iCalendar to AlternateView request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**CalendarDto**](CalendarDto.md) |iCalendar document model | -**action** |**str** |iCalendar actions. Enum, available values: Create, Update, Cancel | -**sequence_id** |**str** |iCalendar sequence id |[optional] - - - -## Example -```python -calendar_as_alternate_request = models.CalendarAsAlternateRequest( - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary'), - sequence_id='cf4ffb6c-895d-4e58-bdb4-0a3918e96a43') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarAsFileRequest.md b/sdk/docs/CalendarAsFileRequest.md deleted file mode 100644 index 5e304b2..0000000 --- a/sdk/docs/CalendarAsFileRequest.md +++ /dev/null @@ -1,38 +0,0 @@ -# AsposeEmailCloudSdk.models.CalendarAsFileRequest - -iCalendar model to file request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Calendar file format Enum, available values: Ics, Msg | -**value** |[**CalendarDto**](CalendarDto.md) |iCalendar model | - - - -## Example -```python -calendar_as_file_request = models.CalendarAsFileRequest( - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarConvertRequest.md b/sdk/docs/CalendarConvertRequest.md deleted file mode 100644 index 84f342f..0000000 --- a/sdk/docs/CalendarConvertRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# CalendarConvertRequest - -Request model for CalendarApi.convert - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |File format. Enum, available values: Ics, Msg | -**file** |**str** |File to convert | - -## Example -```python -request = models.CalendarConvertRequest( - format='Ics', - file='/path/to/calendar.msg') -``` diff --git a/sdk/docs/CalendarDto.md b/sdk/docs/CalendarDto.md deleted file mode 100644 index 9a8d9ce..0000000 --- a/sdk/docs/CalendarDto.md +++ /dev/null @@ -1,57 +0,0 @@ -# AsposeEmailCloudSdk.models.CalendarDto - -iCalendar document representation. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachments** |[**list[Attachment]**](Attachment.md) |Document attachments. |[optional] -**attendees** |[**list[MailAddress]**](MailAddress.md) |Event attendees. | -**description** |**str** |Description. |[optional] -**end_date** |**datetime** |End date. | -**end_time_zone** |**str** |End time zone. |[optional] -**flags** |**list[str]** |Appointment flags. Items: Enumerates iCalendar flags. Enum, available values: None, AllDayEvent |[optional] -**is_description_html** |**bool** |Indicates if description is in HTML format. | -**location** |**str** |Location. | -**method** |**str** |Defines the iCalendar object method type associated with the calendar document. Enum, available values: None, Publish, Request, Reply, Add, Cancel, Refresh, Counter, DeclineCounter | -**microsoft_busy_status** |**str** |Specifies the BUSY status. Enum, available values: NotDefined, Free, Tentative, Busy, Oof | -**microsoft_intended_status** |**str** |Specifies the INTENDED status. Enum, available values: NotDefined, Free, Tentative, Busy, Oof | -**optional_attendees** |[**list[MailAddress]**](MailAddress.md) |Optional attendees. |[optional] -**organizer** |[**MailAddress**](MailAddress.md) |Event organizer. | -**recurrence_string** |**str** |Deprecated, use 'Recurrence' property. String representation of recurrence pattern (See iCalendar RFC, \"Recurrence rule\" section). For example: For daily recurrence: \"FREQ=DAILY;COUNT=10;WKST=MO\" For monthly recurrence: \"BYSETPOS=1;BYDAY=MO,TU,WE,TH,FR;FREQ=MONTHLY;INTERVAL=10;WKST=MO\" For yearly recurrence: \"BYMONTHDAY=30;BYMONTH=1;FREQ=YEARLY;WKST=MO\" |[optional] -**recurrence** |[**RecurrencePatternDto**](RecurrencePatternDto.md) |Recurrence pattern |[optional] -**reminders** |[**list[CalendarReminder]**](CalendarReminder.md) |Reminders. |[optional] -**sequence_id** |**str** |The sequence id. Read only. |[optional] -**start_date** |**datetime** |Start date. | -**start_time_zone** |**str** |Start time zone. |[optional] -**status** |**str** |Defines the overall status or confirmation for the calendar document. Enum, available values: NotDefined, Cancelled, Tentative, Confirmed | -**summary** |**str** |Summary. |[optional] -**transparency** |**str** |Specifies whether or not this appointment is intended to be visible in availability searches. Enum, available values: NotDefined, Transparent, Opaque | - - - -## Example -```python -calendar_dto = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarFromFileRequest.md b/sdk/docs/CalendarFromFileRequest.md deleted file mode 100644 index a8a30f6..0000000 --- a/sdk/docs/CalendarFromFileRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# CalendarFromFileRequest - -Request model for CalendarApi.from_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file** |**str** |File to convert | - -## Example -```python -request = models.CalendarFromFileRequest( - file='/path/to/calendar.ics') -``` diff --git a/sdk/docs/CalendarGetAsAlternateRequest.md b/sdk/docs/CalendarGetAsAlternateRequest.md deleted file mode 100644 index 56d6827..0000000 --- a/sdk/docs/CalendarGetAsAlternateRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# CalendarGetAsAlternateRequest - -Request model for CalendarApi.get_as_alternate - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |iCalendar file name in storage | -**calendar_action** |**str** |iCalendar method type Enum, available values: Create, Update, Cancel | -**sequence_id** |**str** |The sequence id |[optional] -**folder** |**str** |Path to folder in storage |[optional] -**storage** |**str** |Storage name |[optional] - -## Example -```python -request = models.CalendarGetAsAlternateRequest( - file_name='calendar.ics', - calendar_action='Create', - folder='calendar/location/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/CalendarGetAsFileRequest.md b/sdk/docs/CalendarGetAsFileRequest.md deleted file mode 100644 index 1c3c72c..0000000 --- a/sdk/docs/CalendarGetAsFileRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# CalendarGetAsFileRequest - -Request model for CalendarApi.get_as_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |Calendar document file name. | -**format** |**str** |File format. Enum, available values: Ics, Msg | -**storage** |**str** |Storage name. |[optional] -**folder** |**str** |Path to folder in storage. |[optional] - -## Example -```python -request = models.CalendarGetAsFileRequest( - file_name='calendar.msg', - format='Ics', - storage='First Storage', - folder='calendar/file/location/on/storage') -``` diff --git a/sdk/docs/CalendarGetListRequest.md b/sdk/docs/CalendarGetListRequest.md deleted file mode 100644 index a8e07e9..0000000 --- a/sdk/docs/CalendarGetListRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# CalendarGetListRequest - -Request model for CalendarApi.get_list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**folder** |**str** |Path to folder in storage. | -**items_per_page** |**int** |Count of items on page. |[optional] [default to 10] -**page_number** |**int** |Page number. |[optional] [default to 0] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.CalendarGetListRequest( - folder='some/folder/on/storage', - items_per_page=10, - page_number=0, - storage='First Storage') -``` diff --git a/sdk/docs/CalendarGetRequest.md b/sdk/docs/CalendarGetRequest.md deleted file mode 100644 index c024386..0000000 --- a/sdk/docs/CalendarGetRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# CalendarGetRequest - -Request model for CalendarApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |iCalendar file name in storage. | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.CalendarGetRequest( - file_name='calendar.ics', - folder='calendar/location/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/CalendarReminder.md b/sdk/docs/CalendarReminder.md deleted file mode 100644 index e3e2d00..0000000 --- a/sdk/docs/CalendarReminder.md +++ /dev/null @@ -1,21 +0,0 @@ -# AsposeEmailCloudSdk.models.CalendarReminder - -Provides a grouping of component properties that define an alarm. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**action** |**str** |Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None | -**attachments** |**list[str]** |Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content |[optional] -**attendees** |[**list[ReminderAttendee]**](ReminderAttendee.md) |Contains collection of ReminderAttendee objects. |[optional] -**description** |**str** |Provides a more complete description of the alarm. |[optional] -**duration** |**int** |Specifies the delay period in ticks, after which the alarm will repeat. |[optional] -**repeat** |**int** |Defines the number of time the alarm should be repeated, after the initial trigger. | -**summary** |**str** |Defines a short summary or subject for the alarm. |[optional] -**trigger** |[**ReminderTrigger**](ReminderTrigger.md) |Specifies when an alarm will trigger. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarSaveRequest.md b/sdk/docs/CalendarSaveRequest.md deleted file mode 100644 index 81b56ff..0000000 --- a/sdk/docs/CalendarSaveRequest.md +++ /dev/null @@ -1,42 +0,0 @@ -# AsposeEmailCloudSdk.models.CalendarSaveRequest - -Save iCalendar to storage request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Calendar file format Enum, available values: Ics, Msg | - -Parent class: [StorageModelOfCalendarDto](StorageModelOfCalendarDto.md) - - -## Example -```python -calendar_save_request = models.CalendarSaveRequest( - storage_file=models.StorageFileLocation( - file_name='calendar.ics', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CalendarStorageList.md b/sdk/docs/CalendarStorageList.md deleted file mode 100644 index 02b2cfa..0000000 --- a/sdk/docs/CalendarStorageList.md +++ /dev/null @@ -1,43 +0,0 @@ -# AsposeEmailCloudSdk.models.CalendarStorageList - -iCalendar models list with corresponding storage locations. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfStorageModelOfCalendarDto](ListResponseOfStorageModelOfCalendarDto.md) - - -## Example -```python -calendar_storage_list = models.CalendarStorageList( - value=[ - models.StorageModelOfCalendarDto( - storage_file=models.StorageFileLocation( - file_name='calendar.ics', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary'))]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientAccountApi.md b/sdk/docs/ClientAccountApi.md deleted file mode 100644 index 981169f..0000000 --- a/sdk/docs/ClientAccountApi.md +++ /dev/null @@ -1,407 +0,0 @@ -# AsposeEmailCloudSdk.ClientAccountApi (EmailCloud.client.account) - -Email server account for built-in client operations. - - -## get - -Description: Get email client account from storage. - -Returns: Email client account from storage. - -Method call example: -```python -result = api.client.account.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [ClientAccountGetRequest](ClientAccountGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientAccountGetRequest( - file_name='email.account', - folder='email/account/location/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: Email client account from storage. - -Return type: [**EmailClientAccount**](EmailClientAccount.md) - -
- Result example - -```python -result = models.EmailClientAccount( - host='smtp.example.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@example.com'), - cache_file=models.StorageFileLocation( - file_name='account.cache', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientAccountGetRequest( - file_name='email.account', - folder='email/account/location/on/storage', - storage='First Storage') - -// Call method: -result = api.client.account.get(request) - -// Result example: -result = models.EmailClientAccount( - host='smtp.example.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@example.com'), - cache_file=models.StorageFileLocation( - file_name='account.cache', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_multi - -Description: Get email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". - -Returns: Email client multi account from storage - -Method call example: -```python -result = api.client.account.get_multi(request) -``` - -### Parameter: request - -Description: get_multi method request. - -See parameter model documentation at [ClientAccountGetMultiRequest](ClientAccountGetMultiRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientAccountGetMultiRequest( - file_name='email.multi.account', - folder='email/account/location/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: Email client multi account from storage - -Return type: [**EmailClientMultiAccount**](EmailClientMultiAccount.md) - -
- Result example - -```python -result = models.EmailClientMultiAccount( - receive_accounts=[ - models.EmailClientAccount( - host='imap.gmail.com', - port=993, - security_options='SSLAuto', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')), - models.EmailClientAccount( - host='exchange@outlook.com', - port=443, - protocol_type='EWS', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@outlook.com'))], - send_account=models.EmailClientAccount( - host='smtp.gmail.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com'))) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientAccountGetMultiRequest( - file_name='email.multi.account', - folder='email/account/location/on/storage', - storage='First Storage') - -// Call method: -result = api.client.account.get_multi(request) - -// Result example: -result = models.EmailClientMultiAccount( - receive_accounts=[ - models.EmailClientAccount( - host='imap.gmail.com', - port=993, - security_options='SSLAuto', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')), - models.EmailClientAccount( - host='exchange@outlook.com', - port=443, - protocol_type='EWS', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@outlook.com'))], - send_account=models.EmailClientAccount( - host='smtp.gmail.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com'))) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Create/update email client account file (*.account) with credentials - -Method call example: -```python -api.client.account.save(request) -``` - -### Parameter: request - -Description: Email account information - -See parameter model documentation at [ClientAccountSaveRequest](ClientAccountSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientAccountSaveRequest( - storage_file=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailClientAccount( - host='smtp.example.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@example.com'), - cache_file=models.StorageFileLocation( - file_name='account.cache', - storage='First Storage', - folder_path='file/location/folder/on/storage'))) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientAccountSaveRequest( - storage_file=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailClientAccount( - host='smtp.example.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@example.com'), - cache_file=models.StorageFileLocation( - file_name='account.cache', - storage='First Storage', - folder_path='file/location/folder/on/storage'))) - -// Call method: -api.client.account.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save_multi - -Description: Create email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". - -Method call example: -```python -api.client.account.save_multi(request) -``` - -### Parameter: request - -Description: Email accounts information. - -See parameter model documentation at [ClientAccountSaveMultiRequest](ClientAccountSaveMultiRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientAccountSaveMultiRequest( - storage_file=models.StorageFileLocation( - file_name='email.multi.account', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailClientMultiAccount( - receive_accounts=[ - models.EmailClientAccount( - host='imap.gmail.com', - port=993, - security_options='SSLAuto', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')), - models.EmailClientAccount( - host='exchange@outlook.com', - port=443, - protocol_type='EWS', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@outlook.com'))], - send_account=models.EmailClientAccount( - host='smtp.gmail.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')))) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientAccountSaveMultiRequest( - storage_file=models.StorageFileLocation( - file_name='email.multi.account', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailClientMultiAccount( - receive_accounts=[ - models.EmailClientAccount( - host='imap.gmail.com', - port=993, - security_options='SSLAuto', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')), - models.EmailClientAccount( - host='exchange@outlook.com', - port=443, - protocol_type='EWS', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@outlook.com'))], - send_account=models.EmailClientAccount( - host='smtp.gmail.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')))) - -// Call method: -api.client.account.save_multi(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientAccountApi_list.md b/sdk/docs/ClientAccountApi_list.md deleted file mode 100644 index d979667..0000000 --- a/sdk/docs/ClientAccountApi_list.md +++ /dev/null @@ -1,10 +0,0 @@ -## Documentation for ClientAccountApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get**](ClientAccountApi.md#get)| **GET** /email/client/account| Get email client account from storage. -[**get_multi**](ClientAccountApi.md#get_multi)| **GET** /email/client/account/multi| Get email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". -[**save**](ClientAccountApi.md#save)| **PUT** /email/client/account| Create/update email client account file (*.account) with credentials -[**save_multi**](ClientAccountApi.md#save_multi)| **PUT** /email/client/account/multi| Create email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". diff --git a/sdk/docs/ClientAccountBaseRequest.md b/sdk/docs/ClientAccountBaseRequest.md deleted file mode 100644 index 983dc70..0000000 --- a/sdk/docs/ClientAccountBaseRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientAccountBaseRequest - -Base request for Email client. Stores information about email account location. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_location** |[**StorageFileLocation**](StorageFileLocation.md) |Email client account configuration location on storage. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientAccountGetMultiRequest.md b/sdk/docs/ClientAccountGetMultiRequest.md deleted file mode 100644 index 9ab5d18..0000000 --- a/sdk/docs/ClientAccountGetMultiRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# ClientAccountGetMultiRequest - -Request model for ClientAccountApi.get_multi - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |File name on storage | -**folder** |**str** |Folder on storage |[optional] -**storage** |**str** |Storage name |[optional] - -## Example -```python -request = models.ClientAccountGetMultiRequest( - file_name='email.multi.account', - folder='email/account/location/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/ClientAccountGetRequest.md b/sdk/docs/ClientAccountGetRequest.md deleted file mode 100644 index e8f539e..0000000 --- a/sdk/docs/ClientAccountGetRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# ClientAccountGetRequest - -Request model for ClientAccountApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |File name on storage. | -**folder** |**str** |Folder on storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.ClientAccountGetRequest( - file_name='email.account', - folder='email/account/location/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/ClientAccountSaveMultiRequest.md b/sdk/docs/ClientAccountSaveMultiRequest.md deleted file mode 100644 index 594fe87..0000000 --- a/sdk/docs/ClientAccountSaveMultiRequest.md +++ /dev/null @@ -1,49 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientAccountSaveMultiRequest - -Email client multi account save request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [StorageModelOfEmailClientMultiAccount](StorageModelOfEmailClientMultiAccount.md) - - -## Example -```python -client_account_save_multi_request = models.ClientAccountSaveMultiRequest( - storage_file=models.StorageFileLocation( - file_name='email.multi.account', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailClientMultiAccount( - receive_accounts=[ - models.EmailClientAccount( - host='imap.gmail.com', - port=993, - security_options='SSLAuto', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')), - models.EmailClientAccount( - host='exchange@outlook.com', - port=443, - protocol_type='EWS', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@outlook.com'))], - send_account=models.EmailClientAccount( - host='smtp.gmail.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')))) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientAccountSaveRequest.md b/sdk/docs/ClientAccountSaveRequest.md deleted file mode 100644 index 52880b8..0000000 --- a/sdk/docs/ClientAccountSaveRequest.md +++ /dev/null @@ -1,37 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientAccountSaveRequest - -Email client account save request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [StorageModelOfEmailClientAccount](StorageModelOfEmailClientAccount.md) - - -## Example -```python -client_account_save_request = models.ClientAccountSaveRequest( - storage_file=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailClientAccount( - host='smtp.example.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@example.com'), - cache_file=models.StorageFileLocation( - file_name='account.cache', - storage='First Storage', - folder_path='file/location/folder/on/storage'))) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientFolderApi.md b/sdk/docs/ClientFolderApi.md deleted file mode 100644 index 591ddcd..0000000 --- a/sdk/docs/ClientFolderApi.md +++ /dev/null @@ -1,191 +0,0 @@ -# AsposeEmailCloudSdk.ClientFolderApi (EmailCloud.client.folder) - -Email client folder operations. - - -## create - -Description: Create new folder in email account - -Method call example: -```python -api.client.folder.create(request) -``` - -### Parameter: request - -Description: Create folder request - -See parameter model documentation at [ClientFolderCreateRequest](ClientFolderCreateRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientFolderCreateRequest( - parent_folder='INBOX/SubFolder/ParentFolder', - folder_name='NewFolder', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientFolderCreateRequest( - parent_folder='INBOX/SubFolder/ParentFolder', - folder_name='NewFolder', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.folder.create(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## delete - -Description: Delete a folder in email account - -Method call example: -```python -api.client.folder.delete(request) -``` - -### Parameter: request - -Description: Delete folder request - -See parameter model documentation at [ClientFolderDeleteRequest](ClientFolderDeleteRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientFolderDeleteRequest( - folder='INBOX/SubFolder/FolderToDelete', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientFolderDeleteRequest( - folder='INBOX/SubFolder/FolderToDelete', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.folder.delete(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_list - -Description: Get folders list in email account - -Returns: Folders list - -Method call example: -```python -result = api.client.folder.get_list(request) -``` - -### Parameter: request - -Description: get_list method request. - -See parameter model documentation at [ClientFolderGetListRequest](ClientFolderGetListRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientFolderGetListRequest( - account='email.multi.account', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - parent_folder='INBOX') -``` - -
- -### Result - -Description: Folders list - -Return type: [**MailServerFolderList**](MailServerFolderList.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientFolderGetListRequest( - account='email.multi.account', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - parent_folder='INBOX') - -// Call method: -result = api.client.folder.get_list(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientFolderApi_list.md b/sdk/docs/ClientFolderApi_list.md deleted file mode 100644 index 9998c8b..0000000 --- a/sdk/docs/ClientFolderApi_list.md +++ /dev/null @@ -1,9 +0,0 @@ -## Documentation for ClientFolderApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create**](ClientFolderApi.md#create)| **PUT** /email/client/folder| Create new folder in email account -[**delete**](ClientFolderApi.md#delete)| **DELETE** /email/client/folder| Delete a folder in email account -[**get_list**](ClientFolderApi.md#get_list)| **GET** /email/client/folder/list| Get folders list in email account diff --git a/sdk/docs/ClientFolderCreateRequest.md b/sdk/docs/ClientFolderCreateRequest.md deleted file mode 100644 index 2e54776..0000000 --- a/sdk/docs/ClientFolderCreateRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientFolderCreateRequest - -Email Client create folder request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parent_folder** |**str** |Path to parent folder. |[optional] -**folder_name** |**str** |Folder name. | - -Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - -## Example -```python -client_folder_create_request = models.ClientFolderCreateRequest( - parent_folder='INBOX/SubFolder/ParentFolder', - folder_name='NewFolder', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientFolderDeleteRequest.md b/sdk/docs/ClientFolderDeleteRequest.md deleted file mode 100644 index eb59b54..0000000 --- a/sdk/docs/ClientFolderDeleteRequest.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientFolderDeleteRequest - -Email client delete folder request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**folder** |**str** |Path to folder to delete. | - -Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - -## Example -```python -client_folder_delete_request = models.ClientFolderDeleteRequest( - folder='INBOX/SubFolder/FolderToDelete', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientFolderGetListRequest.md b/sdk/docs/ClientFolderGetListRequest.md deleted file mode 100644 index 9a79bba..0000000 --- a/sdk/docs/ClientFolderGetListRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# ClientFolderGetListRequest - -Request model for ClientFolderApi.get_list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**account** |**str** |Email account | -**storage** |**str** |Storage name where account file located |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located |[optional] -**parent_folder** |**str** |Folder in which subfolders should be listed |[optional] - -## Example -```python -request = models.ClientFolderGetListRequest( - account='email.multi.account', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - parent_folder='INBOX') -``` diff --git a/sdk/docs/ClientGroup.md b/sdk/docs/ClientGroup.md deleted file mode 100644 index 31b93be..0000000 --- a/sdk/docs/ClientGroup.md +++ /dev/null @@ -1,9 +0,0 @@ -# EmailCloud.Client -Builtin Email client operations. - -API | Description ---- | ----------- -[EmailCloud.client.**account**](ClientAccountApi_list.md) | Email server account for built-in client operations. -[EmailCloud.client.**folder**](ClientFolderApi_list.md) | Email client folder operations. -[EmailCloud.client.**message**](ClientMessageApi_list.md) | Email client message operations. -[EmailCloud.client.**thread**](ClientThreadApi_list.md) | Email client thread operations. diff --git a/sdk/docs/ClientMessageApi.md b/sdk/docs/ClientMessageApi.md deleted file mode 100644 index 2a705c3..0000000 --- a/sdk/docs/ClientMessageApi.md +++ /dev/null @@ -1,753 +0,0 @@ -# AsposeEmailCloudSdk.ClientMessageApi (EmailCloud.client.message) - -Email client message operations. - - -## append - -Description: Add email message to specified folder in email account. - -Returns: Message id. - -Method call example: -```python -result = api.client.message.append(request) -``` - -### Parameter: request - -Description: Append email request. - -See parameter model documentation at [ClientMessageAppendRequest](ClientMessageAppendRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientMessageAppendRequest( - folder='INBOX/SubFolder', - message=models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])), - mark_as_sent=True, - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Description: Message id. - -Return type: [**ValueTOfString**](ValueTOfString.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageAppendRequest( - folder='INBOX/SubFolder', - message=models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])), - mark_as_sent=True, - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -result = api.client.message.append(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## append_file - -Description: Add email message from file to specified folder in email account. - -Returns: Message id. - -Method call example: -```python -result = api.client.message.append_file(request) -``` - -### Parameter: request - -Description: append_file method request. - -See parameter model documentation at [ClientMessageAppendFileRequest](ClientMessageAppendFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientMessageAppendFileRequest( - account='email.multi.account', - file='/path/to/message.eml', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml', - folder='INBOX') -``` - -
- -### Result - -Description: Message id. - -Return type: [**ValueTOfString**](ValueTOfString.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageAppendFileRequest( - account='email.multi.account', - file='/path/to/message.eml', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml', - folder='INBOX') - -// Call method: -result = api.client.message.append_file(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## delete - -Description: Delete message. - -Method call example: -```python -api.client.message.delete(request) -``` - -### Parameter: request - -Description: Delete message request. - -See parameter model documentation at [ClientMessageDeleteRequest](ClientMessageDeleteRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientMessageDeleteRequest( - folder='INBOX', - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageDeleteRequest( - folder='INBOX', - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.message.delete(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## fetch - -Description: Fetch message from email account - -Returns: MailMessageBase object that represents fetched message in requested format. - -Method call example: -```python -result = api.client.message.fetch(request) -``` - -### Parameter: request - -Description: fetch method request. - -See parameter model documentation at [ClientMessageFetchRequest](ClientMessageFetchRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientMessageFetchRequest( - message_id='', - account='email.multi.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - type='Dto', - format='Eml') -``` - -
- -### Result - -Description: MailMessageBase object that represents fetched message in requested format. - -Return type: [**MailMessageBase**](MailMessageBase.md) - -
- Result example - -```python -result = models.MailMessageBase( - ) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageFetchRequest( - message_id='', - account='email.multi.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - type='Dto', - format='Eml') - -// Call method: -result = api.client.message.fetch(request) - -// Result example: -result = models.MailMessageBase( - ) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## fetch_file - -Description: Fetch message as file from email account - -Returns: Email message file in requested format. - -Method call example: -```python -result = api.client.message.fetch_file(request) -``` - -### Parameter: request - -Description: fetch_file method request. - -See parameter model documentation at [ClientMessageFetchFileRequest](ClientMessageFetchFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientMessageFetchFileRequest( - message_id='', - account='email.multi.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml') -``` - -
- -### Result - -Description: Email message file in requested format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageFetchFileRequest( - message_id='', - account='email.multi.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml') - -// Call method: -result = api.client.message.fetch_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## list - -Description: Get messages from folder, filtered by query - -The query string should have the following view. The example of a simple expression: '' '', where <Field Name> - the name of a message field through which filtering is made, <Comparison operator> - comparison operators, as their name implies, allow to compare message field and specified value, <Field value> - value to be compared with a message field. The number of simple expressions can make a compound one, ex.: ( & ) | , where \"&\" - logical-AND operator, \"|\" - logical-OR operator At present the following values are allowed as a field name (): \"To\" - represents a TO field of message, \"Text\" - represents string in the header or body of the message, \"Bcc\" - represents a BCC field of message, \"Body\" - represents a string in the body of message, \"Cc\" - represents a CC field of message, \"From\" - represents a From field of message, \"Subject\" - represents a string in the subject of message, \"InternalDate\" - represents an internal date of message, \"SentDate\" - represents a sent date of message Additionally, the following field names are allowed for IMAP-protocol: \"Answered\" - represents an /Answered flag of message \"Seen\" - represents a /Seen flag of message \"Flagged\" - represents a /Flagged flag of message \"Draft\" - represents a /Draft flag of message \"Deleted\" - represents a Deleted/ flag of message \"Recent\" - represents a Deleted/ flag of message \"MessageSize\" - represents a size (in bytes) of message Additionally, the following field names are allowed for Exchange: \"IsRead\" - Indicates whether the message has been read \"HasAttachment\" - Indicates whether or not the message has attachments \"IsSubmitted\" - Indicates whether the message has been submitted to the Outbox \"ContentClass\" - represents a content class of item The field value () can take the following values: For text fields - any string, For date type fields - the string of \"d-MMM-yyy\" format, ex. \"10-Feb-2009\", For flags (fields of boolean type) - either \"True\", or \"False\" - -Returns: List of MailMessageBase objects that represent fetched message in requested format. - -Method call example: -```python -result = api.client.message.list(request) -``` - -### Parameter: request - -Description: list method request. - -See parameter model documentation at [ClientMessageListRequest](ClientMessageListRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientMessageListRequest( - folder='INBOX', - account='email.multi.account', - query_string='('From' Contains '.com')', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - recursive=True, - type='Dto', - format='Eml') -``` - -
- -### Result - -Description: List of MailMessageBase objects that represent fetched message in requested format. - -Return type: [**MailMessageBaseList**](MailMessageBaseList.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageListRequest( - folder='INBOX', - account='email.multi.account', - query_string='('From' Contains '.com')', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - recursive=True, - type='Dto', - format='Eml') - -// Call method: -result = api.client.message.list(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## move - -Description: Move message to another folder. - -Method call example: -```python -api.client.message.move(request) -``` - -### Parameter: request - -Description: Move message request. - -See parameter model documentation at [ClientMessageMoveRequest](ClientMessageMoveRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientMessageMoveRequest( - source_folder='INBOX', - destination_folder='INBOX/SubFolder', - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageMoveRequest( - source_folder='INBOX', - destination_folder='INBOX/SubFolder', - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.message.move(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## send - -Description: Send an email specified by model in request. - -Method call example: -```python -api.client.message.send(request) -``` - -### Parameter: request - -Description: Send email request. - -See parameter model documentation at [ClientMessageSendRequest](ClientMessageSendRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientMessageSendRequest( - message=models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])), - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageSendRequest( - message=models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])), - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.message.send(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## send_file - -Description: Send an email file. - -Method call example: -```python -api.client.message.send_file(request) -``` - -### Parameter: request - -Description: send_file method request. - -See parameter model documentation at [ClientMessageSendFileRequest](ClientMessageSendFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientMessageSendFileRequest( - account='email.multi.account', - file='/path/to/message.eml', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageSendFileRequest( - account='email.multi.account', - file='/path/to/message.eml', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml') - -// Call method: -api.client.message.send_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## set_is_read - -Description: Mark message as read or unread. - -Method call example: -```python -api.client.message.set_is_read(request) -``` - -### Parameter: request - -Description: Delete message request. - -See parameter model documentation at [ClientMessageSetIsReadRequest](ClientMessageSetIsReadRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientMessageSetIsReadRequest( - is_read=True, - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientMessageSetIsReadRequest( - is_read=True, - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.message.set_is_read(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientMessageApi_list.md b/sdk/docs/ClientMessageApi_list.md deleted file mode 100644 index 480dc58..0000000 --- a/sdk/docs/ClientMessageApi_list.md +++ /dev/null @@ -1,16 +0,0 @@ -## Documentation for ClientMessageApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**append**](ClientMessageApi.md#append)| **POST** /email/client/message/append| Add email message to specified folder in email account. -[**append_file**](ClientMessageApi.md#append_file)| **POST** /email/client/message/file/append| Add email message from file to specified folder in email account. -[**delete**](ClientMessageApi.md#delete)| **DELETE** /email/client/message| Delete message. -[**fetch**](ClientMessageApi.md#fetch)| **GET** /email/client/message| Fetch message from email account -[**fetch_file**](ClientMessageApi.md#fetch_file)| **GET** /email/client/message/file| Fetch message as file from email account -[**list**](ClientMessageApi.md#list)| **GET** /email/client/message/list| Get messages from folder, filtered by query -[**move**](ClientMessageApi.md#move)| **PUT** /email/client/message/move| Move message to another folder. -[**send**](ClientMessageApi.md#send)| **POST** /email/client/message| Send an email specified by model in request. -[**send_file**](ClientMessageApi.md#send_file)| **POST** /email/client/message/file| Send an email file. -[**set_is_read**](ClientMessageApi.md#set_is_read)| **PUT** /email/client/message/set-is-read| Mark message as read or unread. diff --git a/sdk/docs/ClientMessageAppendFileRequest.md b/sdk/docs/ClientMessageAppendFileRequest.md deleted file mode 100644 index ff91037..0000000 --- a/sdk/docs/ClientMessageAppendFileRequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# ClientMessageAppendFileRequest - -Request model for ClientMessageApi.append_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**account** |**str** |Email account. | -**file** |**str** |Message file to append. | -**storage** |**str** |Storage name where account file located. |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] -**format** |**str** |Email file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] -**folder** |**str** |Path to folder on email server to append message to. |[optional] -**mark_as_sent** |**bool** |Determines that appended message should be market as sent or not. |[optional] [default to true] - -## Example -```python -request = models.ClientMessageAppendFileRequest( - account='email.multi.account', - file='/path/to/message.eml', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml', - folder='INBOX') -``` diff --git a/sdk/docs/ClientMessageAppendRequest.md b/sdk/docs/ClientMessageAppendRequest.md deleted file mode 100644 index d9b0477..0000000 --- a/sdk/docs/ClientMessageAppendRequest.md +++ /dev/null @@ -1,50 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientMessageAppendRequest - -Email client append message request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**folder** |**str** |Path to folder on email server to append message to. |[optional] -**message** |[**MailMessageBase**](MailMessageBase.md) |Message to append. | -**mark_as_sent** |**bool** |Determines that appended message should be market as sent or not. | - -Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - -## Example -```python -client_message_append_request = models.ClientMessageAppendRequest( - folder='INBOX/SubFolder', - message=models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])), - mark_as_sent=True, - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientMessageBaseRequest.md b/sdk/docs/ClientMessageBaseRequest.md deleted file mode 100644 index 1c27de2..0000000 --- a/sdk/docs/ClientMessageBaseRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientMessageBaseRequest - -Email client message request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message_id** |**str** |Message identifier. | - -Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientMessageDeleteRequest.md b/sdk/docs/ClientMessageDeleteRequest.md deleted file mode 100644 index a4be385..0000000 --- a/sdk/docs/ClientMessageDeleteRequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientMessageDeleteRequest - -Email client delete message request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**folder** |**str** |Folder to delete message from. |[optional] - -Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) - - -## Example -```python -client_message_delete_request = models.ClientMessageDeleteRequest( - folder='INBOX', - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientMessageFetchFileRequest.md b/sdk/docs/ClientMessageFetchFileRequest.md deleted file mode 100644 index 64d5208..0000000 --- a/sdk/docs/ClientMessageFetchFileRequest.md +++ /dev/null @@ -1,25 +0,0 @@ -# ClientMessageFetchFileRequest - -Request model for ClientMessageApi.fetch_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**message_id** |**str** |Message identifier | -**account** |**str** |Email account | -**folder** |**str** |Account folder to fetch from (should be specified for some protocols such as IMAP) |[optional] -**storage** |**str** |Storage name where account file located. |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] -**format** |**str** |Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] - -## Example -```python -request = models.ClientMessageFetchFileRequest( - message_id='', - account='email.multi.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml') -``` diff --git a/sdk/docs/ClientMessageFetchRequest.md b/sdk/docs/ClientMessageFetchRequest.md deleted file mode 100644 index 1056220..0000000 --- a/sdk/docs/ClientMessageFetchRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -# ClientMessageFetchRequest - -Request model for ClientMessageApi.fetch - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**message_id** |**str** |Message identifier | -**account** |**str** |Email account | -**folder** |**str** |Account folder to fetch from (should be specified for some protocols such as IMAP) |[optional] -**storage** |**str** |Storage name where account file located. |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] -**type** |**str** |MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64 |[optional] [default to 0] -**format** |**str** |Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] - -## Example -```python -request = models.ClientMessageFetchRequest( - message_id='', - account='email.multi.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - type='Dto', - format='Eml') -``` diff --git a/sdk/docs/ClientMessageListRequest.md b/sdk/docs/ClientMessageListRequest.md deleted file mode 100644 index 6586222..0000000 --- a/sdk/docs/ClientMessageListRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -# ClientMessageListRequest - -Request model for ClientMessageApi.list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**folder** |**str** |A folder in email account | -**account** |**str** |Email account | -**query_string** |**str** |A MailQuery search string |[optional] -**storage** |**str** |Storage name where account file located |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located |[optional] -**recursive** |**bool** |Specifies that should message be searched in subfolders recursively |[optional] [default to false] -**type** |**str** |MailMessageBase type. Using this property you can get messages in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64 |[optional] [default to 0] -**format** |**str** |Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] - -## Example -```python -request = models.ClientMessageListRequest( - folder='INBOX', - account='email.multi.account', - query_string='('From' Contains '.com')', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - recursive=True, - type='Dto', - format='Eml') -``` diff --git a/sdk/docs/ClientMessageMoveRequest.md b/sdk/docs/ClientMessageMoveRequest.md deleted file mode 100644 index 5f861b6..0000000 --- a/sdk/docs/ClientMessageMoveRequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientMessageMoveRequest - -Email client move message request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source_folder** |**str** |Folder to move message from. |[optional] -**destination_folder** |**str** |Folder to move message to. | - -Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) - - -## Example -```python -client_message_move_request = models.ClientMessageMoveRequest( - source_folder='INBOX', - destination_folder='INBOX/SubFolder', - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientMessageSendFileRequest.md b/sdk/docs/ClientMessageSendFileRequest.md deleted file mode 100644 index 0b105e7..0000000 --- a/sdk/docs/ClientMessageSendFileRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# ClientMessageSendFileRequest - -Request model for ClientMessageApi.send_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**account** |**str** |Email account | -**file** |**str** |File to send | -**storage** |**str** |Storage name where account file located. |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] -**format** |**str** |Email file format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] - -## Example -```python -request = models.ClientMessageSendFileRequest( - account='email.multi.account', - file='/path/to/message.eml', - storage='First Storage', - account_storage_folder='email/account/location/on/storage', - format='Eml') -``` diff --git a/sdk/docs/ClientMessageSendRequest.md b/sdk/docs/ClientMessageSendRequest.md deleted file mode 100644 index cdeb94e..0000000 --- a/sdk/docs/ClientMessageSendRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientMessageSendRequest - -Email client send message request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** |[**MailMessageBase**](MailMessageBase.md) |Message to send | - -Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - -## Example -```python -client_message_send_request = models.ClientMessageSendRequest( - message=models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])), - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientMessageSetIsReadRequest.md b/sdk/docs/ClientMessageSetIsReadRequest.md deleted file mode 100644 index 3a9ab32..0000000 --- a/sdk/docs/ClientMessageSetIsReadRequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientMessageSetIsReadRequest - -Email client mark message is read/unread request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**is_read** |**bool** |Message is read flag. | - -Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) - - -## Example -```python -client_message_set_is_read_request = models.ClientMessageSetIsReadRequest( - is_read=True, - message_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientThreadApi.md b/sdk/docs/ClientThreadApi.md deleted file mode 100644 index db7ca56..0000000 --- a/sdk/docs/ClientThreadApi.md +++ /dev/null @@ -1,374 +0,0 @@ -# AsposeEmailCloudSdk.ClientThreadApi (EmailCloud.client.thread) - -Email client thread operations. - - -## delete - -Description: Delete thread by id. All messages from thread will also be deleted. - -Method call example: -```python -api.client.thread.delete(request) -``` - -### Parameter: request - -Description: Delete email thread request. - -See parameter model documentation at [ClientThreadDeleteRequest](ClientThreadDeleteRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientThreadDeleteRequest( - folder='INBOX/SubFolder', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientThreadDeleteRequest( - folder='INBOX/SubFolder', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.thread.delete(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_list - -Description: Get message threads from folder. All messages are partly fetched (without email body and some other fields). - -Returns: List of threads - -Method call example: -```python -result = api.client.thread.get_list(request) -``` - -### Parameter: request - -Description: get_list method request. - -See parameter model documentation at [ClientThreadGetListRequest](ClientThreadGetListRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientThreadGetListRequest( - folder='INBOX/SubFolder', - account='email.account', - storage='First Storage', - account_storage_folder='email/account/location/on/storage') -``` - -
- -### Result - -Description: List of threads - -Return type: [**EmailThreadList**](EmailThreadList.md) - -
- Result example - -```python -result = models.EmailThreadList( - value=[ - models.EmailThread( - id='123', - subject='Some email subject', - messages=[ - models.EmailDto( - date=datetime.today(), - _from=models.MailAddress( - address='from@aspose.com'), - message_id='1', - subject='Some email subject', - to=[ - models.MailAddress( - address='to@aspose.com')]), - models.EmailDto( - date=datetime.today(), - _from=models.MailAddress( - address='from@aspose.com'), - message_id='3', - subject='Re: Some email subject', - to=[ - models.MailAddress( - address='to@aspose.com')])])]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientThreadGetListRequest( - folder='INBOX/SubFolder', - account='email.account', - storage='First Storage', - account_storage_folder='email/account/location/on/storage') - -// Call method: -result = api.client.thread.get_list(request) - -// Result example: -result = models.EmailThreadList( - value=[ - models.EmailThread( - id='123', - subject='Some email subject', - messages=[ - models.EmailDto( - date=datetime.today(), - _from=models.MailAddress( - address='from@aspose.com'), - message_id='1', - subject='Some email subject', - to=[ - models.MailAddress( - address='to@aspose.com')]), - models.EmailDto( - date=datetime.today(), - _from=models.MailAddress( - address='from@aspose.com'), - message_id='3', - subject='Re: Some email subject', - to=[ - models.MailAddress( - address='to@aspose.com')])])]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_messages - -Description: Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned. - -Returns: Requested thread with fully fetched messages - -Method call example: -```python -result = api.client.thread.get_messages(request) -``` - -### Parameter: request - -Description: get_messages method request. - -See parameter model documentation at [ClientThreadGetMessagesRequest](ClientThreadGetMessagesRequest.md). - -
- Parameter initialization example: - -```python -request = models.ClientThreadGetMessagesRequest( - thread_id='5', - account='email.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage') -``` - -
- -### Result - -Description: Requested thread with fully fetched messages - -Return type: [**EmailList**](EmailList.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientThreadGetMessagesRequest( - thread_id='5', - account='email.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage') - -// Call method: -result = api.client.thread.get_messages(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## move - -Description: Move thread to another folder. - -Method call example: -```python -api.client.thread.move(request) -``` - -### Parameter: request - -Description: Move thread request. - -See parameter model documentation at [ClientThreadMoveRequest](ClientThreadMoveRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientThreadMoveRequest( - destination_folder='INBOX/SubFolder', - source_folder='INBOX', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientThreadMoveRequest( - destination_folder='INBOX/SubFolder', - source_folder='INBOX', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.thread.move(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## set_is_read - -Description: Mark all messages in thread as read or unread. - -Method call example: -```python -api.client.thread.set_is_read(request) -``` - -### Parameter: request - -Description: Email account specifier and IsRead flag. - -See parameter model documentation at [ClientThreadSetIsReadRequest](ClientThreadSetIsReadRequest.md) - -
- Parameter initialization example: - -```python -request = models.ClientThreadSetIsReadRequest( - is_read=True, - folder='INBOX', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ClientThreadSetIsReadRequest( - is_read=True, - folder='INBOX', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) - -// Call method: -api.client.thread.set_is_read(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientThreadApi_list.md b/sdk/docs/ClientThreadApi_list.md deleted file mode 100644 index e01e3cb..0000000 --- a/sdk/docs/ClientThreadApi_list.md +++ /dev/null @@ -1,11 +0,0 @@ -## Documentation for ClientThreadApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete**](ClientThreadApi.md#delete)| **DELETE** /email/client/thread| Delete thread by id. All messages from thread will also be deleted. -[**get_list**](ClientThreadApi.md#get_list)| **GET** /email/client/thread/list| Get message threads from folder. All messages are partly fetched (without email body and some other fields). -[**get_messages**](ClientThreadApi.md#get_messages)| **GET** /email/client/thread/messages| Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned. -[**move**](ClientThreadApi.md#move)| **PUT** /email/client/thread/move| Move thread to another folder. -[**set_is_read**](ClientThreadApi.md#set_is_read)| **PUT** /email/client/thread/set-is-read| Mark all messages in thread as read or unread. diff --git a/sdk/docs/ClientThreadBaseRequest.md b/sdk/docs/ClientThreadBaseRequest.md deleted file mode 100644 index 947810a..0000000 --- a/sdk/docs/ClientThreadBaseRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientThreadBaseRequest - -Email client thread request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**thread_id** |**str** |Thread identifier. | - -Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientThreadDeleteRequest.md b/sdk/docs/ClientThreadDeleteRequest.md deleted file mode 100644 index b5a46d6..0000000 --- a/sdk/docs/ClientThreadDeleteRequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientThreadDeleteRequest - -Delete email client thread request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**folder** |**str** |Folder on email server, where thread is stored. |[optional] - -Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) - - -## Example -```python -client_thread_delete_request = models.ClientThreadDeleteRequest( - folder='INBOX/SubFolder', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientThreadGetListRequest.md b/sdk/docs/ClientThreadGetListRequest.md deleted file mode 100644 index 7ffa504..0000000 --- a/sdk/docs/ClientThreadGetListRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# ClientThreadGetListRequest - -Request model for ClientThreadApi.get_list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**folder** |**str** |A folder in email account. | -**account** |**str** |Email account | -**storage** |**str** |Storage name where account file located |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located |[optional] -**update_folder_cache** |**bool** |This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account |[optional] [default to true] -**messages_cache_limit** |**int** |Limit messages cache size if CacheFile is used. Ignored in accounts without limits support |[optional] [default to 200] - -## Example -```python -request = models.ClientThreadGetListRequest( - folder='INBOX/SubFolder', - account='email.account', - storage='First Storage', - account_storage_folder='email/account/location/on/storage') -``` diff --git a/sdk/docs/ClientThreadGetMessagesRequest.md b/sdk/docs/ClientThreadGetMessagesRequest.md deleted file mode 100644 index c87d0d8..0000000 --- a/sdk/docs/ClientThreadGetMessagesRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# ClientThreadGetMessagesRequest - -Request model for ClientThreadApi.get_messages - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**thread_id** |**str** |Thread identifier | -**account** |**str** |Email account | -**folder** |**str** |Specifies account folder to get thread from |[optional] -**storage** |**str** |Storage name where account file located |[optional] -**account_storage_folder** |**str** |Folder in storage where account file located |[optional] - -## Example -```python -request = models.ClientThreadGetMessagesRequest( - thread_id='5', - account='email.account', - folder='INBOX', - storage='First Storage', - account_storage_folder='email/account/location/on/storage') -``` diff --git a/sdk/docs/ClientThreadMoveRequest.md b/sdk/docs/ClientThreadMoveRequest.md deleted file mode 100644 index a48dcce..0000000 --- a/sdk/docs/ClientThreadMoveRequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientThreadMoveRequest - -Email client move thread request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**destination_folder** |**str** |Email account folder to move thread to. | -**source_folder** |**str** |Email account folder to move thread from. |[optional] - -Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) - - -## Example -```python -client_thread_move_request = models.ClientThreadMoveRequest( - destination_folder='INBOX/SubFolder', - source_folder='INBOX', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ClientThreadSetIsReadRequest.md b/sdk/docs/ClientThreadSetIsReadRequest.md deleted file mode 100644 index 46f5bd4..0000000 --- a/sdk/docs/ClientThreadSetIsReadRequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# AsposeEmailCloudSdk.models.ClientThreadSetIsReadRequest - -Mark thread messages as read or unread request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**is_read** |**bool** |Message is read flag. | -**folder** |**str** |Folder on email server, where thread is stored. |[optional] - -Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) - - -## Example -```python -client_thread_set_is_read_request = models.ClientThreadSetIsReadRequest( - is_read=True, - folder='INBOX', - thread_id='5', - account_location=models.StorageFileLocation( - file_name='email.account', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CloudStorageGroup.md b/sdk/docs/CloudStorageGroup.md deleted file mode 100644 index 5ffdedb..0000000 --- a/sdk/docs/CloudStorageGroup.md +++ /dev/null @@ -1,8 +0,0 @@ -# EmailCloud.CloudStorage -Cloud file storage operations. - -API | Description ---- | ----------- -[EmailCloud.cloud_storage.**file**](FileApi_list.md) | File operations controller -[EmailCloud.cloud_storage.**folder**](FolderApi_list.md) | Folder operations controller -[EmailCloud.cloud_storage.**storage**](StorageApi_list.md) | Storage operations controller diff --git a/sdk/docs/ContactApi.md b/sdk/docs/ContactApi.md deleted file mode 100644 index a570faa..0000000 --- a/sdk/docs/ContactApi.md +++ /dev/null @@ -1,889 +0,0 @@ -# AsposeEmailCloudSdk.ContactApi (EmailCloud.contact) - -Contact document operations. Supported formats: VCard, MSG, WebDav - - -## as_file - -Description: Converts contact model to specified format and returns as file - -Returns: File stream in specified format - -Method call example: -```python -result = api.contact.as_file(request) -``` - -### Parameter: request - -Description: Contact model and format to convert - -See parameter model documentation at [ContactAsFileRequest](ContactAsFileRequest.md) - -
- Parameter initialization example: - -```python -request = models.ContactAsFileRequest( - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])) -``` - -
- -### Result - -Description: File stream in specified format - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactAsFileRequest( - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])) - -// Call method: -result = api.contact.as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_mapi - -Description: Converts ContactDto to MapiContactDto. - -Returns: MAPI model contact representation - -Method call example: -```python -result = api.contact.as_mapi(contact_dto) -``` - -### Parameter: contact_dto - -Description: Contact model to convert - -See parameter model documentation at [ContactDto](ContactDto.md) - -
- Parameter initialization example: - -```python -contact_dto = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` - -
- -### Result - -Description: MAPI model contact representation - -Return type: [**MapiContactDto**](MapiContactDto.md) - -
- Result example - -```python -result = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -contact_dto = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) - -// Call method: -result = api.contact.as_mapi(contact_dto) - -// Result example: -result = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## convert - -Description: Converts contact document to specified format and returns as file - -Returns: File stream in specified destination format - -Method call example: -```python -result = api.contact.convert(request) -``` - -### Parameter: request - -Description: convert method request. - -See parameter model documentation at [ContactConvertRequest](ContactConvertRequest.md). - -
- Parameter initialization example: - -```python -request = models.ContactConvertRequest( - to_format='VCard', - from_format='Msg', - file='/path/to/contact.msg') -``` - -
- -### Result - -Description: File stream in specified destination format - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactConvertRequest( - to_format='VCard', - from_format='Msg', - file='/path/to/contact.msg') - -// Call method: -result = api.contact.convert(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## from_file - -Description: Converts contact document to a model representation - -Returns: Contact model - -Method call example: -```python -result = api.contact.from_file(request) -``` - -### Parameter: request - -Description: from_file method request. - -See parameter model documentation at [ContactFromFileRequest](ContactFromFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.ContactFromFileRequest( - format='Msg', - file='/path/to/contact.msg') -``` - -
- -### Result - -Description: Contact model - -Return type: [**ContactDto**](ContactDto.md) - -
- Result example - -```python -result = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactFromFileRequest( - format='Msg', - file='/path/to/contact.msg') - -// Call method: -result = api.contact.from_file(request) - -// Result example: -result = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get - -Description: Get contact document from storage. - -Returns: Contact document. - -Method call example: -```python -result = api.contact.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [ContactGetRequest](ContactGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.ContactGetRequest( - format='VCard', - file_name='contact.vcf', - folder='folder/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: Contact document. - -Return type: [**ContactDto**](ContactDto.md) - -
- Result example - -```python -result = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactGetRequest( - format='VCard', - file_name='contact.vcf', - folder='folder/on/storage', - storage='First Storage') - -// Call method: -result = api.contact.get(request) - -// Result example: -result = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_as_file - -Description: Converts contact document from storage to specified format and returns as file - -Returns: File stream in specified format - -Method call example: -```python -result = api.contact.get_as_file(request) -``` - -### Parameter: request - -Description: get_as_file method request. - -See parameter model documentation at [ContactGetAsFileRequest](ContactGetAsFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.ContactGetAsFileRequest( - file_name='contact.msg', - to_format='VCard', - from_format='Msg', - storage='First Storage', - folder='folder/on/storage') -``` - -
- -### Result - -Description: File stream in specified format - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactGetAsFileRequest( - file_name='contact.msg', - to_format='VCard', - from_format='Msg', - storage='First Storage', - folder='folder/on/storage') - -// Call method: -result = api.contact.get_as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_list - -Description: Get contact list from storage folder. - -Returns: Contact list. - -Method call example: -```python -result = api.contact.get_list(request) -``` - -### Parameter: request - -Description: get_list method request. - -See parameter model documentation at [ContactGetListRequest](ContactGetListRequest.md). - -
- Parameter initialization example: - -```python -request = models.ContactGetListRequest( - format='VCard', - folder='folder/on/storage', - storage='First Storage', - items_per_page=10, - page_number=0) -``` - -
- -### Result - -Description: Contact list. - -Return type: [**ContactStorageList**](ContactStorageList.md) - -
- Result example - -```python -result = models.ContactStorageList( - value=[ - models.StorageModelOfContactDto( - storage_file=models.StorageFileLocation( - file_name='contact.vcf', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]))]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactGetListRequest( - format='VCard', - folder='folder/on/storage', - storage='First Storage', - items_per_page=10, - page_number=0) - -// Call method: -result = api.contact.get_list(request) - -// Result example: -result = models.ContactStorageList( - value=[ - models.StorageModelOfContactDto( - storage_file=models.StorageFileLocation( - file_name='contact.vcf', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]))]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Save contact to storage. - -Method call example: -```python -api.contact.save(request) -``` - -### Parameter: request - -Description: Create/Update contact request. - -See parameter model documentation at [ContactSaveRequest](ContactSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.ContactSaveRequest( - storage_file=models.StorageFileLocation( - file_name='contact.vcf', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ContactSaveRequest( - storage_file=models.StorageFileLocation( - file_name='contact.vcf', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])) - -// Call method: -api.contact.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContactApi_list.md b/sdk/docs/ContactApi_list.md deleted file mode 100644 index a2f78d0..0000000 --- a/sdk/docs/ContactApi_list.md +++ /dev/null @@ -1,14 +0,0 @@ -## Documentation for ContactApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**as_file**](ContactApi.md#as_file)| **PUT** /email/Contact/as-file| Converts contact model to specified format and returns as file -[**as_mapi**](ContactApi.md#as_mapi)| **PUT** /email/Contact/as-mapi| Converts ContactDto to MapiContactDto. -[**convert**](ContactApi.md#convert)| **PUT** /email/Contact/convert| Converts contact document to specified format and returns as file -[**from_file**](ContactApi.md#from_file)| **PUT** /email/Contact/from-file| Converts contact document to a model representation -[**get**](ContactApi.md#get)| **GET** /email/Contact| Get contact document from storage. -[**get_as_file**](ContactApi.md#get_as_file)| **GET** /email/Contact/as-file| Converts contact document from storage to specified format and returns as file -[**get_list**](ContactApi.md#get_list)| **GET** /email/Contact/list| Get contact list from storage folder. -[**save**](ContactApi.md#save)| **PUT** /email/Contact| Save contact to storage. diff --git a/sdk/docs/ContactAsFileRequest.md b/sdk/docs/ContactAsFileRequest.md deleted file mode 100644 index eb40f27..0000000 --- a/sdk/docs/ContactAsFileRequest.md +++ /dev/null @@ -1,50 +0,0 @@ -# AsposeEmailCloudSdk.models.ContactAsFileRequest - -Convert contact model to file request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | -**value** |[**ContactDto**](ContactDto.md) |Contact model. | - - - -## Example -```python -contact_as_file_request = models.ContactAsFileRequest( - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContactConvertRequest.md b/sdk/docs/ContactConvertRequest.md deleted file mode 100644 index 821310b..0000000 --- a/sdk/docs/ContactConvertRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# ContactConvertRequest - -Request model for ContactApi.convert - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**to_format** |**str** |File format to convert to Enum, available values: VCard, WebDav, Msg | -**from_format** |**str** |File format to convert from Enum, available values: VCard, WebDav, Msg | -**file** |**str** |File to convert | - -## Example -```python -request = models.ContactConvertRequest( - to_format='VCard', - from_format='Msg', - file='/path/to/contact.msg') -``` diff --git a/sdk/docs/ContactDto.md b/sdk/docs/ContactDto.md deleted file mode 100644 index 520a354..0000000 --- a/sdk/docs/ContactDto.md +++ /dev/null @@ -1,83 +0,0 @@ -# AsposeEmailCloudSdk.models.ContactDto - -VCard document representation. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**associated_persons** |[**list[AssociatedPerson]**](AssociatedPerson.md) |Associated persons. |[optional] -**attachments** |[**list[Attachment]**](Attachment.md) |Document attachments. |[optional] -**company_name** |**str** |Company name. |[optional] -**computer_network_name** |**str** |Computer network. |[optional] -**customer_id** |**str** |Customer id. |[optional] -**department_name** |**str** |Department name. |[optional] -**display_name** |**str** |Display name. |[optional] -**email_addresses** |[**list[EmailAddress]**](EmailAddress.md) |Person's email addresses. |[optional] -**events** |[**list[CustomerEvent]**](CustomerEvent.md) |Person's events. |[optional] -**file_as** |**str** |A name used for sorting. |[optional] -**file_as_mapping** |**str** |Specifies how to generate and recompute the value of the dispidFileAs property when other contact name properties change. Coincides MS-OXPROPS revision 16.2 from 7/31/2014. Enum, available values: Empty, DisplayName, FirstName, LastName, Organization, LastFirstMiddle, OrgLastFirstMiddle, LastFirstMiddleOrg, LastFirstMiddle2, LastFirstMiddle3, OrgLastFirstMiddle2, OrgLastFirstMiddle3, LastFirstMiddleOrg2, LastFirstMiddleOrg3, LastFirstMiddleGen, FirstMiddleLastGen, LastFirstMiddleGen2, BestMatch, AccordingToLocale, None | -**free_busy_location** |**str** |URL path from which a client can retrieve free/busy information for the contact as an iCal file. |[optional] -**gender** |**str** |Enum defines gender of a person. Enum, available values: Unspecified, Female, Male | -**given_name** |**str** |Person's given name. |[optional] -**government_id_number** |**str** |Government id number. |[optional] -**hobbies** |**str** |Person's hobbies. |[optional] -**initials** |**str** |Person's initials. |[optional] -**instant_messengers** |[**list[InstantMessengerAddress]**](InstantMessengerAddress.md) |Person's instant messenger addresses. |[optional] -**job_title** |**str** |Person's job title. |[optional] -**language** |**str** |Language. |[optional] -**location** |**str** |Person's location. |[optional] -**middle_name** |**str** |Person's middle name. |[optional] -**nickname** |**str** |Person's nickname. |[optional] -**notes** |**str** |Notes. |[optional] -**notes_format** |**str** |Defines format of a text. Enum, available values: Text, Html | -**office_location** |**str** |Office location. |[optional] -**organizational_id_number** |**str** |Contains an identifier for the mail user used within the mail user's organization. |[optional] -**phone_numbers** |[**list[PhoneNumber]**](PhoneNumber.md) |Person's phone numbers. |[optional] -**photo** |[**ContactPhoto**](ContactPhoto.md) |Person's photo. |[optional] -**physical_addresses** |[**list[PostalAddress]**](PostalAddress.md) |Person's physical addresses. |[optional] -**preferred_text_encoding** |**str** |Encoding for all text properties. |[optional] -**prefix** |**str** |A prefix of a full name such like Mr.(mister), Dr.(doctor) and so on. |[optional] -**profession** |**str** |A job position of a person in a company. |[optional] -**suffix** |**str** |A suffix of a full name such like Jr.(junior), Sr.(senior) and so on. |[optional] -**surname** |**str** |Person's surname. |[optional] -**urls** |[**list[Url]**](Url.md) |Person's urls. |[optional] - - - -## Example -```python -contact_dto = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContactFromFileRequest.md b/sdk/docs/ContactFromFileRequest.md deleted file mode 100644 index 6e6018d..0000000 --- a/sdk/docs/ContactFromFileRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# ContactFromFileRequest - -Request model for ContactApi.from_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |File format Enum, available values: VCard, WebDav, Msg | -**file** |**str** |File to convert | - -## Example -```python -request = models.ContactFromFileRequest( - format='Msg', - file='/path/to/contact.msg') -``` diff --git a/sdk/docs/ContactGetAsFileRequest.md b/sdk/docs/ContactGetAsFileRequest.md deleted file mode 100644 index 5f73a38..0000000 --- a/sdk/docs/ContactGetAsFileRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# ContactGetAsFileRequest - -Request model for ContactApi.get_as_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |Calendar document file name | -**to_format** |**str** |File format Enum, available values: VCard, WebDav, Msg | -**from_format** |**str** |File format to convert from Enum, available values: VCard, WebDav, Msg | -**storage** |**str** |Storage name |[optional] -**folder** |**str** |Path to folder in storage |[optional] - -## Example -```python -request = models.ContactGetAsFileRequest( - file_name='contact.msg', - to_format='VCard', - from_format='Msg', - storage='First Storage', - folder='folder/on/storage') -``` diff --git a/sdk/docs/ContactGetListRequest.md b/sdk/docs/ContactGetListRequest.md deleted file mode 100644 index 6c41033..0000000 --- a/sdk/docs/ContactGetListRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# ContactGetListRequest - -Request model for ContactApi.get_list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |Contact document format. Enum, available values: VCard, WebDav, Msg | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] -**items_per_page** |**int** |Count of items on page. |[optional] [default to 10] -**page_number** |**int** |Page number. |[optional] [default to 0] - -## Example -```python -request = models.ContactGetListRequest( - format='VCard', - folder='folder/on/storage', - storage='First Storage', - items_per_page=10, - page_number=0) -``` diff --git a/sdk/docs/ContactGetRequest.md b/sdk/docs/ContactGetRequest.md deleted file mode 100644 index 2a21187..0000000 --- a/sdk/docs/ContactGetRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# ContactGetRequest - -Request model for ContactApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |Contact document format. Enum, available values: VCard, WebDav, Msg | -**file_name** |**str** |Contact document file name. | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.ContactGetRequest( - format='VCard', - file_name='contact.vcf', - folder='folder/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/ContactList.md b/sdk/docs/ContactList.md deleted file mode 100644 index f243ce3..0000000 --- a/sdk/docs/ContactList.md +++ /dev/null @@ -1,50 +0,0 @@ -# AsposeEmailCloudSdk.models.ContactList - -List of VCard documents - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfContactDto](ListResponseOfContactDto.md) - - -## Example -```python -contact_list = models.ContactList( - value=[ - models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContactPhoto.md b/sdk/docs/ContactPhoto.md deleted file mode 100644 index 7dab61d..0000000 --- a/sdk/docs/ContactPhoto.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.ContactPhoto - -Person's photo. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**photo_image_format** |**str** |MapiContact photo image format. Enum, available values: Undefined, Jpeg, Gif, Wmf, Bmp, Tiff | -**base64_data** |**str** |Photo serialized as base64 string. | -**discriminator** |**str** | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContactSaveRequest.md b/sdk/docs/ContactSaveRequest.md deleted file mode 100644 index 8734c5a..0000000 --- a/sdk/docs/ContactSaveRequest.md +++ /dev/null @@ -1,54 +0,0 @@ -# AsposeEmailCloudSdk.models.ContactSaveRequest - -Contact save to storage request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | - -Parent class: [StorageModelOfContactDto](StorageModelOfContactDto.md) - - -## Example -```python -contact_save_request = models.ContactSaveRequest( - storage_file=models.StorageFileLocation( - file_name='contact.vcf', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')])) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContactStorageList.md b/sdk/docs/ContactStorageList.md deleted file mode 100644 index e55a6f7..0000000 --- a/sdk/docs/ContactStorageList.md +++ /dev/null @@ -1,55 +0,0 @@ -# AsposeEmailCloudSdk.models.ContactStorageList - -Contact models list with corresponding storage locations. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfStorageModelOfContactDto](ListResponseOfStorageModelOfContactDto.md) - - -## Example -```python -contact_storage_list = models.ContactStorageList( - value=[ - models.StorageModelOfContactDto( - storage_file=models.StorageFileLocation( - file_name='contact.vcf', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]))]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContentType.md b/sdk/docs/ContentType.md deleted file mode 100644 index 8f328bd..0000000 --- a/sdk/docs/ContentType.md +++ /dev/null @@ -1,18 +0,0 @@ -# AsposeEmailCloudSdk.models.ContentType - -Represents a Content-Type header. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**boundary** |**str** |The boundary parameter included in the Content-Type header. |[optional] -**char_set** |**str** |CharSet parameter. |[optional] -**media_type** |**str** |The internet media type. |[optional] -**name** |**str** |Name parameter. |[optional] -**parameters** |[**list[ContentTypeParameter]**](ContentTypeParameter.md) |Full list of parameters |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ContentTypeParameter.md b/sdk/docs/ContentTypeParameter.md deleted file mode 100644 index ed5077d..0000000 --- a/sdk/docs/ContentTypeParameter.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.ContentTypeParameter - -Content-Type header parameter - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Parameter name |[optional] -**value** |**str** |Parameter value |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/CopyFileRequest.md b/sdk/docs/CopyFileRequest.md deleted file mode 100644 index 584dbbe..0000000 --- a/sdk/docs/CopyFileRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# CopyFileRequest - -Request model for FileApi.copy_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**src_path** |**str** |Source file path e.g. '/folder/file.ext' | -**dest_path** |**str** |Destination file path | -**src_storage_name** |**str** |Source storage name |[optional] -**dest_storage_name** |**str** |Destination storage name |[optional] -**version_id** |**str** |File version ID to copy |[optional] - -## Example -```python -request = models.CopyFileRequest( - src_path='/storage/path/to/source/file.ext', - dest_path='/storage/path/to/destination/file.ext', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` diff --git a/sdk/docs/CopyFolderRequest.md b/sdk/docs/CopyFolderRequest.md deleted file mode 100644 index decd352..0000000 --- a/sdk/docs/CopyFolderRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# CopyFolderRequest - -Request model for FolderApi.copy_folder - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**src_path** |**str** |Source folder path e.g. '/src' | -**dest_path** |**str** |Destination folder path e.g. '/dst' | -**src_storage_name** |**str** |Source storage name |[optional] -**dest_storage_name** |**str** |Destination storage name |[optional] - -## Example -```python -request = models.CopyFolderRequest( - src_path='/storage/path/to/source/folder', - dest_path='/storage/path/to/destination/folder', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` diff --git a/sdk/docs/CreateFolderRequest.md b/sdk/docs/CreateFolderRequest.md deleted file mode 100644 index 5376972..0000000 --- a/sdk/docs/CreateFolderRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# CreateFolderRequest - -Request model for FolderApi.create_folder - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |Folder path to create e.g. 'folder_1/folder_2/' | -**storage_name** |**str** |Storage name |[optional] - -## Example -```python -request = models.CreateFolderRequest( - path='/storage/path/to/new/folder', - storage_name='First Storage') -``` diff --git a/sdk/docs/CustomerEvent.md b/sdk/docs/CustomerEvent.md deleted file mode 100644 index 3fc1634..0000000 --- a/sdk/docs/CustomerEvent.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.CustomerEvent - -Event. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |[**EnumWithCustomOfEventCategory**](EnumWithCustomOfEventCategory.md) |Event category. |[optional] -**_date** |**datetime** |Event date. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/DailyRecurrencePatternDto.md b/sdk/docs/DailyRecurrencePatternDto.md deleted file mode 100644 index 1dfe9a4..0000000 --- a/sdk/docs/DailyRecurrencePatternDto.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.DailyRecurrencePatternDto - -Daily recurrence. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/DeleteFileRequest.md b/sdk/docs/DeleteFileRequest.md deleted file mode 100644 index 65d9b11..0000000 --- a/sdk/docs/DeleteFileRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# DeleteFileRequest - -Request model for FileApi.delete_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |File path e.g. '/folder/file.ext' | -**storage_name** |**str** |Storage name |[optional] -**version_id** |**str** |File version ID to delete |[optional] - -## Example -```python -request = models.DeleteFileRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') -``` diff --git a/sdk/docs/DeleteFolderRequest.md b/sdk/docs/DeleteFolderRequest.md deleted file mode 100644 index 021d337..0000000 --- a/sdk/docs/DeleteFolderRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# DeleteFolderRequest - -Request model for FolderApi.delete_folder - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |Folder path e.g. '/folder' | -**storage_name** |**str** |Storage name |[optional] -**recursive** |**bool** |Enable to delete folders, subfolders and files |[optional] [default to false] - -## Example -```python -request = models.DeleteFolderRequest( - path='/storage/path/to/folder', - storage_name='First Storage', - recursive=True) -``` diff --git a/sdk/docs/DiscUsage.md b/sdk/docs/DiscUsage.md deleted file mode 100644 index 29cee64..0000000 --- a/sdk/docs/DiscUsage.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.DiscUsage - -Class for disc space information. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**used_size** |**int** |Application used disc space. | -**total_size** |**int** |Total disc space. | - - - -## Example -```python -disc_usage = models.DiscUsage( - used_size=1048576, - total_size=3145728) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/DiscoverEmailConfigRequest.md b/sdk/docs/DiscoverEmailConfigRequest.md deleted file mode 100644 index b2b6dac..0000000 --- a/sdk/docs/DiscoverEmailConfigRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.DiscoverEmailConfigRequest - -Discover email configuration request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address** |**str** |Email address to discover. | -**fast_processing** |**bool** |Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned. | -**login** |**str** |Email account login. If not specified, address used as a login. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/DisposableEmailApi.md b/sdk/docs/DisposableEmailApi.md deleted file mode 100644 index ed650f9..0000000 --- a/sdk/docs/DisposableEmailApi.md +++ /dev/null @@ -1,69 +0,0 @@ -# AsposeEmailCloudSdk.DisposableEmailApi (EmailCloud.disposable_email) - -Checks if an email is a disposable one - - -## is_disposable - -Description: Check email address is disposable - -Returns: true if address is disposable - -Method call example: -```python -result = api.disposable_email.is_disposable(request) -``` - -### Parameter: request - -Description: is_disposable method request. - -See parameter model documentation at [DisposableEmailIsDisposableRequest](DisposableEmailIsDisposableRequest.md). - -
- Parameter initialization example: - -```python -request = models.DisposableEmailIsDisposableRequest( - address='example@mailcatch.com') -``` - -
- -### Result - -Description: true if address is disposable - -Return type: [**ValueTOfBoolean**](ValueTOfBoolean.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.DisposableEmailIsDisposableRequest( - address='example@mailcatch.com') - -// Call method: -result = api.disposable_email.is_disposable(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/DisposableEmailApi_list.md b/sdk/docs/DisposableEmailApi_list.md deleted file mode 100644 index 610a534..0000000 --- a/sdk/docs/DisposableEmailApi_list.md +++ /dev/null @@ -1,7 +0,0 @@ -## Documentation for DisposableEmailApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**is_disposable**](DisposableEmailApi.md#is_disposable)| **GET** /email/disposable/is-disposable| Check email address is disposable diff --git a/sdk/docs/DisposableEmailIsDisposableRequest.md b/sdk/docs/DisposableEmailIsDisposableRequest.md deleted file mode 100644 index f56d229..0000000 --- a/sdk/docs/DisposableEmailIsDisposableRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# DisposableEmailIsDisposableRequest - -Request model for DisposableEmailApi.is_disposable - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**address** |**str** |An email address to check | - -## Example -```python -request = models.DisposableEmailIsDisposableRequest( - address='example@mailcatch.com') -``` diff --git a/sdk/docs/DownloadFileRequest.md b/sdk/docs/DownloadFileRequest.md deleted file mode 100644 index 82460b4..0000000 --- a/sdk/docs/DownloadFileRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# DownloadFileRequest - -Request model for FileApi.download_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |File path e.g. '/folder/file.ext' | -**storage_name** |**str** |Storage name |[optional] -**version_id** |**str** |File version ID to download |[optional] - -## Example -```python -request = models.DownloadFileRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') -``` diff --git a/sdk/docs/EmailAccountConfig.md b/sdk/docs/EmailAccountConfig.md deleted file mode 100644 index 85a5efa..0000000 --- a/sdk/docs/EmailAccountConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailAccountConfig - -Email account configuration. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** |**str** |Email account display name |[optional] -**protocol_type** |**str** |Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | -**host** |**str** |Email account host. |[optional] -**port** |**int** |Port. |[optional] -**socket_type** |**str** |Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | -**authentication_types** |**list[str]** |Supported authentication types. Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress |[optional] -**extra_info** |[**list[NameValuePair]**](NameValuePair.md) |Extra account information. |[optional] -**is_validated** |**bool** |Determines that configuration validated. Set to false if validation skipped. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailAccountConfigList.md b/sdk/docs/EmailAccountConfigList.md deleted file mode 100644 index 2fe7123..0000000 --- a/sdk/docs/EmailAccountConfigList.md +++ /dev/null @@ -1,58 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailAccountConfigList - -List of email accounts - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfEmailAccountConfig](ListResponseOfEmailAccountConfig.md) - - -## Example -```python -email_account_config_list = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailAddress.md b/sdk/docs/EmailAddress.md deleted file mode 100644 index 4438fb0..0000000 --- a/sdk/docs/EmailAddress.md +++ /dev/null @@ -1,19 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailAddress - -Email address. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |[**EnumWithCustomOfEmailAddressCategory**](EnumWithCustomOfEmailAddressCategory.md) |Address category. |[optional] -**display_name** |**str** |Display name. |[optional] -**preferred** |**bool** |Defines whether email address is preferred. | -**routing_type** |**str** |A routing type for an email. |[optional] -**address** |**str** |Email address. | -**original_address_string** |**str** |The original e-mail address string |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailApi.md b/sdk/docs/EmailApi.md deleted file mode 100644 index 6e5230d..0000000 --- a/sdk/docs/EmailApi.md +++ /dev/null @@ -1,811 +0,0 @@ -# AsposeEmailCloudSdk.EmailApi (EmailCloud.email) - -Email document (*.eml) operations. - - -## as_file - -Description: Converts Email model to a specified format and returns as a file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.email.as_file(request) -``` - -### Parameter: request - -Description: Email model and format to convert. - -See parameter model documentation at [EmailAsFileRequest](EmailAsFileRequest.md) - -
- Parameter initialization example: - -```python -request = models.EmailAsFileRequest( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailAsFileRequest( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) - -// Call method: -result = api.email.as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_mapi - -Description: Converts EmailDto to MapiMessageDto. - -Returns: MAPI model message representation - -Method call example: -```python -result = api.email.as_mapi(email_dto) -``` - -### Parameter: email_dto - -Description: Email model to convert - -See parameter model documentation at [EmailDto](EmailDto.md) - -
- Parameter initialization example: - -```python -email_dto = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` - -
- -### Result - -Description: MAPI model message representation - -Return type: [**MapiMessageDto**](MapiMessageDto.md) - -
- Result example - -```python -result = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -email_dto = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) - -// Call method: -result = api.email.as_mapi(email_dto) - -// Result example: -result = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## convert - -Description: Converts email document to specified format and returns as file - -Returns: File stream in specified format - -Method call example: -```python -result = api.email.convert(request) -``` - -### Parameter: request - -Description: convert method request. - -See parameter model documentation at [EmailConvertRequest](EmailConvertRequest.md). - -
- Parameter initialization example: - -```python -request = models.EmailConvertRequest( - from_format='Msg', - to_format='Mhtml', - file='/path/to/message.msg') -``` - -
- -### Result - -Description: File stream in specified format - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailConvertRequest( - from_format='Msg', - to_format='Mhtml', - file='/path/to/message.msg') - -// Call method: -result = api.email.convert(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## from_file - -Description: Converts email document to a model representation - -Returns: Email document model - -Method call example: -```python -result = api.email.from_file(request) -``` - -### Parameter: request - -Description: from_file method request. - -See parameter model documentation at [EmailFromFileRequest](EmailFromFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.EmailFromFileRequest( - format='Eml', - file='/path/to/message.eml') -``` - -
- -### Result - -Description: Email document model - -Return type: [**EmailDto**](EmailDto.md) - -
- Result example - -```python -result = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailFromFileRequest( - format='Eml', - file='/path/to/message.eml') - -// Call method: -result = api.email.from_file(request) - -// Result example: -result = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get - -Description: Get email document from storage. - -Returns: Email document. - -Method call example: -```python -result = api.email.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [EmailGetRequest](EmailGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.EmailGetRequest( - format='Eml', - file_name='email.eml', - folder='folder/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: Email document. - -Return type: [**EmailDto**](EmailDto.md) - -
- Result example - -```python -result = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailGetRequest( - format='Eml', - file_name='email.eml', - folder='folder/on/storage', - storage='First Storage') - -// Call method: -result = api.email.get(request) - -// Result example: -result = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_as_file - -Description: Converts email document from storage to specified format and returns as file - -Returns: File stream in specified format - -Method call example: -```python -result = api.email.get_as_file(request) -``` - -### Parameter: request - -Description: get_as_file method request. - -See parameter model documentation at [EmailGetAsFileRequest](EmailGetAsFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.EmailGetAsFileRequest( - file_name='email.eml', - format='Mhtml', - storage='First Storage', - folder='folder/on/storage') -``` - -
- -### Result - -Description: File stream in specified format - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailGetAsFileRequest( - file_name='email.eml', - format='Mhtml', - storage='First Storage', - folder='folder/on/storage') - -// Call method: -result = api.email.get_as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_list - -Description: Get email list from storage folder. - -Returns: Email document list. - -Method call example: -```python -result = api.email.get_list(request) -``` - -### Parameter: request - -Description: get_list method request. - -See parameter model documentation at [EmailGetListRequest](EmailGetListRequest.md). - -
- Parameter initialization example: - -```python -request = models.EmailGetListRequest( - format='Eml', - folder='folder/on/storage', - storage='First Storage', - items_per_page=10, - page_number=0) -``` - -
- -### Result - -Description: Email document list. - -Return type: [**EmailStorageList**](EmailStorageList.md) - -
- Result example - -```python -result = models.EmailStorageList( - value=[ - models.EmailSaveRequest( - storage_file=models.StorageFileLocation( - file_name='message.eml', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]))]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailGetListRequest( - format='Eml', - folder='folder/on/storage', - storage='First Storage', - items_per_page=10, - page_number=0) - -// Call method: -result = api.email.get_list(request) - -// Result example: -result = models.EmailStorageList( - value=[ - models.EmailSaveRequest( - storage_file=models.StorageFileLocation( - file_name='message.eml', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]))]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Save email document to storage. - -Method call example: -```python -api.email.save(request) -``` - -### Parameter: request - -Description: Email document create/update request. - -See parameter model documentation at [EmailSaveRequest](EmailSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.EmailSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='email.eml', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='email.eml', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) - -// Call method: -api.email.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailApi_list.md b/sdk/docs/EmailApi_list.md deleted file mode 100644 index a77e29f..0000000 --- a/sdk/docs/EmailApi_list.md +++ /dev/null @@ -1,14 +0,0 @@ -## Documentation for EmailApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**as_file**](EmailApi.md#as_file)| **PUT** /email/as-file| Converts Email model to a specified format and returns as a file. -[**as_mapi**](EmailApi.md#as_mapi)| **PUT** /email/as-mapi| Converts EmailDto to MapiMessageDto. -[**convert**](EmailApi.md#convert)| **PUT** /email/convert| Converts email document to specified format and returns as file -[**from_file**](EmailApi.md#from_file)| **PUT** /email/from-file| Converts email document to a model representation -[**get**](EmailApi.md#get)| **GET** /email| Get email document from storage. -[**get_as_file**](EmailApi.md#get_as_file)| **GET** /email/as-file| Converts email document from storage to specified format and returns as file -[**get_list**](EmailApi.md#get_list)| **GET** /email/list| Get email list from storage folder. -[**save**](EmailApi.md#save)| **PUT** /email| Save email document to storage. diff --git a/sdk/docs/EmailAsFileRequest.md b/sdk/docs/EmailAsFileRequest.md deleted file mode 100644 index ed3de3d..0000000 --- a/sdk/docs/EmailAsFileRequest.md +++ /dev/null @@ -1,41 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailAsFileRequest - -Convert email model to file request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**value** |[**EmailDto**](EmailDto.md) |Email model. | - - - -## Example -```python -email_as_file_request = models.EmailAsFileRequest( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailClientAccount.md b/sdk/docs/EmailClientAccount.md deleted file mode 100644 index 3496bb7..0000000 --- a/sdk/docs/EmailClientAccount.md +++ /dev/null @@ -1,37 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailClientAccount - -A universal email client account - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**host** |**str** |Mail server host name or IP address | -**port** |**int** |Mail server port | -**security_options** |**str** |Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | -**protocol_type** |**str** |Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | -**credentials** |[**EmailClientAccountCredentials**](EmailClientAccountCredentials.md) |Email client account credentials | -**cache_file** |[**StorageFileLocation**](StorageFileLocation.md) |File with messages cache. Used to provide extra functions, which are not supported by account |[optional] - - - -## Example -```python -email_client_account = models.EmailClientAccount( - host='smtp.example.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@example.com'), - cache_file=models.StorageFileLocation( - file_name='account.cache', - storage='First Storage', - folder_path='file/location/folder/on/storage')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailClientAccountCredentials.md b/sdk/docs/EmailClientAccountCredentials.md deleted file mode 100644 index b8fa68d..0000000 --- a/sdk/docs/EmailClientAccountCredentials.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailClientAccountCredentials - -Represents email client account credentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**login** |**str** |Email client account login | -**discriminator** |**str** | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailClientAccountOauthCredentials.md b/sdk/docs/EmailClientAccountOauthCredentials.md deleted file mode 100644 index bba23f4..0000000 --- a/sdk/docs/EmailClientAccountOauthCredentials.md +++ /dev/null @@ -1,18 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailClientAccountOauthCredentials - -Represents email client account OAuth 2.0 credentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_id** |**str** |The client ID obtained from the Google Cloud Console during application registration. | -**client_secret** |**str** |The client secret obtained during application registration. | -**refresh_token** |**str** |OAuth 2.0 refresh token | -**request_url** |**str** |The url to obtain access token. If not specified, will try to discover from email client account host. |[optional] - -Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailClientAccountPasswordCredentials.md b/sdk/docs/EmailClientAccountPasswordCredentials.md deleted file mode 100644 index 312e98c..0000000 --- a/sdk/docs/EmailClientAccountPasswordCredentials.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailClientAccountPasswordCredentials - -Represents email client account password credentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**password** |**str** |Email client account password | - -Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailClientMultiAccount.md b/sdk/docs/EmailClientMultiAccount.md deleted file mode 100644 index e683b97..0000000 --- a/sdk/docs/EmailClientMultiAccount.md +++ /dev/null @@ -1,45 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailClientMultiAccount - -Email client virtual account, which contains several accounts - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**receive_accounts** |[**list[EmailClientAccount]**](EmailClientAccount.md) |Email client receive accounts | -**send_account** |[**EmailClientAccount**](EmailClientAccount.md) |Email client send account |[optional] - - - -## Example -```python -email_client_multi_account = models.EmailClientMultiAccount( - receive_accounts=[ - models.EmailClientAccount( - host='imap.gmail.com', - port=993, - security_options='SSLAuto', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com')), - models.EmailClientAccount( - host='exchange@outlook.com', - port=443, - protocol_type='EWS', - credentials=models.EmailClientAccountOauthCredentials( - client_id='clientId', - client_secret='clientSecret', - refresh_token='refreshToken', - login='example@outlook.com'))], - send_account=models.EmailClientAccount( - host='smtp.gmail.com', - port=465, - security_options='SSLAuto', - protocol_type='SMTP', - credentials=models.EmailClientAccountPasswordCredentials( - password='password', - login='example@gmail.com'))) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailConfigApi.md b/sdk/docs/EmailConfigApi.md deleted file mode 100644 index f88375a..0000000 --- a/sdk/docs/EmailConfigApi.md +++ /dev/null @@ -1,443 +0,0 @@ -# AsposeEmailCloudSdk.EmailConfigApi (EmailCloud.email_config) - -Email server configuration discovery. - - -## discover - -Description: Discover email accounts by email address. Does not validate discovered accounts. - -Returns: Discovered account configurations. - -Method call example: -```python -result = api.email_config.discover(request) -``` - -### Parameter: request - -Description: discover method request. - -See parameter model documentation at [EmailConfigDiscoverRequest](EmailConfigDiscoverRequest.md). - -
- Parameter initialization example: - -```python -request = models.EmailConfigDiscoverRequest( - address='address@gmail.com') -``` - -
- -### Result - -Description: Discovered account configurations. - -Return type: [**EmailAccountConfigList**](EmailAccountConfigList.md) - -
- Result example - -```python -result = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailConfigDiscoverRequest( - address='address@gmail.com') - -// Call method: -result = api.email_config.discover(request) - -// Result example: -result = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## discover_oauth - -Description: Discover email accounts by email address. Validates discovered accounts using OAuth 2.0. - -Returns: Discovered account configurations. - -Method call example: -```python -result = api.email_config.discover_oauth(request) -``` - -### Parameter: request - -Description: Discover email configuration request. - -See parameter model documentation at [EmailConfigDiscoverOauthRequest](EmailConfigDiscoverOauthRequest.md) - -
- Parameter initialization example: - -```python -request = models.EmailConfigDiscoverOauthRequest( - client_id='ClientId', - client_secret='ClientSecret', - refresh_token='RefreshToken', - address='example@aspose.com', - fast_processing=True) -``` - -
- -### Result - -Description: Discovered account configurations. - -Return type: [**EmailAccountConfigList**](EmailAccountConfigList.md) - -
- Result example - -```python -result = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailConfigDiscoverOauthRequest( - client_id='ClientId', - client_secret='ClientSecret', - refresh_token='RefreshToken', - address='example@aspose.com', - fast_processing=True) - -// Call method: -result = api.email_config.discover_oauth(request) - -// Result example: -result = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## discover_password - -Description: Discover email accounts by email address. Validates discovered accounts using login and password. - -Returns: Discovered account configurations. - -Method call example: -```python -result = api.email_config.discover_password(request) -``` - -### Parameter: request - -Description: Discover email configuration request. - -See parameter model documentation at [EmailConfigDiscoverPasswordRequest](EmailConfigDiscoverPasswordRequest.md) - -
- Parameter initialization example: - -```python -request = models.EmailConfigDiscoverPasswordRequest( - password='password', - address='example@aspose.com', - fast_processing=True) -``` - -
- -### Result - -Description: Discovered account configurations. - -Return type: [**EmailAccountConfigList**](EmailAccountConfigList.md) - -
- Result example - -```python -result = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.EmailConfigDiscoverPasswordRequest( - password='password', - address='example@aspose.com', - fast_processing=True) - -// Call method: -result = api.email_config.discover_password(request) - -// Result example: -result = models.EmailAccountConfigList( - value=[ - models.EmailAccountConfig( - display_name='Google Mail', - host='imap.gmail.com', - port=993, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='SMTP', - host='smtp.gmail.com', - port=465, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), - models.EmailAccountConfig( - display_name='Google Mail', - protocol_type='POP3', - host='pop.gmail.com', - port=995, - socket_type='SSLAuto', - authentication_types=[ - 'PasswordCleartext', - 'OAuth2'], - extra_info=[ - models.NameValuePair( - name='Enable: You need to enable IMAP access', - value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailConfigApi_list.md b/sdk/docs/EmailConfigApi_list.md deleted file mode 100644 index e45bf09..0000000 --- a/sdk/docs/EmailConfigApi_list.md +++ /dev/null @@ -1,9 +0,0 @@ -## Documentation for EmailConfigApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**discover**](EmailConfigApi.md#discover)| **GET** /email/config/discover| Discover email accounts by email address. Does not validate discovered accounts. -[**discover_oauth**](EmailConfigApi.md#discover_oauth)| **PUT** /email/config/discover/oauth| Discover email accounts by email address. Validates discovered accounts using OAuth 2.0. -[**discover_password**](EmailConfigApi.md#discover_password)| **PUT** /email/config/discover/password| Discover email accounts by email address. Validates discovered accounts using login and password. diff --git a/sdk/docs/EmailConfigDiscoverOauthRequest.md b/sdk/docs/EmailConfigDiscoverOauthRequest.md deleted file mode 100644 index 2a37d75..0000000 --- a/sdk/docs/EmailConfigDiscoverOauthRequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailConfigDiscoverOauthRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_id** |**str** |OAuth client id. | -**client_secret** |**str** |OAuth client secret. | -**refresh_token** |**str** |OAuth refresh token. | -**request_url** |**str** |The url to obtain access token. If not specified, will be discovered from email configuration. |[optional] - -Parent class: [DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) - - -## Example -```python -email_config_discover_oauth_request = models.EmailConfigDiscoverOauthRequest( - client_id='ClientId', - client_secret='ClientSecret', - refresh_token='RefreshToken', - address='example@aspose.com', - fast_processing=True) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailConfigDiscoverPasswordRequest.md b/sdk/docs/EmailConfigDiscoverPasswordRequest.md deleted file mode 100644 index d9c3c66..0000000 --- a/sdk/docs/EmailConfigDiscoverPasswordRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailConfigDiscoverPasswordRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**password** |**str** |Email account password. | - -Parent class: [DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) - - -## Example -```python -email_config_discover_password_request = models.EmailConfigDiscoverPasswordRequest( - password='password', - address='example@aspose.com', - fast_processing=True) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailConfigDiscoverRequest.md b/sdk/docs/EmailConfigDiscoverRequest.md deleted file mode 100644 index da231df..0000000 --- a/sdk/docs/EmailConfigDiscoverRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# EmailConfigDiscoverRequest - -Request model for EmailConfigApi.discover - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**address** |**str** |Email address. | -**fast_processing** |**bool** |Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned. |[optional] [default to false] - -## Example -```python -request = models.EmailConfigDiscoverRequest( - address='address@gmail.com') -``` diff --git a/sdk/docs/EmailConvertRequest.md b/sdk/docs/EmailConvertRequest.md deleted file mode 100644 index 8afe307..0000000 --- a/sdk/docs/EmailConvertRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# EmailConvertRequest - -Request model for EmailApi.convert - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**from_format** |**str** |File format to convert to Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**to_format** |**str** |File format to convert from Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**file** |**str** |File to convert | - -## Example -```python -request = models.EmailConvertRequest( - from_format='Msg', - to_format='Mhtml', - file='/path/to/message.msg') -``` diff --git a/sdk/docs/EmailDto.md b/sdk/docs/EmailDto.md deleted file mode 100644 index d7bb9a2..0000000 --- a/sdk/docs/EmailDto.md +++ /dev/null @@ -1,70 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailDto - -Email message representation. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**alternate_views** |[**list[AlternateView]**](AlternateView.md) |Collection of alternate views of message. |[optional] -**attachments** |[**list[Attachment]**](Attachment.md) |Email message attachments. |[optional] -**bcc** |[**list[MailAddress]**](MailAddress.md) |BCC recipients. |[optional] -**body** |**str** |Email message body as plain text. |[optional] -**body_encoding** |**str** |Body encoding. |[optional] -**body_type** |**str** |The content type of message body. Enum, available values: PlainText, Html, Rtf | -**cc** |[**list[MailAddress]**](MailAddress.md) |CC recipients. |[optional] -**_date** |**datetime** |Message date. | -**delivery_notification_options** |**list[str]** |Delivery notifications. Items: Email delivery notification options. Enum, available values: Delay, Never, None, OnFailure, OnSuccess |[optional] -**_from** |[**MailAddress**](MailAddress.md) |From address. |[optional] -**headers** |**dict(str, str)** |Document headers. |[optional] -**html_body** |**str** |HTML body. |[optional] -**html_body_text** |**str** |Html body as plain text. Read only. |[optional] -**is_body_html** |**bool** |Indicates whether the message body is in Html. | -**is_draft** |**bool** |Indicates whether or not a message has been sent. | -**is_encrypted** |**bool** |Indicates whether the message is encrypted. Read only. | -**is_signed** |**bool** |Indicates whether the message is signed. Read only. | -**linked_resources** |[**list[LinkedResource]**](LinkedResource.md) |Linked resources of message. |[optional] -**message_id** |**str** |Message id. |[optional] -**original_is_tnef** |**bool** |Indicates whether original EML message is in TNEF format. Read only. | -**preferred_text_encoding** |**str** |Preferred encoding. |[optional] -**priority** |**str** |Email priority status. Enum, available values: High, Low, Normal | -**read_receipt_to** |[**list[MailAddress]**](MailAddress.md) |Read receipt addresses. |[optional] -**reply_to_list** |[**list[MailAddress]**](MailAddress.md) |The list of addresses to reply to for the mail message. |[optional] -**reverse_path** |[**MailAddress**](MailAddress.md) |ReversePath address. |[optional] -**sender** |[**MailAddress**](MailAddress.md) |Sender address. |[optional] -**sensitivity** |**str** |Specifies the sensitivity of a MailMessage. Enum, available values: None, Normal, Personal, Private, CompanyConfidential | -**subject** |**str** |Message subject. |[optional] -**subject_encoding** |**str** |Subject encoding. |[optional] -**time_zone_offset** |**int** |Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC represented as count of ticks (10 000 per millisecond). |[optional] -**to** |[**list[MailAddress]**](MailAddress.md) |The address collection that contains the recipients of message. |[optional] -**x_mailer** |**str** |The X-Mailer the software that created the e-mail message. |[optional] - - - -## Example -```python -email_dto = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailFromFileRequest.md b/sdk/docs/EmailFromFileRequest.md deleted file mode 100644 index 690d406..0000000 --- a/sdk/docs/EmailFromFileRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# EmailFromFileRequest - -Request model for EmailApi.from_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** | Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**file** |**str** |File to convert | - -## Example -```python -request = models.EmailFromFileRequest( - format='Eml', - file='/path/to/message.eml') -``` diff --git a/sdk/docs/EmailGetAsFileRequest.md b/sdk/docs/EmailGetAsFileRequest.md deleted file mode 100644 index c9169f8..0000000 --- a/sdk/docs/EmailGetAsFileRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# EmailGetAsFileRequest - -Request model for EmailApi.get_as_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |Email document file name | -**format** |**str** |File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**storage** |**str** |Storage name |[optional] -**folder** |**str** |Path to folder in storage |[optional] - -## Example -```python -request = models.EmailGetAsFileRequest( - file_name='email.eml', - format='Mhtml', - storage='First Storage', - folder='folder/on/storage') -``` diff --git a/sdk/docs/EmailGetListRequest.md b/sdk/docs/EmailGetListRequest.md deleted file mode 100644 index dda34a9..0000000 --- a/sdk/docs/EmailGetListRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# EmailGetListRequest - -Request model for EmailApi.get_list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] -**items_per_page** |**int** |Count of items on page. |[optional] [default to 10] -**page_number** |**int** |Page number. |[optional] [default to 0] - -## Example -```python -request = models.EmailGetListRequest( - format='Eml', - folder='folder/on/storage', - storage='First Storage', - items_per_page=10, - page_number=0) -``` diff --git a/sdk/docs/EmailGetRequest.md b/sdk/docs/EmailGetRequest.md deleted file mode 100644 index d801395..0000000 --- a/sdk/docs/EmailGetRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# EmailGetRequest - -Request model for EmailApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**file_name** |**str** |Email document file name. | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.EmailGetRequest( - format='Eml', - file_name='email.eml', - folder='folder/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/EmailList.md b/sdk/docs/EmailList.md deleted file mode 100644 index fa349dc..0000000 --- a/sdk/docs/EmailList.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailList - -Email document list. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfEmailDto](ListResponseOfEmailDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailSaveRequest.md b/sdk/docs/EmailSaveRequest.md deleted file mode 100644 index 76f4a56..0000000 --- a/sdk/docs/EmailSaveRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailSaveRequest - -Email save to storage request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - -Parent class: [StorageModelOfEmailDto](StorageModelOfEmailDto.md) - - -## Example -```python -email_save_request = models.EmailSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='email.eml', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailStorageList.md b/sdk/docs/EmailStorageList.md deleted file mode 100644 index 64eae94..0000000 --- a/sdk/docs/EmailStorageList.md +++ /dev/null @@ -1,46 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailStorageList - -Email models list with corresponding storage locations. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfStorageModelOfEmailDto](ListResponseOfStorageModelOfEmailDto.md) - - -## Example -```python -email_storage_list = models.EmailStorageList( - value=[ - models.EmailSaveRequest( - storage_file=models.StorageFileLocation( - file_name='message.eml', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]))]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailThread.md b/sdk/docs/EmailThread.md deleted file mode 100644 index dc27753..0000000 --- a/sdk/docs/EmailThread.md +++ /dev/null @@ -1,69 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailThread - -Email messages thread - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** |**str** |Thread identifier |[optional] -**subject** |**str** |Thread subject |[optional] -**messages** |[**list[EmailDto]**](EmailDto.md) |List of messages in thread |[optional] -**folder** |**str** |Thread folder location |[optional] - - - -## Example -```python -email_thread = models.EmailThread( - id='5', - subject='Some subject', - messages=[ - models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - date=datetime.today(), - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]), - models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Other body', - body_type='Html', - date=datetime.today(), - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EmailThreadList.md b/sdk/docs/EmailThreadList.md deleted file mode 100644 index c6515d7..0000000 --- a/sdk/docs/EmailThreadList.md +++ /dev/null @@ -1,42 +0,0 @@ -# AsposeEmailCloudSdk.models.EmailThreadList - -List of email threads - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfEmailThread](ListResponseOfEmailThread.md) - - -## Example -```python -email_thread_list = models.EmailThreadList( - value=[ - models.EmailThread( - id='123', - subject='Some email subject', - messages=[ - models.EmailDto( - date=datetime.today(), - _from=models.MailAddress( - address='from@aspose.com'), - message_id='1', - subject='Some email subject', - to=[ - models.MailAddress( - address='to@aspose.com')]), - models.EmailDto( - date=datetime.today(), - _from=models.MailAddress( - address='from@aspose.com'), - message_id='3', - subject='Re: Some email subject', - to=[ - models.MailAddress( - address='to@aspose.com')])])]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md b/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md deleted file mode 100644 index 147f04a..0000000 --- a/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfAssociatedPersonCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Associated person's category. Enum, available values: Spouse, Child, Mother, Father, Parent, Brother, Sister, Friend, Relative, Manager, Assistant, ReferredBy, Partner, DomesticPartner, Custom | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfEmailAddressCategory.md b/sdk/docs/EnumWithCustomOfEmailAddressCategory.md deleted file mode 100644 index cf0c040..0000000 --- a/sdk/docs/EnumWithCustomOfEmailAddressCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfEmailAddressCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Represents category for an email address. Enum, available values: Home, Work, Custom, Email1, Email2, Email3 | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfEventCategory.md b/sdk/docs/EnumWithCustomOfEventCategory.md deleted file mode 100644 index e50496e..0000000 --- a/sdk/docs/EnumWithCustomOfEventCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfEventCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Event category. Enum, available values: Custom, Birthday, Anniversary | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md b/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md deleted file mode 100644 index 873f20d..0000000 --- a/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfInstantMessengerCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Instant messenger address category. Enum, available values: GoogleTalk, Aim, Yahoo, Skype, Qq, Msn, Icq, Jabber, Custom, ImAddress1, ImAddress2, ImAddress3 | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md b/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md deleted file mode 100644 index 05e472c..0000000 --- a/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfPhoneNumberCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Phone number category. Enum, available values: Custom, Home, Work, Office, Mobile, Fax, HomeFax, WorkFax, Pager, Car, Isdn, Telex, Callback, Radio, Company, TtyTdd, Assistant, Primary | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfPostalAddressCategory.md b/sdk/docs/EnumWithCustomOfPostalAddressCategory.md deleted file mode 100644 index ebb4c12..0000000 --- a/sdk/docs/EnumWithCustomOfPostalAddressCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfPostalAddressCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Address category. Enum, available values: Home, Work, Custom | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/EnumWithCustomOfUrlCategory.md b/sdk/docs/EnumWithCustomOfUrlCategory.md deleted file mode 100644 index b594625..0000000 --- a/sdk/docs/EnumWithCustomOfUrlCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.EnumWithCustomOfUrlCategory - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Url category. Enum, available values: Profile, HomePage, Home, Work, Blog, Ftp, Custom | -**description** |**str** | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/Error.md b/sdk/docs/Error.md deleted file mode 100644 index 5254b29..0000000 --- a/sdk/docs/Error.md +++ /dev/null @@ -1,17 +0,0 @@ -# AsposeEmailCloudSdk.models.Error - -Error - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** |**str** |Code |[optional] -**message** |**str** |Message |[optional] -**description** |**str** |Description |[optional] -**inner_error** |[**ErrorDetails**](ErrorDetails.md) |Inner Error |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ErrorDetails.md b/sdk/docs/ErrorDetails.md deleted file mode 100644 index 2bfcbde..0000000 --- a/sdk/docs/ErrorDetails.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.ErrorDetails - -The error details - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** |**str** |The request id |[optional] -**_date** |**datetime** |Date | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FileApi.md b/sdk/docs/FileApi.md deleted file mode 100644 index 8068505..0000000 --- a/sdk/docs/FileApi.md +++ /dev/null @@ -1,289 +0,0 @@ -# AsposeEmailCloudSdk.FileApi (EmailCloud.cloud_storage.file) - -File operations controller - - -## copy_file - -Description: Copy file - -Method call example: -```python -api.cloud_storage.file.copy_file(request) -``` - -### Parameter: request - -Description: copy_file method request. - -See parameter model documentation at [CopyFileRequest](CopyFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.CopyFileRequest( - src_path='/storage/path/to/source/file.ext', - dest_path='/storage/path/to/destination/file.ext', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CopyFileRequest( - src_path='/storage/path/to/source/file.ext', - dest_path='/storage/path/to/destination/file.ext', - src_storage_name='First Storage', - dest_storage_name='Other Storage') - -// Call method: -api.cloud_storage.file.copy_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## delete_file - -Description: Delete file - -Method call example: -```python -api.cloud_storage.file.delete_file(request) -``` - -### Parameter: request - -Description: delete_file method request. - -See parameter model documentation at [DeleteFileRequest](DeleteFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.DeleteFileRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.DeleteFileRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') - -// Call method: -api.cloud_storage.file.delete_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## download_file - -Description: Download file - -Returns: The raw data of the file. - -Method call example: -```python -result = api.cloud_storage.file.download_file(request) -``` - -### Parameter: request - -Description: download_file method request. - -See parameter model documentation at [DownloadFileRequest](DownloadFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.DownloadFileRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') -``` - -
- -### Result - -Description: The raw data of the file. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.DownloadFileRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.file.download_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## move_file - -Description: Move file - -Method call example: -```python -api.cloud_storage.file.move_file(request) -``` - -### Parameter: request - -Description: move_file method request. - -See parameter model documentation at [MoveFileRequest](MoveFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.MoveFileRequest( - src_path='/storage/path/to/source/file.ext', - dest_path='/storage/path/to/destination/file.ext', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MoveFileRequest( - src_path='/storage/path/to/source/file.ext', - dest_path='/storage/path/to/destination/file.ext', - src_storage_name='First Storage', - dest_storage_name='Other Storage') - -// Call method: -api.cloud_storage.file.move_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## upload_file - -Description: Upload file - -Returns: Empty error list if the upload is successful. - -Method call example: -```python -result = api.cloud_storage.file.upload_file(request) -``` - -### Parameter: request - -Description: upload_file method request. - -See parameter model documentation at [UploadFileRequest](UploadFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.UploadFileRequest( - path='/storage/path/to/file.ext', - file='/local/file/system/path/to/file.ext', - storage_name='First Storage') -``` - -
- -### Result - -Description: Empty error list if the upload is successful. - -Return type: [**FilesUploadResult**](FilesUploadResult.md) - -
- Result example - -```python -result = -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.UploadFileRequest( - path='/storage/path/to/file.ext', - file='/local/file/system/path/to/file.ext', - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.file.upload_file(request) - -// Result example: -result = -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FileApi_list.md b/sdk/docs/FileApi_list.md deleted file mode 100644 index 134ec67..0000000 --- a/sdk/docs/FileApi_list.md +++ /dev/null @@ -1,11 +0,0 @@ -## Documentation for FileApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**copy_file**](FileApi.md#copy_file)| **PUT** /email/storage/file/copy/{srcPath}| Copy file -[**delete_file**](FileApi.md#delete_file)| **DELETE** /email/storage/file/{path}| Delete file -[**download_file**](FileApi.md#download_file)| **GET** /email/storage/file/{path}| Download file -[**move_file**](FileApi.md#move_file)| **PUT** /email/storage/file/move/{srcPath}| Move file -[**upload_file**](FileApi.md#upload_file)| **PUT** /email/storage/file/{path}| Upload file diff --git a/sdk/docs/FileVersion.md b/sdk/docs/FileVersion.md deleted file mode 100644 index 0a212e0..0000000 --- a/sdk/docs/FileVersion.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.FileVersion - -File Version - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version_id** |**str** |File Version ID. |[optional] -**is_latest** |**bool** |Specifies whether the file is (true) or is not (false) the latest version of an file. | - -Parent class: [StorageFile](StorageFile.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FileVersions.md b/sdk/docs/FileVersions.md deleted file mode 100644 index 7b2ae56..0000000 --- a/sdk/docs/FileVersions.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.FileVersions - -File versions FileVersion. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[FileVersion]**](FileVersion.md) |File versions FileVersion. |[optional] - - - -## Example -```python -file_versions = models.FileVersions( - value=[ - models.FileVersion( - version_id='d5afd857-8797-4ca0-b806-a03fdfc3831f', - is_latest=True, - name='file.ext', - modified_date=datetime.today(), - size=4096, - path='/storage/path/to')]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FilesList.md b/sdk/docs/FilesList.md deleted file mode 100644 index 41b9188..0000000 --- a/sdk/docs/FilesList.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.FilesList - -Files list - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[StorageFile]**](StorageFile.md) |Files and folders contained by folder StorageFile. |[optional] - - - -## Example -```python -files_list = models.FilesList( - value=[ - models.StorageFile( - name='file.ext', - modified_date=datetime.today(), - size=1024, - path='/path/to/file/on/storage')]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FilesUploadResult.md b/sdk/docs/FilesUploadResult.md deleted file mode 100644 index 6ec4913..0000000 --- a/sdk/docs/FilesUploadResult.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.FilesUploadResult - -File upload result - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uploaded** |**list[str]** |List of uploaded file names |[optional] -**errors** |[**list[Error]**](Error.md) |List of errors. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FolderApi.md b/sdk/docs/FolderApi.md deleted file mode 100644 index 0e9487e..0000000 --- a/sdk/docs/FolderApi.md +++ /dev/null @@ -1,297 +0,0 @@ -# AsposeEmailCloudSdk.FolderApi (EmailCloud.cloud_storage.folder) - -Folder operations controller - - -## copy_folder - -Description: Copy folder - -Method call example: -```python -api.cloud_storage.folder.copy_folder(request) -``` - -### Parameter: request - -Description: copy_folder method request. - -See parameter model documentation at [CopyFolderRequest](CopyFolderRequest.md). - -
- Parameter initialization example: - -```python -request = models.CopyFolderRequest( - src_path='/storage/path/to/source/folder', - dest_path='/storage/path/to/destination/folder', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CopyFolderRequest( - src_path='/storage/path/to/source/folder', - dest_path='/storage/path/to/destination/folder', - src_storage_name='First Storage', - dest_storage_name='Other Storage') - -// Call method: -api.cloud_storage.folder.copy_folder(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## create_folder - -Description: Create the folder - -Method call example: -```python -api.cloud_storage.folder.create_folder(request) -``` - -### Parameter: request - -Description: create_folder method request. - -See parameter model documentation at [CreateFolderRequest](CreateFolderRequest.md). - -
- Parameter initialization example: - -```python -request = models.CreateFolderRequest( - path='/storage/path/to/new/folder', - storage_name='First Storage') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.CreateFolderRequest( - path='/storage/path/to/new/folder', - storage_name='First Storage') - -// Call method: -api.cloud_storage.folder.create_folder(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## delete_folder - -Description: Delete folder - -Method call example: -```python -api.cloud_storage.folder.delete_folder(request) -``` - -### Parameter: request - -Description: delete_folder method request. - -See parameter model documentation at [DeleteFolderRequest](DeleteFolderRequest.md). - -
- Parameter initialization example: - -```python -request = models.DeleteFolderRequest( - path='/storage/path/to/folder', - storage_name='First Storage', - recursive=True) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.DeleteFolderRequest( - path='/storage/path/to/folder', - storage_name='First Storage', - recursive=True) - -// Call method: -api.cloud_storage.folder.delete_folder(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_files_list - -Description: Get all files and folders within a folder - -Returns: Returns all files and folders contained by the folder. - -Method call example: -```python -result = api.cloud_storage.folder.get_files_list(request) -``` - -### Parameter: request - -Description: get_files_list method request. - -See parameter model documentation at [GetFilesListRequest](GetFilesListRequest.md). - -
- Parameter initialization example: - -```python -request = models.GetFilesListRequest( - path='/storage/path/to/folder', - storage_name='First Storage') -``` - -
- -### Result - -Description: Returns all files and folders contained by the folder. - -Return type: [**FilesList**](FilesList.md) - -
- Result example - -```python -result = models.FilesList( - value=[ - models.StorageFile( - name='file.ext', - modified_date=datetime.today(), - size=1024, - path='/path/to/file/on/storage')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.GetFilesListRequest( - path='/storage/path/to/folder', - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.folder.get_files_list(request) - -// Result example: -result = models.FilesList( - value=[ - models.StorageFile( - name='file.ext', - modified_date=datetime.today(), - size=1024, - path='/path/to/file/on/storage')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## move_folder - -Description: Move folder - -Method call example: -```python -api.cloud_storage.folder.move_folder(request) -``` - -### Parameter: request - -Description: move_folder method request. - -See parameter model documentation at [MoveFolderRequest](MoveFolderRequest.md). - -
- Parameter initialization example: - -```python -request = models.MoveFolderRequest( - src_path='/storage/path/to/source/folder', - dest_path='/storage/path/to/destination/folder', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MoveFolderRequest( - src_path='/storage/path/to/source/folder', - dest_path='/storage/path/to/destination/folder', - src_storage_name='First Storage', - dest_storage_name='Other Storage') - -// Call method: -api.cloud_storage.folder.move_folder(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/FolderApi_list.md b/sdk/docs/FolderApi_list.md deleted file mode 100644 index e92a481..0000000 --- a/sdk/docs/FolderApi_list.md +++ /dev/null @@ -1,11 +0,0 @@ -## Documentation for FolderApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**copy_folder**](FolderApi.md#copy_folder)| **PUT** /email/storage/folder/copy/{srcPath}| Copy folder -[**create_folder**](FolderApi.md#create_folder)| **PUT** /email/storage/folder/{path}| Create the folder -[**delete_folder**](FolderApi.md#delete_folder)| **DELETE** /email/storage/folder/{path}| Delete folder -[**get_files_list**](FolderApi.md#get_files_list)| **GET** /email/storage/folder/{path}| Get all files and folders within a folder -[**move_folder**](FolderApi.md#move_folder)| **PUT** /email/storage/folder/move/{srcPath}| Move folder diff --git a/sdk/docs/GetDiscUsageRequest.md b/sdk/docs/GetDiscUsageRequest.md deleted file mode 100644 index 060dfa5..0000000 --- a/sdk/docs/GetDiscUsageRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# GetDiscUsageRequest - -Request model for StorageApi.get_disc_usage - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**storage_name** |**str** |Storage name |[optional] - -## Example -```python -request = models.GetDiscUsageRequest( - storage_name='First Storage') -``` diff --git a/sdk/docs/GetFileVersionsRequest.md b/sdk/docs/GetFileVersionsRequest.md deleted file mode 100644 index 01b2dc0..0000000 --- a/sdk/docs/GetFileVersionsRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# GetFileVersionsRequest - -Request model for StorageApi.get_file_versions - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |File path e.g. '/file.ext' | -**storage_name** |**str** |Storage name |[optional] - -## Example -```python -request = models.GetFileVersionsRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') -``` diff --git a/sdk/docs/GetFilesListRequest.md b/sdk/docs/GetFilesListRequest.md deleted file mode 100644 index 78045d5..0000000 --- a/sdk/docs/GetFilesListRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# GetFilesListRequest - -Request model for FolderApi.get_files_list - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |Folder path e.g. '/folder' | -**storage_name** |**str** |Storage name |[optional] - -## Example -```python -request = models.GetFilesListRequest( - path='/storage/path/to/folder', - storage_name='First Storage') -``` diff --git a/sdk/docs/InstantMessengerAddress.md b/sdk/docs/InstantMessengerAddress.md deleted file mode 100644 index 2ba078d..0000000 --- a/sdk/docs/InstantMessengerAddress.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.InstantMessengerAddress - -Instant messenger address. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |[**EnumWithCustomOfInstantMessengerCategory**](EnumWithCustomOfInstantMessengerCategory.md) |Address category. |[optional] -**address** |**str** |Address. |[optional] -**preferred** |**bool** |Determines whether this address is preferred. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/LinkedResource.md b/sdk/docs/LinkedResource.md deleted file mode 100644 index 4585d4f..0000000 --- a/sdk/docs/LinkedResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.LinkedResource - -Represents an embedded resource in a message. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content_link** |**str** |URI that the resource must match. |[optional] - -Parent class: [AttachmentBase](AttachmentBase.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfAiNameComponent.md b/sdk/docs/ListResponseOfAiNameComponent.md deleted file mode 100644 index f7461e8..0000000 --- a/sdk/docs/ListResponseOfAiNameComponent.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfAiNameComponent - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[AiNameComponent]**](AiNameComponent.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfAiNameExtracted.md b/sdk/docs/ListResponseOfAiNameExtracted.md deleted file mode 100644 index 663a65b..0000000 --- a/sdk/docs/ListResponseOfAiNameExtracted.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfAiNameExtracted - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[AiNameExtracted]**](AiNameExtracted.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfAiNameGenderHypothesis.md b/sdk/docs/ListResponseOfAiNameGenderHypothesis.md deleted file mode 100644 index 5599123..0000000 --- a/sdk/docs/ListResponseOfAiNameGenderHypothesis.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfAiNameGenderHypothesis - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[AiNameGenderHypothesis]**](AiNameGenderHypothesis.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfContactDto.md b/sdk/docs/ListResponseOfContactDto.md deleted file mode 100644 index 06ddb5c..0000000 --- a/sdk/docs/ListResponseOfContactDto.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfContactDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[ContactDto]**](ContactDto.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfEmailAccountConfig.md b/sdk/docs/ListResponseOfEmailAccountConfig.md deleted file mode 100644 index cde21df..0000000 --- a/sdk/docs/ListResponseOfEmailAccountConfig.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfEmailAccountConfig - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[EmailAccountConfig]**](EmailAccountConfig.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfEmailDto.md b/sdk/docs/ListResponseOfEmailDto.md deleted file mode 100644 index 67af3ae..0000000 --- a/sdk/docs/ListResponseOfEmailDto.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfEmailDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[EmailDto]**](EmailDto.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfEmailThread.md b/sdk/docs/ListResponseOfEmailThread.md deleted file mode 100644 index 60a14ad..0000000 --- a/sdk/docs/ListResponseOfEmailThread.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfEmailThread - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[EmailThread]**](EmailThread.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfMailMessageBase.md b/sdk/docs/ListResponseOfMailMessageBase.md deleted file mode 100644 index cf2bd24..0000000 --- a/sdk/docs/ListResponseOfMailMessageBase.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfMailMessageBase - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[MailMessageBase]**](MailMessageBase.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfMailServerFolder.md b/sdk/docs/ListResponseOfMailServerFolder.md deleted file mode 100644 index d0f9aa9..0000000 --- a/sdk/docs/ListResponseOfMailServerFolder.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfMailServerFolder - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[MailServerFolder]**](MailServerFolder.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfStorageFileLocation.md b/sdk/docs/ListResponseOfStorageFileLocation.md deleted file mode 100644 index 275a834..0000000 --- a/sdk/docs/ListResponseOfStorageFileLocation.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfStorageFileLocation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[StorageFileLocation]**](StorageFileLocation.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md b/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md deleted file mode 100644 index 3df2aed..0000000 --- a/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfCalendarDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[StorageModelOfCalendarDto]**](StorageModelOfCalendarDto.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfStorageModelOfContactDto.md b/sdk/docs/ListResponseOfStorageModelOfContactDto.md deleted file mode 100644 index 0e28f20..0000000 --- a/sdk/docs/ListResponseOfStorageModelOfContactDto.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfContactDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[StorageModelOfContactDto]**](StorageModelOfContactDto.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ListResponseOfStorageModelOfEmailDto.md b/sdk/docs/ListResponseOfStorageModelOfEmailDto.md deleted file mode 100644 index 772288c..0000000 --- a/sdk/docs/ListResponseOfStorageModelOfEmailDto.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfEmailDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**list[StorageModelOfEmailDto]**](StorageModelOfEmailDto.md) | |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailAddress.md b/sdk/docs/MailAddress.md deleted file mode 100644 index e798961..0000000 --- a/sdk/docs/MailAddress.md +++ /dev/null @@ -1,17 +0,0 @@ -# AsposeEmailCloudSdk.models.MailAddress - -Represents the address of a message. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** |**str** |Display name |[optional] -**address** |**str** |Address |[optional] -**participation_status** |**str** |Identifies the participation status for the calendar user. Enum, available values: NeedsAction, Accepted, Declined, Tentative, Delegated | -**original_address_string** |**str** |The original e-mail address string |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailMessageBase.md b/sdk/docs/MailMessageBase.md deleted file mode 100644 index 09dc179..0000000 --- a/sdk/docs/MailMessageBase.md +++ /dev/null @@ -1,20 +0,0 @@ -# AsposeEmailCloudSdk.models.MailMessageBase - -Universal object that stores email messages in different formats. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**discriminator** |**str** | | - - - -## Example -```python -mail_message_base = models.MailMessageBase( - ) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailMessageBase64.md b/sdk/docs/MailMessageBase64.md deleted file mode 100644 index 7cc028e..0000000 --- a/sdk/docs/MailMessageBase64.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.MailMessageBase64 - -Email message represented as file, encoded to Base64 format. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value_base64** |**str** |Email message file data encoded to Base64 string. | -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - -Parent class: [MailMessageBase](MailMessageBase.md) - - -## Example -```python -mail_message_base64 = models.MailMessageBase64( - value_base64='RnJvbTogZkBmLnVzClRvOiB0QHQudXMKU3ViamVjdDogUwoKQm9keQ==') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailMessageBaseList.md b/sdk/docs/MailMessageBaseList.md deleted file mode 100644 index a2dd630..0000000 --- a/sdk/docs/MailMessageBaseList.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.MailMessageBaseList - -List of messages. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfMailMessageBase](ListResponseOfMailMessageBase.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailMessageDto.md b/sdk/docs/MailMessageDto.md deleted file mode 100644 index 3184e50..0000000 --- a/sdk/docs/MailMessageDto.md +++ /dev/null @@ -1,41 +0,0 @@ -# AsposeEmailCloudSdk.models.MailMessageDto - -Represents email message, stored as an EmailDto object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**EmailDto**](EmailDto.md) |Message document object. | - -Parent class: [MailMessageBase](MailMessageBase.md) - - -## Example -```python -mail_message_dto = models.MailMessageDto( - value=models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')])) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailMessageMapi.md b/sdk/docs/MailMessageMapi.md deleted file mode 100644 index 113c2aa..0000000 --- a/sdk/docs/MailMessageMapi.md +++ /dev/null @@ -1,48 +0,0 @@ -# AsposeEmailCloudSdk.models.MailMessageMapi - -Email message represented as MAPI object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |[**MapiMessageDto**](MapiMessageDto.md) |Email message object. | - -Parent class: [MailMessageBase](MailMessageBase.md) - - -## Example -```python -mail_message_mapi = models.MailMessageMapi( - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailServerFolder.md b/sdk/docs/MailServerFolder.md deleted file mode 100644 index ea9cf28..0000000 --- a/sdk/docs/MailServerFolder.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MailServerFolder - -Email account folder - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Gets or sets mail folder name |[optional] -**id** |**str** |Gets or sets mail folder id |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MailServerFolderList.md b/sdk/docs/MailServerFolderList.md deleted file mode 100644 index bf5f11c..0000000 --- a/sdk/docs/MailServerFolderList.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.MailServerFolderList - -List of email client folders. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfMailServerFolder](ListResponseOfMailServerFolder.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiAttachmentDto.md b/sdk/docs/MapiAttachmentDto.md deleted file mode 100644 index a4f417a..0000000 --- a/sdk/docs/MapiAttachmentDto.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiAttachmentDto - -Mapi attachment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Attachment's name |[optional] -**data_base64** |**str** |Attachment data represented as Base64 string. |[optional] - - - -## Example -```python -mapi_attachment_dto = models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiBinaryPropertyDto.md b/sdk/docs/MapiBinaryPropertyDto.md deleted file mode 100644 index 26f9ecd..0000000 --- a/sdk/docs/MapiBinaryPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiBinaryPropertyDto - -Mapi property with Binary value represented as a Base64 string - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value_base64** |**str** |Property value converted to Base64 |[optional] - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiBooleanPropertyDto.md b/sdk/docs/MapiBooleanPropertyDto.md deleted file mode 100644 index 9d505a3..0000000 --- a/sdk/docs/MapiBooleanPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiBooleanPropertyDto - -Mapi property with Boolean value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**bool** |Property value | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarApi.md b/sdk/docs/MapiCalendarApi.md deleted file mode 100644 index 5d62b9e..0000000 --- a/sdk/docs/MapiCalendarApi.md +++ /dev/null @@ -1,617 +0,0 @@ -# AsposeEmailCloudSdk.MapiCalendarApi (EmailCloud.mapi.calendar) - -MAPI calendar operations. - - -## as_calendar_dto - -Description: Converts MAPI calendar model to CalendarDto model. - -Returns: CalendarDto model. - -Method call example: -```python -result = api.mapi.calendar.as_calendar_dto(mapi_calendar_dto) -``` - -### Parameter: mapi_calendar_dto - -Description: MAPI calendar model to convert. - -See parameter model documentation at [MapiCalendarDto](MapiCalendarDto.md) - -
- Parameter initialization example: - -```python -mapi_calendar_dto = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` - -
- -### Result - -Description: CalendarDto model. - -Return type: [**CalendarDto**](CalendarDto.md) - -
- Result example - -```python -result = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -mapi_calendar_dto = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') - -// Call method: -result = api.mapi.calendar.as_calendar_dto(mapi_calendar_dto) - -// Result example: -result = models.CalendarDto( - attendees=[ - models.MailAddress( - display_name='Attendee Name', - address='attendee@aspose.com', - participation_status='Accepted')], - description='Some description', - end_date=datetime.today(), - location='Some location', - organizer=models.MailAddress( - display_name='Organizer Name', - address='organizer@aspose.com'), - recurrence=models.DailyRecurrencePatternDto( - interval=-1, - occurs=10, - week_start='Monday'), - start_date=datetime.today(), - summary='Some summary') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_file - -Description: Converts MAPI calendar model to specified format and returns as file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.mapi.calendar.as_file(request) -``` - -### Parameter: request - -Description: MAPI calendar model to convert. - -See parameter model documentation at [MapiCalendarAsFileRequest](MapiCalendarAsFileRequest.md) - -
- Parameter initialization example: - -```python -request = models.MapiCalendarAsFileRequest( - format='Msg', - value=models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary')) -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiCalendarAsFileRequest( - format='Msg', - value=models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary')) - -// Call method: -result = api.mapi.calendar.as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## from_file - -Description: Converts calendar file to a MAPI model representation. - -Returns: MAPI model. - -Method call example: -```python -result = api.mapi.calendar.from_file(request) -``` - -### Parameter: request - -Description: from_file method request. - -See parameter model documentation at [MapiCalendarFromFileRequest](MapiCalendarFromFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.MapiCalendarFromFileRequest( - file='/path/to/calendar.msg') -``` - -
- -### Result - -Description: MAPI model. - -Return type: [**MapiCalendarDto**](MapiCalendarDto.md) - -
- Result example - -```python -result = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiCalendarFromFileRequest( - file='/path/to/calendar.msg') - -// Call method: -result = api.mapi.calendar.from_file(request) - -// Result example: -result = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get - -Description: Get MAPI calendar document. - -Returns: MAPI Calendar model. - -Method call example: -```python -result = api.mapi.calendar.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [MapiCalendarGetRequest](MapiCalendarGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.MapiCalendarGetRequest( - file_name='calendar.msg', - folder='calendar/location/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: MAPI Calendar model. - -Return type: [**MapiCalendarDto**](MapiCalendarDto.md) - -
- Result example - -```python -result = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiCalendarGetRequest( - file_name='calendar.msg', - folder='calendar/location/on/storage', - storage='First Storage') - -// Call method: -result = api.mapi.calendar.get(request) - -// Result example: -result = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Save MAPI Calendar to storage. - -Method call example: -```python -api.mapi.calendar.save(request) -``` - -### Parameter: request - -Description: Calendar create/update request. - -See parameter model documentation at [MapiCalendarSaveRequest](MapiCalendarSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.MapiCalendarSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='calendar.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiCalendarSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='calendar.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary')) - -// Call method: -api.mapi.calendar.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarApi_list.md b/sdk/docs/MapiCalendarApi_list.md deleted file mode 100644 index ce840a7..0000000 --- a/sdk/docs/MapiCalendarApi_list.md +++ /dev/null @@ -1,11 +0,0 @@ -## Documentation for MapiCalendarApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**as_calendar_dto**](MapiCalendarApi.md#as_calendar_dto)| **PUT** /email/MapiCalendar/as-calendar-dto| Converts MAPI calendar model to CalendarDto model. -[**as_file**](MapiCalendarApi.md#as_file)| **PUT** /email/MapiCalendar/as-file| Converts MAPI calendar model to specified format and returns as file. -[**from_file**](MapiCalendarApi.md#from_file)| **PUT** /email/MapiCalendar/from-file| Converts calendar file to a MAPI model representation. -[**get**](MapiCalendarApi.md#get)| **GET** /email/MapiCalendar| Get MAPI calendar document. -[**save**](MapiCalendarApi.md#save)| **PUT** /email/MapiCalendar| Save MAPI Calendar to storage. diff --git a/sdk/docs/MapiCalendarAsFileRequest.md b/sdk/docs/MapiCalendarAsFileRequest.md deleted file mode 100644 index c5dbccd..0000000 --- a/sdk/docs/MapiCalendarAsFileRequest.md +++ /dev/null @@ -1,49 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarAsFileRequest - -Convert MapiCalendar to file request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Calendar file format Enum, available values: Ics, Msg | -**value** |[**MapiCalendarDto**](MapiCalendarDto.md) |MAPI calendar model. | - - - -## Example -```python -mapi_calendar_as_file_request = models.MapiCalendarAsFileRequest( - format='Msg', - value=models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarAttendeesDto.md b/sdk/docs/MapiCalendarAttendeesDto.md deleted file mode 100644 index 3e1b0fb..0000000 --- a/sdk/docs/MapiCalendarAttendeesDto.md +++ /dev/null @@ -1,17 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarAttendeesDto - -Mapi calendar attendees. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**appointment_recipients** |[**list[MapiRecipientDto]**](MapiRecipientDto.md) |List of attendees. |[optional] -**appointment_unsendable_recipients** |[**list[MapiRecipientDto]**](MapiRecipientDto.md) |List of unsendable attendees. |[optional] -**not_allow_propose** |**bool** |Value indicating whether attendees are not allowed to propose a new date and/or time for the meeting. | -**response_requested** |**bool** |Value indicating whether a response is requested to a Message object. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md b/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md deleted file mode 100644 index 7e779ea..0000000 --- a/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarDailyRecurrencePatternDto - -Represents the daily recurrence pattern of the mapi calendar. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**day_of_week** |**list[str]** |Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday |[optional] - -Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarDto.md b/sdk/docs/MapiCalendarDto.md deleted file mode 100644 index 901f2ab..0000000 --- a/sdk/docs/MapiCalendarDto.md +++ /dev/null @@ -1,64 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarDto - -Represents the mapi calendar object - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**appointment_counter_proposal** |**bool** |Value indicating whether a Meeting Response object is a counter proposal. | -**attendees** |[**MapiCalendarAttendeesDto**](MapiCalendarAttendeesDto.md) |Attendees |[optional] -**busy_status** |**str** |Enumerates the mapi calendar possible busy status Enum, available values: Free, Tentative, Busy, OutOfOffice | -**client_intent** |**list[str]** |Actions the user has taken on this Meeting object. Items: Enumerates the actions the user can taken on the Meeting object Enum, available values: Manager, Delegate, DeletedWithNoResponse, DeletedExceptionWithNoResponse, RespondedTentative, RespondedAccept, RespondedDecline, ModifiedStartTime, ModifiedEndTime, ModifiedLocation, RespondedExceptionDecline, Canceled, ExceptionCanceled |[optional] -**end_date** |**datetime** |End date and time of the event. If the date is not set, default value for DateTime is returned. | -**end_date_time_zone** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information that indicates the time zone of the EndDate property. |[optional] -**is_all_day** |**bool** |Value indicating whether the event is an all-day event. | -**key_words** |**str** |Categories of the calendar object. |[optional] -**location** |**str** |Location of the event. |[optional] -**recurrence** |[**MapiCalendarEventRecurrenceDto**](MapiCalendarEventRecurrenceDto.md) |Recurrence properties. |[optional] -**reminder_delta** |**int** |Interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object. | -**reminder_file_parameter** |**str** |Full path of the sound that a client SHOULD play when the reminder becomes overdue. |[optional] -**reminder_set** |**bool** |Value indicating whether a reminder is set on the object. | -**sequence** |**int** |Sequence number. | -**start_date** |**datetime** |Start date and time of the event. If the date is not set, default value for DateTime is returned. | -**start_date_time_zone** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information that indicates the time zone of the StartDate property. |[optional] -**uid** |**str** |Unique identifier. |[optional] -**organizer** |[**MapiElectronicAddressDto**](MapiElectronicAddressDto.md) |Organizer |[optional] - -Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) - - -## Example -```python -mapi_calendar_dto = models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarEventRecurrenceDto.md b/sdk/docs/MapiCalendarEventRecurrenceDto.md deleted file mode 100644 index 00ba3e0..0000000 --- a/sdk/docs/MapiCalendarEventRecurrenceDto.md +++ /dev/null @@ -1,19 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarEventRecurrenceDto - -Recurrence properties of calendar object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**appointment_time_zone_definition_recur** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information that describes how to convert the meeting date and time on a recurring series to and from UTC. |[optional] -**clip_end** |**datetime** |Date of the last instance. | -**clip_start** |**datetime** |Date of the first instance. | -**is_exception** |**bool** |Value indicating whether the object represents an exception. | -**recurrence_pattern** |[**MapiCalendarRecurrencePatternDto**](MapiCalendarRecurrencePatternDto.md) |Recurrence pattern. |[optional] -**time_zone_struct** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information for a recurring meeting. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarExceptionInfoDto.md b/sdk/docs/MapiCalendarExceptionInfoDto.md deleted file mode 100644 index 51d4943..0000000 --- a/sdk/docs/MapiCalendarExceptionInfoDto.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarExceptionInfoDto - -An exception specifies changes to an instance of a recurring series. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachments** |[**list[MapiAttachmentDto]**](MapiAttachmentDto.md) |Attachments in the recurrence exception. |[optional] -**body** |**str** |Body. |[optional] -**busy_status** |**str** |Enumerates the mapi calendar possible busy status Enum, available values: Free, Tentative, Busy, OutOfOffice | -**end_date_time** |**datetime** |End date. | -**has_attachment** |**bool** |Value of this field specifies whether the Exception Embedded Message object contains attachments. | -**location** |**str** |Location. |[optional] -**meeting_type** |**str** |Enumerates the appointment state Enum, available values: Meeting, Received, Canceled | -**original_start_date** |**datetime** |Original start date. | -**override_flags** |**list[str]** |Override flags. Items: Specifies what data in the MapiCalendarOverride structure has a value different from the recurring series. Enum, available values: Subject, MeetingType, ReminderDelta, Reminder, Location, BusyStatus, Attachment, Subtype, AppointmentColor, ExceptionalBody |[optional] -**reminder_delta** |**int** |Reminder delta. | -**reminder_set** |**bool** |Value for the PidLidReminderSet property. | -**start_date_time** |**datetime** |Start date. | -**subject** |**str** |Subject. |[optional] -**sub_type** |**int** |SubType. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarFromFileRequest.md b/sdk/docs/MapiCalendarFromFileRequest.md deleted file mode 100644 index d02d228..0000000 --- a/sdk/docs/MapiCalendarFromFileRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# MapiCalendarFromFileRequest - -Request model for MapiCalendarApi.from_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file** |**str** |File to convert | - -## Example -```python -request = models.MapiCalendarFromFileRequest( - file='/path/to/calendar.msg') -``` diff --git a/sdk/docs/MapiCalendarGetRequest.md b/sdk/docs/MapiCalendarGetRequest.md deleted file mode 100644 index dd1a32f..0000000 --- a/sdk/docs/MapiCalendarGetRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# MapiCalendarGetRequest - -Request model for MapiCalendarApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**file_name** |**str** |Calendar file name in storage. | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.MapiCalendarGetRequest( - file_name='calendar.msg', - folder='calendar/location/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/MapiCalendarRecurrencePatternDto.md b/sdk/docs/MapiCalendarRecurrencePatternDto.md deleted file mode 100644 index b9c1ba3..0000000 --- a/sdk/docs/MapiCalendarRecurrencePatternDto.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarRecurrencePatternDto - -Mapi recurrence pattern. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**calendar_type** |**str** |Enumerated the calendar type of the mapi recurrence Enum, available values: Default, CalGregorian, CalGregorianUs, CalJapan, CalTaiwan, CalKorea, CalHijri, CalThai, CalHebrew, CalGregorianMeFrench, CalGregorianArabic, CalGregorianXLitEnglish, CalGregorianXLitFrench, CalLunarJapanese, CalChineseLunar, CalSaka, CalLunarEtoChn, CalLunarEtoKor, CalLunarRokuyou, CalLunarKorean, CalUmAlQura | -**deleted_instance_dates** |**list[datetime]** |An array of dates, each of which is the original instance date of either a deleted instance or a modified instance for this recurrence. |[optional] -**end_date** |**datetime** |End date of an item recurrence pattern. | -**end_type** |**str** |Enumerates the ending type for the recurrence. Enum, available values: None, EndAfterDate, EndAfterNOccurrences, NeverEnd | -**exceptions** |[**list[MapiCalendarExceptionInfoDto]**](MapiCalendarExceptionInfoDto.md) |An exception specifies changes to an instance of a recurring series. |[optional] -**frequency** |**str** |Enumerates mapi calendar recurrence frequency Enum, available values: None, Daily, Weekly, Monthly, Yearly | -**modified_instance_dates** |**list[datetime]** |An array of dates, each of which is the date of a modified instance. |[optional] -**occurrence_count** |**int** |Number of occurrences in a recurrence. | -**pattern_type** |**str** |Enumerates the mapi calendar recurrence pattern types Enum, available values: Day, Week, Month, MonthEnd, MonthNth, HjMonth, HjMonthNth, HjMonthEnd | -**period** |**int** |Interval at which the meeting pattern repeats. | -**sliding_flag** |**bool** |Defines whether pattern is sliding or not. | -**start_date** |**datetime** |Start date of an item recurrence pattern. | -**week_start_day** |**str** |Day of week. Enum, available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | -**discriminator** |**str** | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarSaveRequest.md b/sdk/docs/MapiCalendarSaveRequest.md deleted file mode 100644 index bdc9d4b..0000000 --- a/sdk/docs/MapiCalendarSaveRequest.md +++ /dev/null @@ -1,53 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarSaveRequest - -Save MapiCalendar to storage request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Calendar file format Enum, available values: Ics, Msg | - -Parent class: [StorageModelOfMapiCalendarDto](StorageModelOfMapiCalendarDto.md) - - -## Example -```python -mapi_calendar_save_request = models.MapiCalendarSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='calendar.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiCalendarDto( - attendees=models.MapiCalendarAttendeesDto( - appointment_recipients=[ - models.MapiRecipientDto( - email_address='organizer@aspose.com', - address_type='SMTP', - display_name='Organizer Name', - recipient_type='MapiTo'), - models.MapiRecipientDto( - email_address='attendee@aspose.com', - address_type='SMTP', - display_name='Attendee Name', - recipient_type='MapiTo')]), - busy_status='Tentative', - client_intent=[ - 'Manager'], - end_date=datetime.today(), - location='Some location', - recurrence=models.MapiCalendarEventRecurrenceDto( - recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( - frequency='Daily', - occurrence_count=10, - week_start_day='Monday')), - start_date=datetime.today(), - organizer=models.MapiElectronicAddressDto( - email_address='organizer@aspose.com'), - body='Some description', - subject='Some summary')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarTimeZoneDto.md b/sdk/docs/MapiCalendarTimeZoneDto.md deleted file mode 100644 index ba5f47a..0000000 --- a/sdk/docs/MapiCalendarTimeZoneDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarTimeZoneDto - -Represents the mapi calendar time zone information. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key_name** |**str** |Human-readable description of the time zone. |[optional] -**time_zone_rules** |[**list[MapiCalendarTimeZoneInfoDto]**](MapiCalendarTimeZoneInfoDto.md) |Time zone rules |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarTimeZoneInfoDto.md b/sdk/docs/MapiCalendarTimeZoneInfoDto.md deleted file mode 100644 index 0856b46..0000000 --- a/sdk/docs/MapiCalendarTimeZoneInfoDto.md +++ /dev/null @@ -1,20 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarTimeZoneInfoDto - -Represents the mapi calendar time zone rule. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bias** |**int** |Time zone's offset in minutes from UTC. | -**daylight_bias** |**int** |Offset in minutes from lBias during daylight saving time. | -**daylight_date** |[**MapiCalendarTimeZoneRuleDto**](MapiCalendarTimeZoneRuleDto.md) |Date and local time that indicate when to begin using the DaylightBias. |[optional] -**standard_bias** |**int** |Offset in minutes from lBias during standard time. | -**standard_date** |[**MapiCalendarTimeZoneRuleDto**](MapiCalendarTimeZoneRuleDto.md) |Date and local time that indicate when to begin using the StandardBias. |[optional] -**time_zone_flags** |**list[str]** |Individual bit flags that specify information about this TimeZoneRule. Items: Enumerates the individual bit flags that specify information about TimeZoneRule Enum, available values: TzRuleFlagRecurCurrentTzReg, TzRuleFlagEffectiveTzReg |[optional] -**year** |**int** |Year in which this rule is scheduled to take effect. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarTimeZoneRuleDto.md b/sdk/docs/MapiCalendarTimeZoneRuleDto.md deleted file mode 100644 index 5ab6efb..0000000 --- a/sdk/docs/MapiCalendarTimeZoneRuleDto.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarTimeZoneRuleDto - -Represents time zone rule that indicate when to begin using the Standard/Daylight time. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_date** |**datetime** |Date and time that indicate when to begin using the Standard/Daylight time. | -**day_of_week** |**str** |Day of week. Enum, available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | -**hour** |**int** |Hour. | -**milliseconds** |**int** |Milliseconds. | -**minute** |**int** |Minute. | -**month** |**int** |Month. | -**position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | -**seconds** |**int** |Seconds. | -**year** |**int** |Year. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md b/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md deleted file mode 100644 index f3f30e0..0000000 --- a/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarWeeklyRecurrencePatternDto - -Represents the weekly recurrence pattern of the mapi calendar - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**day_of_week** |**list[str]** |Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday |[optional] - -Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md b/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md deleted file mode 100644 index f5f23a4..0000000 --- a/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md +++ /dev/null @@ -1,17 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiCalendarYearlyAndMonthlyRecurrencePatternDto - -Represents the yearly and monthly recurrence pattern of the mapi calendar - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**day** |**int** |Day of the month on which the recurrence falls. | -**day_of_week** |**list[str]** |Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday |[optional] -**position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | - -Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactApi.md b/sdk/docs/MapiContactApi.md deleted file mode 100644 index 7a48042..0000000 --- a/sdk/docs/MapiContactApi.md +++ /dev/null @@ -1,495 +0,0 @@ -# AsposeEmailCloudSdk.MapiContactApi (EmailCloud.mapi.contact) - -MAPI contact operations - - -## as_contact_dto - -Description: Converts MAPI contact model to ContactDto model. - -Returns: Contact model. - -Method call example: -```python -result = api.mapi.contact.as_contact_dto(mapi_contact_dto) -``` - -### Parameter: mapi_contact_dto - -Description: MAPI contact model to convert. - -See parameter model documentation at [MapiContactDto](MapiContactDto.md) - -
- Parameter initialization example: - -```python -mapi_contact_dto = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` - -
- -### Result - -Description: Contact model. - -Return type: [**ContactDto**](ContactDto.md) - -
- Result example - -```python -result = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -mapi_contact_dto = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) - -// Call method: -result = api.mapi.contact.as_contact_dto(mapi_contact_dto) - -// Result example: -result = models.ContactDto( - attachments=[ - models.Attachment( - name='attachment.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - display_name='Alex Thomas', - email_addresses=[ - models.EmailAddress( - category=models.EnumWithCustomOfEmailAddressCategory( - value='Custom', - description='Partners'), - display_name='Alex Thomas Partners', - preferred=True, - address='email@aspose.com')], - gender='Male', - given_name='Alex', - phone_numbers=[ - models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Office'), - number='+49 211 4247 21', - preferred=True)], - profession='GENERAL DIRECTOR', - surname='Thomas', - urls=[ - models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='www.aspose.com')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_file - -Description: Converts MAPI contact model to specified format and returns as file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.mapi.contact.as_file(request) -``` - -### Parameter: request - -Description: MAPI contact model to convert. - -See parameter model documentation at [MapiContactAsFileRequest](MapiContactAsFileRequest.md) - -
- Parameter initialization example: - -```python -request = models.MapiContactAsFileRequest( - format='Msg', - value=models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21'))) -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiContactAsFileRequest( - format='Msg', - value=models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21'))) - -// Call method: -result = api.mapi.contact.as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## from_file - -Description: Converts contact file to a MAPI model representation. - -Returns: MAPI model - -Method call example: -```python -result = api.mapi.contact.from_file(request) -``` - -### Parameter: request - -Description: from_file method request. - -See parameter model documentation at [MapiContactFromFileRequest](MapiContactFromFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.MapiContactFromFileRequest( - format='Msg', - file='/path/to/contact.msg') -``` - -
- -### Result - -Description: MAPI model - -Return type: [**MapiContactDto**](MapiContactDto.md) - -
- Result example - -```python -result = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiContactFromFileRequest( - format='Msg', - file='/path/to/contact.msg') - -// Call method: -result = api.mapi.contact.from_file(request) - -// Result example: -result = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get - -Description: Get MAPI contact document. - -Returns: Contact model. - -Method call example: -```python -result = api.mapi.contact.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [MapiContactGetRequest](MapiContactGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.MapiContactGetRequest( - format='VCard', - file_name='contact.vcf', - folder='folder/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: Contact model. - -Return type: [**MapiContactDto**](MapiContactDto.md) - -
- Result example - -```python -result = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiContactGetRequest( - format='VCard', - file_name='contact.vcf', - folder='folder/on/storage', - storage='First Storage') - -// Call method: -result = api.mapi.contact.get(request) - -// Result example: -result = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Save MAPI Contact to storage. - -Method call example: -```python -api.mapi.contact.save(request) -``` - -### Parameter: request - -Description: Create/Update contact request. - -See parameter model documentation at [MapiContactSaveRequest](MapiContactSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.MapiContactSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='contact.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21'))) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiContactSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='contact.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21'))) - -// Call method: -api.mapi.contact.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactApi_list.md b/sdk/docs/MapiContactApi_list.md deleted file mode 100644 index 31d5186..0000000 --- a/sdk/docs/MapiContactApi_list.md +++ /dev/null @@ -1,11 +0,0 @@ -## Documentation for MapiContactApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**as_contact_dto**](MapiContactApi.md#as_contact_dto)| **PUT** /email/MapiContact/as-contact-dto| Converts MAPI contact model to ContactDto model. -[**as_file**](MapiContactApi.md#as_file)| **PUT** /email/MapiContact/as-file| Converts MAPI contact model to specified format and returns as file. -[**from_file**](MapiContactApi.md#from_file)| **PUT** /email/MapiContact/from-file| Converts contact file to a MAPI model representation. -[**get**](MapiContactApi.md#get)| **GET** /email/MapiContact| Get MAPI contact document. -[**save**](MapiContactApi.md#save)| **PUT** /email/MapiContact| Save MAPI Contact to storage. diff --git a/sdk/docs/MapiContactAsFileRequest.md b/sdk/docs/MapiContactAsFileRequest.md deleted file mode 100644 index a44906b..0000000 --- a/sdk/docs/MapiContactAsFileRequest.md +++ /dev/null @@ -1,34 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactAsFileRequest - -Convert MapiContact to file request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | -**value** |[**MapiContactDto**](MapiContactDto.md) |MAPI contact model. | - - - -## Example -```python -mapi_contact_as_file_request = models.MapiContactAsFileRequest( - format='Msg', - value=models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21'))) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactDto.md b/sdk/docs/MapiContactDto.md deleted file mode 100644 index 7ec3dfa..0000000 --- a/sdk/docs/MapiContactDto.md +++ /dev/null @@ -1,40 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactDto - -Represents outlook contact information. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**electronic_addresses** |[**MapiContactElectronicAddressPropertySetDto**](MapiContactElectronicAddressPropertySetDto.md) |Specify properties for up to three different e-mail addresses and three different fax addresses. |[optional] -**events** |[**MapiContactEventPropertySetDto**](MapiContactEventPropertySetDto.md) |Specify events associated with a contact. |[optional] -**name_info** |[**MapiContactNamePropertySetDto**](MapiContactNamePropertySetDto.md) |The properties are used to specify the name of the person represented by the contact. |[optional] -**other_fields** |[**MapiContactOtherPropertySetDto**](MapiContactOtherPropertySetDto.md) |Specify other fields of contact. |[optional] -**personal_info** |[**MapiContactPersonalInfoPropertySetDto**](MapiContactPersonalInfoPropertySetDto.md) |Specify other additional contact information. |[optional] -**photo** |[**MapiContactPhotoDto**](MapiContactPhotoDto.md) |Contact photo. |[optional] -**physical_addresses** |[**MapiContactPhysicalAddressPropertySetDto**](MapiContactPhysicalAddressPropertySetDto.md) |Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address. |[optional] -**professional_info** |[**MapiContactProfessionalPropertySetDto**](MapiContactProfessionalPropertySetDto.md) |Properties are used to store professional details for the person represented by the contact. |[optional] -**telephones** |[**MapiContactTelephonePropertySetDto**](MapiContactTelephonePropertySetDto.md) |Specify telephone numbers for the contact. |[optional] - -Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) - - -## Example -```python -mapi_contact_dto = models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactElectronicAddressDto.md b/sdk/docs/MapiContactElectronicAddressDto.md deleted file mode 100644 index 44a0971..0000000 --- a/sdk/docs/MapiContactElectronicAddressDto.md +++ /dev/null @@ -1,19 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactElectronicAddressDto - -Refers to the group of properties that define the e-mail address or fax address for a contact. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address_type** |**str** |Address type of an electronic address |[optional] -**display_name** |**str** |User-readable display name for the e-mail address |[optional] -**email_address** |**str** |E-mail address of the contact |[optional] -**fax_number** |**str** |Telephone number of the mail user's primary fax machine |[optional] -**is_empty** |**bool** |Shows if MapiContactElectronicAddress is empty | -**original_display_name** |**str** |SMTP e-mail address that corresponds to the e-mail address for the Contact object. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactElectronicAddressPropertySetDto.md b/sdk/docs/MapiContactElectronicAddressPropertySetDto.md deleted file mode 100644 index 3cb8c4e..0000000 --- a/sdk/docs/MapiContactElectronicAddressPropertySetDto.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactElectronicAddressPropertySetDto - -Specify properties for up to three different e-mail addresses (Email1, Email2, and Email3) and three different fax addresses (Primary Fax, Business Fax, and Home Fax) - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**business_fax** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the business fax address for a contact. |[optional] -**default_email_address** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Default value of electronic address Uses when user does not set any electronic address if UseAutocomplete property is set 'true' |[optional] -**email1** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the first e-mail address for a contact. |[optional] -**email2** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the second e-mail address for a contact. |[optional] -**email3** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the third e-mail address for a contact. |[optional] -**home_fax** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the home fax address for a contact. |[optional] -**is_empty** |**bool** |Shows if MapiContactElectronicAddressPropertySetDto is empty | -**primary_fax** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the primary fax address for a contact. |[optional] -**use_autocomplete** |**bool** |Indicates that one electronic address is completed automatically in case if user does not set any electronic address | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactEventPropertySetDto.md b/sdk/docs/MapiContactEventPropertySetDto.md deleted file mode 100644 index 91435e0..0000000 --- a/sdk/docs/MapiContactEventPropertySetDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactEventPropertySetDto - -Specify events associated with a contact. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**birthday** |**datetime** |Specifies the birthday of the contact. | -**wedding_anniversary** |**datetime** |Specifies the wedding anniversary of the contact. | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactFromFileRequest.md b/sdk/docs/MapiContactFromFileRequest.md deleted file mode 100644 index 111d841..0000000 --- a/sdk/docs/MapiContactFromFileRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# MapiContactFromFileRequest - -Request model for MapiContactApi.from_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |File format Enum, available values: VCard, WebDav, Msg | -**file** |**str** |File to convert | - -## Example -```python -request = models.MapiContactFromFileRequest( - format='Msg', - file='/path/to/contact.msg') -``` diff --git a/sdk/docs/MapiContactGetRequest.md b/sdk/docs/MapiContactGetRequest.md deleted file mode 100644 index daae3f0..0000000 --- a/sdk/docs/MapiContactGetRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# MapiContactGetRequest - -Request model for MapiContactApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |Contact document format. Enum, available values: VCard, WebDav, Msg | -**file_name** |**str** |Contact document file name. | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.MapiContactGetRequest( - format='VCard', - file_name='contact.vcf', - folder='folder/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/MapiContactNamePropertySetDto.md b/sdk/docs/MapiContactNamePropertySetDto.md deleted file mode 100644 index 7990edf..0000000 --- a/sdk/docs/MapiContactNamePropertySetDto.md +++ /dev/null @@ -1,23 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactNamePropertySetDto - -The properties are used to specify the name of the person represented by the contact - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** |**str** |Full name of the contact |[optional] -**display_name_prefix** |**str** |Title of the contact |[optional] -**file_under** |**str** |Name under which to file this contact when displaying a list of contacts |[optional] -**file_under_id** |**int** |Value specifying how to generate and recompute the property when other properties are changed | -**generation** |**str** |Generation suffix of the contact |[optional] -**given_name** |**str** |Given name (first name) of the contact |[optional] -**initials** |**str** |Initials of the contact |[optional] -**middle_name** |**str** |Middle name of the contact |[optional] -**nickname** |**str** |Nickname of the contact |[optional] -**surname** |**str** |Surname (family name) of the contact |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactOtherPropertySetDto.md b/sdk/docs/MapiContactOtherPropertySetDto.md deleted file mode 100644 index 9aeb8f0..0000000 --- a/sdk/docs/MapiContactOtherPropertySetDto.md +++ /dev/null @@ -1,21 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactOtherPropertySetDto - -The properties are used to specify additional properties of contact. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**private** |**bool** |Indicates whether the end-user wants this message object hidden from other users who have access to the message object. | -**journal** |**bool** |Specifies whether to create a journal for each action associated with this contact. | -**reminder_time** |**datetime** |Specifies the initial signal time for a reminder. | -**reminder_topic** |**str** |Represents the status of a meeting request. |[optional] -**user_field1** |**str** |Specifies the first field on the contact that is intended for miscellaneous use for the contact. |[optional] -**user_field2** |**str** |Specifies the second field on the contact that is intended for miscellaneous use for the contact. |[optional] -**user_field3** |**str** |Specifies the third field on the contact that is intended for miscellaneous use for the contact. |[optional] -**user_field4** |**str** |Specifies the forth field on the contact that is intended for miscellaneous use for the contact. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactPersonalInfoPropertySetDto.md b/sdk/docs/MapiContactPersonalInfoPropertySetDto.md deleted file mode 100644 index f1a0930..0000000 --- a/sdk/docs/MapiContactPersonalInfoPropertySetDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactPersonalInfoPropertySetDto - -Specify other additional contact information. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spouse_name** |**str** |Specifies the name of the contact's spouse/partner |[optional] -**personal_home_page** |**str** |Specifies the contact's personal web page URL |[optional] -**language** |**str** |Specifies the language that the contact uses |[optional] -**notes** |**str** |Specifies the additional notes |[optional] -**hobbies** |**str** |Specifies the hobbies of the contact |[optional] -**location** |**str** |Specifies the location of the contact |[optional] -**instant_messaging_address** |**str** |Specifies the contact's instant messaging address |[optional] -**organizational_id_number** |**str** |Specifies an organizational ID number for the contact |[optional] -**customer_id** |**str** |Specifies the contact's customer ID number |[optional] -**government_id_number** |**str** |Specifies the contact's government ID number |[optional] -**free_busy_location** |**str** |Specifies a URL path from which a client can retrieve free/busy information for the contact as an iCal file |[optional] -**account** |**str** |Specifies the account name of the contact |[optional] -**html** |**str** |Specifies the contact's business web page URL |[optional] -**business_home_page** |**str** |Specifies the contact's business web page URL |[optional] -**ftp_site** |**str** |Specifies the contact's File Transfer Protocol (FTP) URL |[optional] -**computer_network_name** |**str** |Specifies the name of the network to which the contact's computer is connected |[optional] -**gender** |**str** |Gender of the contact Enum, available values: Unspecified, Female, Male | -**referred_by_name** |**str** |Specifies the name of the person who referred this contact to the user |[optional] -**children** |**list[str]** |Contains a list of names of children. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactPhotoDto.md b/sdk/docs/MapiContactPhotoDto.md deleted file mode 100644 index 4df3714..0000000 --- a/sdk/docs/MapiContactPhotoDto.md +++ /dev/null @@ -1,14 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactPhotoDto - -Contains data and type of contact's photo. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ContactPhoto](ContactPhoto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactPhysicalAddressDto.md b/sdk/docs/MapiContactPhysicalAddressDto.md deleted file mode 100644 index 0f2323a..0000000 --- a/sdk/docs/MapiContactPhysicalAddressDto.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactPhysicalAddressDto - -Refers to the group of properties that define physical address for a contact. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**is_mailing_address** |**bool** |Gets or sets a value indicating whether this address is mailing address | -**street** |**str** |Specifies the street portion of the contact's address |[optional] -**city** |**str** |Specifies the city or locality portion of the contact's address |[optional] -**state_or_province** |**str** |Specifies the state or province portion of the contact's address |[optional] -**postal_code** |**str** |Specifies the postal code (ZIP code) portion of the contact's address |[optional] -**country** |**str** |Specifies the country or region portion of the contact's address |[optional] -**country_code** |**str** |Specifies the country code portion of the contact's address |[optional] -**address** |**str** |Specifies the complete address of the contact's address |[optional] -**post_office_box** |**str** |Gets or sets the post office box |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md b/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md deleted file mode 100644 index 3ebda74..0000000 --- a/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactPhysicalAddressPropertySetDto - -Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**work_address** |[**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) |Specifies the address of the contact's work |[optional] -**home_address** |[**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) |Specifies the address of the contact's home |[optional] -**other_address** |[**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) |Specifies the other contact's address |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactProfessionalPropertySetDto.md b/sdk/docs/MapiContactProfessionalPropertySetDto.md deleted file mode 100644 index fecf060..0000000 --- a/sdk/docs/MapiContactProfessionalPropertySetDto.md +++ /dev/null @@ -1,20 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactProfessionalPropertySetDto - -Properties are used to store professional details for the person represented by the contact - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**title** |**str** |Gets or sets the job title of the contact |[optional] -**company_name** |**str** |Gets or sets the company that employs the contact |[optional] -**department_name** |**str** |Gets or sets the name of the department to which the contact belongs |[optional] -**office_location** |**str** |Gets or sets the location of the office that the contact works in |[optional] -**manager_name** |**str** |Gets or sets the name of the contact's manager |[optional] -**assistant** |**str** |Gets or sets the name of the contact's assistant |[optional] -**profession** |**str** |Gets or sets the profession of the contact |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactSaveRequest.md b/sdk/docs/MapiContactSaveRequest.md deleted file mode 100644 index d7c48b9..0000000 --- a/sdk/docs/MapiContactSaveRequest.md +++ /dev/null @@ -1,38 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactSaveRequest - -MapiContact save to storage request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | - -Parent class: [StorageModelOfMapiContactDto](StorageModelOfMapiContactDto.md) - - -## Example -```python -mapi_contact_save_request = models.MapiContactSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='contact.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiContactDto( - electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( - default_email_address=models.MapiContactElectronicAddressDto( - email_address='email@aspose.com')), - name_info=models.MapiContactNamePropertySetDto( - given_name='Alex', - surname='Thomas'), - personal_info=models.MapiContactPersonalInfoPropertySetDto( - business_home_page='www.aspose.com'), - professional_info=models.MapiContactProfessionalPropertySetDto( - profession='GENERAL DIRECTOR'), - telephones=models.MapiContactTelephonePropertySetDto( - primary_telephone_number='+49 211 4247 21'))) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiContactTelephonePropertySetDto.md b/sdk/docs/MapiContactTelephonePropertySetDto.md deleted file mode 100644 index 0d3bbbb..0000000 --- a/sdk/docs/MapiContactTelephonePropertySetDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiContactTelephonePropertySetDto - -Specify optional telephone numbers for the contact. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**is_empty** |**bool** |Shows if MapiContactTelephonePropertySet is empty | -**default_telephone_number** |**str** |Default value of electronic address Uses when user does not set any electronic address if UseAutocomplete property is set 'true' |[optional] -**use_autocomplete** |**bool** |Indicates that one electronic address is completed automatically in case if user does not set any electronic address | -**callback_telephone_number** |**str** |Gets or sets the callback telephone number |[optional] -**business_telephone_number** |**str** |Gets or sets the business telephone number |[optional] -**home_telephone_number** |**str** |Gets or sets the home telephone number |[optional] -**primary_telephone_number** |**str** |Gets or sets the primary telephone number |[optional] -**business2_telephone_number** |**str** |Gets or sets the second business telephone number |[optional] -**mobile_telephone_number** |**str** |Gets or sets the mobile telephone number |[optional] -**radio_telephone_number** |**str** |Gets or sets the radio telephone number |[optional] -**car_telephone_number** |**str** |Gets or sets the car telephone number |[optional] -**other_telephone_number** |**str** |Gets or sets an alternate telephone number |[optional] -**assistant_telephone_number** |**str** |Gets or sets the telephone number of the contact's assistant |[optional] -**home2_telephone_number** |**str** |Gets or sets a second home telephone number |[optional] -**tty_tdd_phone_number** |**str** |Gets or sets the telephone number for the contact's text telephone (TTY) or telecommunication device for the deaf (TDD) |[optional] -**company_main_telephone_number** |**str** |Gets or sets the company phone number |[optional] -**telex_number** |**str** |Gets or sets the telex number |[optional] -**isdn_number** |**str** |Gets or sets the integrated services digital network (ISDN) number |[optional] -**pager_telephone_number** |**str** |Gets or sets a pager telephone number |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiDateTimePropertyDto.md b/sdk/docs/MapiDateTimePropertyDto.md deleted file mode 100644 index 8261434..0000000 --- a/sdk/docs/MapiDateTimePropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiDateTimePropertyDto - -Mapi property with DateTime value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**datetime** |Property value | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiElectronicAddressDto.md b/sdk/docs/MapiElectronicAddressDto.md deleted file mode 100644 index 962ad71..0000000 --- a/sdk/docs/MapiElectronicAddressDto.md +++ /dev/null @@ -1,18 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiElectronicAddressDto - -Refers to the group of properties that define the e-mail address or fax address. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address_type** |**str** |Address type. |[optional] -**email_address** |**str** |Email address. |[optional] -**display_name** |**str** |User-readable display name for the e-mail address. |[optional] -**fax_number** |**str** |Telephone number of the mail user's primary fax machine. |[optional] -**original_display_name** |**str** |SMTP e-mail address that corresponds to the e-mail address. |[optional] - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiFileAsPropertyDto.md b/sdk/docs/MapiFileAsPropertyDto.md deleted file mode 100644 index fb1e929..0000000 --- a/sdk/docs/MapiFileAsPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiFileAsPropertyDto - -Mapi property with FileAsMapping value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Defines how to construct what is displayed for a contact in the FileAs property. Enum, available values: None, LastCommaFirst, FirstSpaceLast, Company, LastCommaFirstCompany, CompanyLastFirst, LastFirst, LastFirstCompany, CompanyLastCommaFirst, LastFirstSuffix, LastSpaceFirstCompany, CompanyLastSpaceFirst, LastSpaceFirst, DisplayName, FirstName, LastFirstMiddleSuffix, LastName, Empty | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiGroup.md b/sdk/docs/MapiGroup.md deleted file mode 100644 index 1e8aa05..0000000 --- a/sdk/docs/MapiGroup.md +++ /dev/null @@ -1,8 +0,0 @@ -# EmailCloud.Mapi -MAPI operations. - -API | Description ---- | ----------- -[EmailCloud.mapi.**calendar**](MapiCalendarApi_list.md) | MAPI calendar operations. -[EmailCloud.mapi.**contact**](MapiContactApi_list.md) | MAPI contact operations -[EmailCloud.mapi.**message**](MapiMessageApi_list.md) | MAPI message operations diff --git a/sdk/docs/MapiImportancePropertyDto.md b/sdk/docs/MapiImportancePropertyDto.md deleted file mode 100644 index 6b7d445..0000000 --- a/sdk/docs/MapiImportancePropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiImportancePropertyDto - -Mapi property with ImportanceChoicesType value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Levels of importance for an item. Enum, available values: Low, Normal, High | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiIntPropertyDto.md b/sdk/docs/MapiIntPropertyDto.md deleted file mode 100644 index cca0d9b..0000000 --- a/sdk/docs/MapiIntPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiIntPropertyDto - -Mapi property with Integer value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**int** |Property value | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiKnownPropertyDescriptor.md b/sdk/docs/MapiKnownPropertyDescriptor.md deleted file mode 100644 index 3c78e2e..0000000 --- a/sdk/docs/MapiKnownPropertyDescriptor.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiKnownPropertyDescriptor - -Known Mapi Property descriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Known property name. See all known properties here: https://apireference.aspose.com/email/net/aspose.email.mapi/knownpropertylist/fields/index Possible values: Mileage, ObjectUri, GDataContactVersion, GDataPhotoVersion, AddressBookProviderArrayType, AddressBookProviderEmailList, AddressCountryCode, AgingDontAgeMe, AllAttendeesString, AllowExternalCheck, AnniversaryEventEntryId, AppointmentAuxiliaryFlags, AppointmentColor, AppointmentCounterProposal, AppointmentDuration, AppointmentEndDate, AppointmentEndTime, AppointmentEndWhole, AppointmentLastSequence, AppointmentMessageClass, AppointmentNotAllowPropose, AppointmentProposalNumber, AppointmentProposedDuration, AppointmentProposedEndWhole, AppointmentProposedStartWhole, AppointmentRecur, AppointmentReplyName, AppointmentReplyTime, AppointmentSequence, AppointmentSequenceTime, AppointmentStartDate, AppointmentStartTime, AppointmentStartWhole, AppointmentStateFlags, AppointmentSubType, AppointmentTimeZoneDefinitionEndDisplay, AppointmentTimeZoneDefinitionRecur, AppointmentTimeZoneDefinitionStartDisplay, AppointmentUnsendableRecipients, AppointmentUpdateTime, AttendeeCriticalChange, AutoFillLocation, AutoLog, AutoProcessState, AutoStartCheck, Billing, BirthdayEventEntryId, BirthdayLocal, BusinessCardCardPicture, BusinessCardDisplayDefinition, BusyStatus, CalendarType, Categories, CcAttendeesString, ChangeHighlight, Classification, ClassificationDescription, ClassificationGuid, ClassificationKeep, Classified, CleanGlobalObjectId, ClientIntent, ClipEnd, ClipStart, CollaborateDoc, CommonEnd, CommonStart, Companies, ConferencingCheck, ConferencingType, ContactCharacterSet, ContactItemData, ContactLinkedGlobalAddressListEntryId, ContactLinkEntry, ContactLinkGlobalAddressListLinkId, ContactLinkGlobalAddressListLinkState, ContactLinkLinkRejectHistory, ContactLinkName, ContactLinkSearchKey, ContactLinkSMTPAddressCache, Contacts, ContactUserField1, ContactUserField2, ContactUserField3, ContactUserField4, ConversationActionLastAppliedTime, ConversationActionMaxDeliveryTime, ConversationActionMoveFolderEid, ConversationActionMoveStoreEid, ConversationActionVersion, ConversationProcessed, CurrentVersion, CurrentVersionName, DayInterval, DayOfMonth, DelegateMail, Department, Directory, DistributionListChecksum, DistributionListMembers, DistributionListName, DistributionListOneOffMembers, DistributionListStream, Email1AddressType, Email1DisplayName, Email1EmailAddress, Email1OriginalDisplayName, Email1OriginalEntryId, Email2AddressType, Email2DisplayName, Email2EmailAddress, Email2OriginalDisplayName, Email2OriginalEntryId, Email3AddressType, Email3DisplayName, Email3EmailAddress, Email3OriginalDisplayName, Email3OriginalEntryId, EndRecurrenceDate, EndRecurrenceTime, ExceptionReplaceTime, Fax1AddressType, Fax1EmailAddress, Fax1OriginalDisplayName, Fax1OriginalEntryId, Fax2AddressType, Fax2EmailAddress, Fax2OriginalDisplayName, Fax2OriginalEntryId, Fax3AddressType, Fax3EmailAddress, Fax3OriginalDisplayName, Fax3OriginalEntryId, FExceptionalAttendees, FExceptionalBody, FileUnder, FileUnderId, FileUnderList, FInvited, FlagRequest, FlagString, ForwardInstance, ForwardNotificationRecipients, FOthersAppointment, FreeBusyLocation, GlobalObjectId, HasPicture, HomeAddress, HomeAddressCountryCode, Html, ICalendarDayOfWeekMask, InboundICalStream, InfoPathFormName, InstantMessagingAddress, IntendedBusyStatus, InternetAccountName, InternetAccountStamp, IsContactLinked, IsException, IsRecurring, IsSilent, LinkedTaskItems, Location, LogDocumentPosted, LogDocumentPrinted, LogDocumentRouted, LogDocumentSaved, LogDuration, LogEnd, LogFlags, LogStart, LogType, LogTypeDesc, MeetingType, MeetingWorkspaceUrl, MonthInterval, MonthOfYear, MonthOfYearMask, NetShowUrl, NoEndDateFlag, NonSendableBcc, NonSendableCc, NonSendableTo, NonSendBccTrackStatus, NonSendCcTrackStatus, NonSendToTrackStatus, NoteColor, NoteHeight, NoteWidth, NoteX, NoteY, Occurrences, OldLocation, OldRecurrenceType, OldWhenEndWhole, OldWhenStartWhole, OnlinePassword, OptionalAttendees, OrganizerAlias, OriginalStoreEntryId, OtherAddress, OtherAddressCountryCode, OwnerCriticalChange, OwnerName, PendingStateForSiteMailboxDocument, PercentComplete, PostalAddressId, PostRssChannel, PostRssChannelLink, PostRssItemGuid, PostRssItemHash, PostRssItemLink, PostRssItemXml, PostRssSubscription, Private, PromptSendUpdate, RecurrenceDuration, RecurrencePattern, RecurrenceType, Recurring, ReferenceEntryId, ReminderDelta, ReminderFileParameter, ReminderOverride, ReminderPlaySound, ReminderSet, ReminderSignalTime, ReminderTime, ReminderTimeDate, ReminderTimeTime, ReminderType, RemoteStatus, RequiredAttendees, ResourceAttendees, ResponseStatus, ServerProcessed, ServerProcessingActions, SharingAnonymity, SharingBindingEntryId, SharingBrowseUrl, SharingCapabilities, SharingConfigurationUrl, SharingDataRangeEnd, SharingDataRangeStart, SharingDetail, SharingExtensionXml, SharingFilter, SharingFlags, SharingFlavor, SharingFolderEntryId, SharingIndexEntryId, SharingInitiatorEntryId, SharingInitiatorName, SharingInitiatorSmtp, SharingInstanceGuid, SharingLastAutoSyncTime, SharingLastSyncTime, SharingLocalComment, SharingLocalLastModificationTime, SharingLocalName, SharingLocalPath, SharingLocalStoreUid, SharingLocalType, SharingLocalUid, SharingOriginalMessageEntryId, SharingParentBindingEntryId, SharingParticipants, SharingPermissions, SharingProviderExtension, SharingProviderGuid, SharingProviderName, SharingProviderUrl, SharingRangeEnd, SharingRangeStart, SharingReciprocation, SharingRemoteByteSize, SharingRemoteComment, SharingRemoteCrc, SharingRemoteLastModificationTime, SharingRemoteMessageCount, SharingRemoteName, SharingRemotePass, SharingRemotePath, SharingRemoteStoreUid, SharingRemoteType, SharingRemoteUid, SharingRemoteUser, SharingRemoteVersion, SharingResponseTime, SharingResponseType, SharingRoamLog, SharingStart, SharingStatus, SharingStop, SharingSyncFlags, SharingSyncInterval, SharingTimeToLive, SharingTimeToLiveAuto, SharingWorkingHoursDays, SharingWorkingHoursEnd, SharingWorkingHoursStart, SharingWorkingHoursTimeZone, SideEffects, SingleBodyICal, SmartNoAttach, SpamOriginalFolder, StartRecurrenceDate, StartRecurrenceTime, TaskAcceptanceState, TaskAccepted, TaskActualEffort, TaskAssigner, TaskAssigners, TaskComplete, TaskCustomFlags, TaskDateCompleted, TaskDeadOccurrence, TaskDueDate, TaskEstimatedEffort, TaskFCreator, TaskFFixOffline, TaskFRecurring, TaskGlobalId, TaskHistory, TaskLastDelegate, TaskLastUpdate, TaskLastUser, TaskMode, TaskMultipleRecipients, TaskNoCompute, TaskOrdinal, TaskOwner, TaskOwnership, TaskRecurrence, TaskResetReminder, TaskRole, TaskStartDate, TaskState, TaskStatus, TaskStatusOnComplete, TaskUpdates, TaskVersion, TeamTask, TimeZone, TimeZoneDescription, TimeZoneStruct, ToAttendeesString, ToDoOrdinalDate, ToDoSubOrdinal, ToDoTitle, UseTnef, ValidFlagStringProof, VerbResponse, VerbStream, WeddingAnniversaryLocal, WeekInterval, Where, WorkAddress, WorkAddressCity, WorkAddressCountry, WorkAddressCountryCode, WorkAddressPostalCode, WorkAddressPostOfficeBox, WorkAddressState, WorkAddressStreet, YearInterval, YomiCompanyName, YomiFirstName, YomiLastName, AcceptLanguage, ApplicationName, AttachmentMacContentType, AttachmentMacInfo, AudioNotes, Author, AutomaticSpeechRecognitionData, ByteCount, CalendarAttendeeRole, CalendarBusystatus, CalendarContact, CalendarContactUrl, CalendarCreated, CalendarDescriptionUrl, CalendarDuration, CalendarExceptionDate, CalendarExceptionRule, CalendarGeoLatitude, CalendarGeoLongitude, CalendarInstanceType, CalendarIsOrganizer, CalendarLastModified, CalendarLocationUrl, CalendarMeetingStatus, CalendarMethod, CalendarProductId, CalendarRecurrenceIdRange, CalendarReminderOffset, CalendarResources, CalendarRsvp, CalendarSequence, CalendarTimeZone, CalendarTimeZoneId, CalendarTransparent, CalendarUid, CalendarVersion, Category, CharacterCount, Comments, Company, ContentBase, ContentClass, ContentType, CreateDateTimeReadOnly, CrossReference, DavId, DavIsCollection, DavIsStructuredDocument, DavParentName, DavUid, DocumentParts, EditTime, ExchangeIntendedBusyStatus, ExchangeJunkEmailMoveStamp, ExchangeModifyExceptionStructure, ExchangeNoModifyExceptions, ExchangePatternEnd, ExchangePatternStart, ExchangeReminderInterval, ExchDatabaseSchema, ExchDataExpectedContentClass, ExchDataSchemaCollectionReference, ExtractedAddresses, ExtractedContacts, ExtractedEmails, ExtractedMeetings, ExtractedPhones, ExtractedTasks, ExtractedUrls, From, HeadingPairs, HiddenCount, HttpmailCalendar, HttpmailHtmlDescription, HttpmailSendMessage, ICalendarRecurrenceDate, ICalendarRecurrenceRule, InternetSubject, Keywords, LastAuthor, LastPrinted, LastSaveDateTime, LineCount, LinksDirty, LocationUrl, Manager, MultimediaClipCount, NoteCount, OMSAccountGuid, OMSMobileModel, OMSScheduleTime, OMSServiceType, OMSSourceType, PageCount, ParagraphCount, PhishingStamp, PresentationFormat, QuarantineOriginalSender, RevisionNumber, RightsManagementLicense, Scale, Security, SlideCount, Subject, Template, Thumbnail, Title, WordCount, XCallId, XFaxNumberOfPages, XRequireProtectedPlayOnPhone, XSenderTelephoneNumber, XSharingBrowseUrl, XSharingCapabilities, XSharingConfigUrl, XSharingExendedCaps, XSharingFlavor, XSharingInstanceGuid, XSharingLocalType, XSharingProviderGuid, XSharingProviderName, XSharingProviderUrl, XSharingRemoteName, XSharingRemotePath, XSharingRemoteStoreUid, XSharingRemoteType, XSharingRemoteUid, XVoiceMessageAttachmentOrder, XVoiceMessageDuration, XVoiceMessageSenderName, Access, AccessControlListData, AccessLevel, Account, AdditionalRenEntryIds, AdditionalRenEntryIdsEx, AddressBookAuthorizedSenders, AddressBookContainerId, AddressBookDeliveryContentLength, AddressBookDisplayNamePrintable, AddressBookDisplayTypeExtended, AddressBookDistributionListExternalMemberCount, AddressBookDistributionListMemberCount, AddressBookDistributionListMemberSubmitAccepted, AddressBookDistributionListMemberSubmitRejected, AddressBookDistributionListRejectMessagesFromDLMembers, AddressBookEntryId, AddressBookExtensionAttribute1, AddressBookExtensionAttribute10, AddressBookExtensionAttribute11, AddressBookExtensionAttribute12, AddressBookExtensionAttribute13, AddressBookExtensionAttribute14, AddressBookExtensionAttribute15, AddressBookExtensionAttribute2, AddressBookExtensionAttribute3, AddressBookExtensionAttribute4, AddressBookExtensionAttribute5, AddressBookExtensionAttribute6, AddressBookExtensionAttribute7, AddressBookExtensionAttribute8, AddressBookExtensionAttribute9, AddressBookFolderPathname, AddressBookHierarchicalChildDepartments, AddressBookHierarchicalDepartmentMembers, AddressBookHierarchicalIsHierarchicalGroup, AddressBookHierarchicalParentDepartment, AddressBookHierarchicalRootDepartment, AddressBookHierarchicalShowInDepartments, AddressBookHomeMessageDatabase, AddressBookIsMaster, AddressBookIsMemberOfDistributionList, AddressBookManageDistributionList, AddressBookManager, AddressBookManagerDistinguishedName, AddressBookMember, AddressBookMessageId, AddressBookModerationEnabled, AddressBookNetworkAddress, AddressBookObjectDistinguishedName, AddressBookObjectGuid, AddressBookOrganizationalUnitRootDistinguishedName, AddressBookOwner, AddressBookOwnerBackLink, AddressBookParentEntryId, AddressBookPhoneticCompanyName, AddressBookPhoneticDepartmentName, AddressBookPhoneticDisplayName, AddressBookPhoneticGivenName, AddressBookPhoneticSurname, AddressBookProxyAddresses, AddressBookPublicDelegates, AddressBookReports, AddressBookRoomCapacity, AddressBookRoomContainers, AddressBookRoomDescription, AddressBookSenderHintTranslations, AddressBookSeniorityIndex, AddressBookTargetAddress, AddressBookUnauthorizedSenders, AddressBookX509Certificate, AddressType, AlternateRecipientAllowed, Anr, ArchiveDate, ArchivePeriod, ArchiveTag, Assistant, AssistantTelephoneNumber, Associated, AttachAdditionalInformation, AttachContentBase, AttachContentId, AttachContentLocation, AttachDataBinary, AttachDataObject, AttachEncoding, AttachExtension, AttachFilename, AttachFlags, AttachLongFilename, AttachLongPathname, AttachmentContactPhoto, AttachmentFlags, AttachmentHidden, AttachmentLinkId, AttachMethod, AttachMimeTag, AttachNumber, AttachPathname, AttachPayloadClass, AttachPayloadProviderGuidString, AttachRendering, AttachSize, AttachTag, AttachTransportName, AttributeHidden, AttributeReadOnly, AutoForwardComment, AutoForwarded, AutoResponseSuppress, Birthday, BlockStatus, Body, BodyContentId, BodyContentLocation, BodyHtml, Business2TelephoneNumber, Business2TelephoneNumbers, BusinessFaxNumber, BusinessHomePage, BusinessTelephoneNumber, CallbackTelephoneNumber, CallId, CarTelephoneNumber, CdoRecurrenceid, ChangeKey, ChangeNumber, ChildrensNames, ClientActions, ClientSubmitTime, CodePageId, Comment, CompanyMainTelephoneNumber, CompanyName, ComputerNetworkName, ConflictEntryId, ContainerClass, ContainerContents, ContainerFlags, ContainerHierarchy, ContentCount, ContentFilterSpamConfidenceLevel, ContentUnreadCount, ConversationId, ConversationIndex, ConversationIndexTracking, ConversationTopic, Country, CreationTime, CreatorEntryId, CreatorName, CustomerId, DamBackPatched, DamOriginalEntryId, DefaultPostMessageClass, DeferredActionMessageOriginalEntryId, DeferredDeliveryTime, DeferredSendNumber, DeferredSendTime, DeferredSendUnits, DelegatedByRule, DelegateFlags, DeleteAfterSubmit, DeletedCountTotal, DeletedOn, DeliverTime, DepartmentName, Depth, DisplayBcc, DisplayCc, DisplayName, DisplayNamePrefix, DisplayTo, DisplayType, DisplayTypeEx, EmailAddress, EndDate, EntryId, ExceptionEndTime, TagExceptionReplaceTime, ExceptionStartTime, ExchangeNTSecurityDescriptor, ExpiryNumber, ExpiryTime, ExpiryUnits, ExtendedFolderFlags, ExtendedRuleMessageActions, ExtendedRuleMessageCondition, ExtendedRuleSizeLimit, FaxNumberOfPages, FlagCompleteTime, FlagStatus, FlatUrlName, FolderAssociatedContents, FolderId, FolderFlags, FolderType, FollowupIcon, FreeBusyCountMonths, FreeBusyEntryIds, FreeBusyMessageEmailAddress, FreeBusyPublishEnd, FreeBusyPublishStart, FreeBusyRangeTimestamp, FtpSite, GatewayNeedsToRefresh, Gender, Generation, GivenName, GovernmentIdNumber, HasAttachments, HasDeferredActionMessages, HasNamedProperties, HasRules, HierarchyChangeNumber, HierRev, Hobbies, Home2TelephoneNumber, Home2TelephoneNumbers, HomeAddressCity, HomeAddressCountry, HomeAddressPostalCode, HomeAddressPostOfficeBox, HomeAddressStateOrProvince, HomeAddressStreet, HomeFaxNumber, HomeTelephoneNumber, TagHtml, ICalendarEndTime, ICalendarReminderNextTime, ICalendarStartTime, IconIndex, Importance, InConflict, InitialDetailsPane, Initials, InReplyToId, InstanceKey, InstanceNum, InstID, InternetCodepage, InternetMailOverrideFormat, InternetMessageId, InternetReferences, IpmAppointmentEntryId, IpmContactEntryId, IpmDraftsEntryId, IpmJournalEntryId, IpmNoteEntryId, IpmTaskEntryId, IsdnNumber, JunkAddRecipientsToSafeSendersList, JunkIncludeContacts, JunkPermanentlyDelete, JunkPhishingEnableLinks, JunkThreshold, Keyword, Language, LastModificationTime, LastModifierEntryId, LastModifierName, LastVerbExecuted, LastVerbExecutionTime, ListHelp, ListSubscribe, ListUnsubscribe, LocalCommitTime, LocalCommitTimeMax, LocaleId, Locality, TagLocation, MailboxOwnerEntryId, MailboxOwnerName, ManagerName, MappingSignature, MaximumSubmitMessageSize, MemberId, MemberName, MemberRights, MessageAttachments, MessageCcMe, MessageClass, MessageCodepage, MessageDeliveryTime, MessageEditorFormat, MessageFlags, MessageHandlingSystemCommonName, MessageLocaleId, MessageRecipientMe, MessageRecipients, MessageSize, MessageSizeExtended, MessageStatus, MessageSubmissionId, MessageToMe, Mid, MiddleName, MimeSkeleton, MobileTelephoneNumber, NativeBody, NextSendAcct, Nickname, NonDeliveryReportDiagCode, NonDeliveryReportReasonCode, NonDeliveryReportStatusCode, NonReceiptNotificationRequested, NormalizedSubject, ObjectType, OfficeLocation, OfflineAddressBookContainerGuid, OfflineAddressBookDistinguishedName, OfflineAddressBookMessageClass, OfflineAddressBookName, OfflineAddressBookSequence, OfflineAddressBookTruncatedProperties, OrdinalMost, OrganizationalIdNumber, OriginalAuthorEntryId, OriginalAuthorName, OriginalDeliveryTime, OriginalDisplayBcc, OriginalDisplayCc, OriginalDisplayTo, OriginalEntryId, OriginalMessageClass, OriginalMessageId, OriginalSenderAddressType, OriginalSenderEmailAddress, OriginalSenderEntryId, OriginalSenderName, OriginalSenderSearchKey, OriginalSensitivity, OriginalSentRepresentingAddressType, OriginalSentRepresentingEmailAddress, OriginalSentRepresentingEntryId, OriginalSentRepresentingName, OriginalSentRepresentingSearchKey, OriginalSubject, OriginalSubmitTime, OriginatorDeliveryReportRequested, OriginatorNonDeliveryReportRequested, OscSyncEnabled, OtherAddressCity, OtherAddressCountry, OtherAddressPostalCode, OtherAddressPostOfficeBox, OtherAddressStateOrProvince, OtherAddressStreet, OtherTelephoneNumber, OutOfOfficeState, OwnerAppointmentId, PagerTelephoneNumber, ParentEntryId, ParentFolderId, ParentKey, ParentSourceKey, PersonalHomePage, PolicyTag, PostalAddress, PostalCode, PostOfficeBox, PredecessorChangeList, PrimaryFaxNumber, PrimarySendAccount, PrimaryTelephoneNumber, Priority, Processed, Profession, ProhibitReceiveQuota, ProhibitSendQuota, PurportedSenderDomain, RadioTelephoneNumber, Read, ReadReceiptAddressType, ReadReceiptEmailAddress, ReadReceiptEntryId, ReadReceiptName, ReadReceiptRequested, ReadReceiptSearchKey, ReadReceiptSmtpAddress, ReceiptTime, ReceivedByAddressType, ReceivedByEmailAddress, ReceivedByEntryId, ReceivedByName, ReceivedBySearchKey, ReceivedBySmtpAddress, ReceivedRepresentingAddressType, ReceivedRepresentingEmailAddress, ReceivedRepresentingEntryId, ReceivedRepresentingName, ReceivedRepresentingSearchKey, ReceivedRepresentingSmtpAddress, RecipientDisplayName, RecipientEntryId, RecipientFlags, RecipientOrder, RecipientProposed, RecipientProposedEndTime, RecipientProposedStartTime, RecipientReassignmentProhibited, RecipientTrackStatus, RecipientTrackStatusTime, RecipientType, RecordKey, ReferredByName, RemindersOnlineEntryId, RemoteMessageTransferAgent, RenderingPosition, ReplyRecipientEntries, ReplyRecipientNames, ReplyRequested, ReplyTemplateId, ReplyTime, ReportDisposition, ReportDispositionMode, ReportEntryId, ReportingMessageTransferAgent, ReportName, ReportSearchKey, ReportTag, ReportText, ReportTime, ResolveMethod, ResponseRequested, Responsibility, RetentionDate, RetentionFlags, RetentionPeriod, Rights, RoamingDatatypes, RoamingDictionary, RoamingXmlStream, Rowid, RowType, RtfCompressed, RtfInSync, RuleActionNumber, RuleActions, RuleActionType, RuleCondition, RuleError, RuleFolderEntryId, RuleId, RuleIds, RuleLevel, RuleMessageLevel, RuleMessageName, RuleMessageProvider, RuleMessageProviderData, RuleMessageSequence, RuleMessageState, RuleMessageUserFlags, RuleName, RuleProvider, RuleProviderData, RuleSequence, RuleState, RuleUserFlags, RwRulesStream, ScheduleInfoAppointmentTombstone, ScheduleInfoAutoAcceptAppointments, ScheduleInfoDelegateEntryIds, ScheduleInfoDelegateNames, ScheduleInfoDelegateNamesW, ScheduleInfoDelegatorWantsCopy, ScheduleInfoDelegatorWantsInfo, ScheduleInfoDisallowOverlappingAppts, ScheduleInfoDisallowRecurringAppts, ScheduleInfoDontMailDelegates, ScheduleInfoFreeBusy, ScheduleInfoFreeBusyAway, ScheduleInfoFreeBusyBusy, ScheduleInfoFreeBusyMerged, ScheduleInfoFreeBusyTentative, ScheduleInfoMonthsAway, ScheduleInfoMonthsBusy, ScheduleInfoMonthsMerged, ScheduleInfoMonthsTentative, ScheduleInfoResourceType, SchedulePlusFreeBusyEntryId, ScriptData, SearchFolderDefinition, SearchFolderEfpFlags, SearchFolderExpiration, SearchFolderId, SearchFolderLastUsed, SearchFolderRecreateInfo, SearchFolderStorageType, SearchFolderTag, SearchFolderTemplateId, SearchKey, SecurityDescriptorAsXml, Selectable, SenderAddressType, SenderEmailAddress, SenderEntryId, SenderIdStatus, SenderName, SenderSearchKey, SenderSmtpAddress, SenderTelephoneNumber, SendInternetEncoding, SendRichInfo, Sensitivity, SentMailSvrEID, SentRepresentingAddressType, SentRepresentingEmailAddress, SentRepresentingEntryId, SentRepresentingFlags, SentRepresentingName, SentRepresentingSearchKey, SentRepresentingSmtpAddress, SmtpAddress, SortLocaleId, SourceKey, SpokenName, SpouseName, StartDate, StartDateEtc, StateOrProvince, StoreEntryId, StoreState, StoreSupportMask, StreetAddress, Subfolders, TagSubject, SubjectPrefix, SupplementaryInfo, Surname, SwappedToDoData, SwappedToDoStore, TargetEntryId, TelecommunicationsDeviceForDeafTelephoneNumber, TelexNumber, TemplateData, Templateid, TextAttachmentCharset, ThumbnailPhoto, TagTitle, TnefCorrelationKey, ToDoItemFlags, TransmittableDisplayName, TransportMessageHeaders, TrustSender, UserCertificate, UserEntryId, UserX509Certificate, ViewDescriptorBinary, ViewDescriptorName, ViewDescriptorStrings, ViewDescriptorVersion, VoiceMessageAttachmentOrder, VoiceMessageDuration, VoiceMessageSenderName, WeddingAnniversary, WlinkAddressBookEID, WlinkAddressBookStoreEID, WlinkCalendarColor, WlinkClientID, WlinkEntryId, WlinkFlags, WlinkFolderType, WlinkGroupClsid, WlinkGroupHeaderID, WlinkGroupName, WlinkOrdinal, WlinkRecordKey, WlinkROGroupType, WlinkSaveStamp, WlinkSection, WlinkStoreEntryId, WlinkType, Abstract, ActiveUserEntryid, AddrbookForLocalSiteEntryid, AddressBookDisplayName, ArrivalTime, AssocMessageSize, AssocMessageSizeExtended, AssocMsgWAttachCount, AttachOnAssocMsgCount, AttachOnNormalMsgCount, AutoAddNewSubs, BilateralInfo, CachedColumnCount, CategCount, ChangeAdvisor, ChangeNotificationGuid, Collector, ContactCount, ContentSearchKey, ContentsSynchronizer, DeletedAssocMessageSizeExtended, DeletedAssocMsgCount, DeletedFolderCount, DeletedMessageSizeExtended, DeletedMsgCount, DeletedNormalMessageSizeExtended, DesignInProgress, DisableFullFidelity, DisableWinsock, DlReportFlags, EformsForLocaleEntryid, EformsLocaleId, EformsRegistryEntryid, EmsAbAccessCategory, EmsAbActivationSchedule, EmsAbActivationStyle, EmsAbAddressEntryDisplayTable, EmsAbAddressEntryDisplayTableMsdos, EmsAbAddressSyntax, EmsAbAddressType, EmsAbAdmd, EmsAbAdminDescription, EmsAbAdminDisplayName, EmsAbAdminExtensionDll, EmsAbAliasedObjectName, EmsAbAliasedObjectNameO, EmsAbAltRecipient, EmsAbAltRecipientBl, EmsAbAltRecipientBlO, EmsAbAltRecipientO, EmsAbAncestorId, EmsAbAnonymousAccess, EmsAbAnonymousAccount, EmsAbAssocNtAccount, EmsAbAssocProtocolCfgNntp, EmsAbAssocProtocolCfgNntpO, EmsAbAssocRemoteDxa, EmsAbAssocRemoteDxaO, EmsAbAssociationLifetime, EmsAbAttributeCertificate, EmsAbAuthOrigBl, EmsAbAuthOrigBlO, EmsAbAuthenticationToUse, EmsAbAuthorityRevocationList, EmsAbAuthorizedDomain, EmsAbAuthorizedPassword, EmsAbAuthorizedPasswordConfirm, EmsAbAuthorizedUser, EmsAbAutoreply, EmsAbAutoreplyMessage, EmsAbAutoreplySubject, EmsAbAvailableAuthorizationPackages, EmsAbAvailableDistributions, EmsAbBridgeheadServers, EmsAbBridgeheadServersO, EmsAbBusinessCategory, EmsAbBusinessRoles, EmsAbCaCertificate, EmsAbCanCreatePf, EmsAbCanCreatePfBl, EmsAbCanCreatePfBlO, EmsAbCanCreatePfDl, EmsAbCanCreatePfDlBl, EmsAbCanCreatePfDlBlO, EmsAbCanCreatePfDlO, EmsAbCanCreatePfO, EmsAbCanNotCreatePf, EmsAbCanNotCreatePfBl, EmsAbCanNotCreatePfBlO, EmsAbCanNotCreatePfDl, EmsAbCanNotCreatePfDlBl, EmsAbCanNotCreatePfDlBlO, EmsAbCanNotCreatePfDlO, EmsAbCanNotCreatePfO, EmsAbCanPreserveDns, EmsAbCertificateChainV3, EmsAbCertificateRevocationList, EmsAbCertificateRevocationListV1, EmsAbCertificateRevocationListV3, EmsAbCharacterSet, EmsAbCharacterSetList, EmsAbChildRdns, EmsAbClientAccessEnabled, EmsAbClockAlertOffset, EmsAbClockAlertRepair, EmsAbClockWarningOffset, EmsAbClockWarningRepair, EmsAbCompromisedKeyList, EmsAbComputerName, EmsAbConnectedDomains, EmsAbConnectionListFilter, EmsAbConnectionListFilterType, EmsAbConnectionType, EmsAbContainerInfo, EmsAbContentType, EmsAbControlMsgFolderId, EmsAbControlMsgRules, EmsAbCost, EmsAbCountryName, EmsAbCrossCertificateCrl, EmsAbCrossCertificatePair, EmsAbDefaultMessageFormat, EmsAbDelegateUser, EmsAbDelivEits, EmsAbDelivExtContTypes, EmsAbDeliverAndRedirect, EmsAbDeliveryMechanism, EmsAbDeltaRevocationList, EmsAbDescription, EmsAbDestinationIndicator, EmsAbDiagnosticRegKey, EmsAbDisableDeferredCommit, EmsAbDisabledGatewayProxy, EmsAbDisplayNameOverride, EmsAbDisplayNameSuffix, EmsAbDlMemRejectPermsBl, EmsAbDlMemRejectPermsBlO, EmsAbDlMemberRule, EmsAbDmdName, EmsAbDoOabVersion, EmsAbDomainDefAltRecip, EmsAbDomainDefAltRecipO, EmsAbDomainName, EmsAbDsaSignature, EmsAbDxaAdminCopy, EmsAbDxaAdminForward, EmsAbDxaAdminUpdate, EmsAbDxaAppendReqcn, EmsAbDxaConfContainerList, EmsAbDxaConfContainerListO, EmsAbDxaConfReqTime, EmsAbDxaConfSeq, EmsAbDxaConfSeqUsn, EmsAbDxaExchangeOptions, EmsAbDxaExportNow, EmsAbDxaFlags, EmsAbDxaImpSeq, EmsAbDxaImpSeqTime, EmsAbDxaImpSeqUsn, EmsAbDxaImportNow, EmsAbDxaInTemplateMap, EmsAbDxaLocalAdmin, EmsAbDxaLocalAdminO, EmsAbDxaLoggingLevel, EmsAbDxaNativeAddressType, EmsAbDxaOutTemplateMap, EmsAbDxaPassword, EmsAbDxaPrevExchangeOptions, EmsAbDxaPrevExportNativeOnly, EmsAbDxaPrevInExchangeSensitivity, EmsAbDxaPrevRemoteEntries, EmsAbDxaPrevRemoteEntriesO, EmsAbDxaPrevReplicationSensitivity, EmsAbDxaPrevTemplateOptions, EmsAbDxaPrevTypes, EmsAbDxaRecipientCp, EmsAbDxaRemoteClient, EmsAbDxaRemoteClientO, EmsAbDxaReqSeq, EmsAbDxaReqSeqTime, EmsAbDxaReqSeqUsn, EmsAbDxaReqname, EmsAbDxaSvrSeq, EmsAbDxaSvrSeqTime, EmsAbDxaSvrSeqUsn, EmsAbDxaTask, EmsAbDxaTemplateOptions, EmsAbDxaTemplateTimestamp, EmsAbDxaTypes, EmsAbDxaUnconfContainerList, EmsAbDxaUnconfContainerListO, EmsAbEmployeeNumber, EmsAbEmployeeType, EmsAbEnableCompatibility, EmsAbEnabled, EmsAbEnabledAuthorizationPackages, EmsAbEnabledProtocolCfg, EmsAbEnabledProtocols, EmsAbEncapsulationMethod, EmsAbEncrypt, EmsAbEncryptAlgListNa, EmsAbEncryptAlgListOther, EmsAbEncryptAlgSelectedNa, EmsAbEncryptAlgSelectedOther, EmsAbExpandDlsLocally, EmsAbExpirationTime, EmsAbExportContainers, EmsAbExportContainersO, EmsAbExportCustomRecipients, EmsAbExtendedCharsAllowed, EmsAbExtensionData, EmsAbExtensionName, EmsAbExtensionNameInherited, EmsAbFacsimileTelephoneNumber, EmsAbFileVersion, EmsAbFilterLocalAddresses, EmsAbFoldersContainer, EmsAbFoldersContainerO, EmsAbFormData, EmsAbForwardingAddress, EmsAbGarbageCollPeriod, EmsAbGatewayLocalCred, EmsAbGatewayLocalDesig, EmsAbGatewayProxy, EmsAbGatewayRoutingTree, EmsAbGenerationQualifier, EmsAbGroupByAttr1, EmsAbGroupByAttr2, EmsAbGroupByAttr3, EmsAbGroupByAttr4, EmsAbGroupByAttrValueDn, EmsAbGroupByAttrValueDnO, EmsAbGroupByAttrValueStr, EmsAbGwartLastModified, EmsAbHasFullReplicaNcs, EmsAbHasFullReplicaNcsO, EmsAbHasMasterNcs, EmsAbHasMasterNcsO, EmsAbHelpData16, EmsAbHelpData32, EmsAbHelpFileName, EmsAbHeuristics, EmsAbHideDlMembership, EmsAbHideFromAddressBook, EmsAbHierarchyPath, EmsAbHomeMdbBl, EmsAbHomeMdbBlO, EmsAbHomeMta, EmsAbHomeMtaO, EmsAbHomePublicServer, EmsAbHomePublicServerO, EmsAbHouseIdentifier, EmsAbHttpPubAbAttributes, EmsAbHttpPubGal, EmsAbHttpPubGalLimit, EmsAbHttpPubPf, EmsAbHttpServers, EmsAbImportContainer, EmsAbImportContainerO, EmsAbImportSensitivity, EmsAbImportedFrom, EmsAbInboundAcceptAll, EmsAbInboundDn, EmsAbInboundDnO, EmsAbInboundHost, EmsAbInboundNewsfeed, EmsAbInboundNewsfeedType, EmsAbInboundSites, EmsAbInboundSitesO, EmsAbIncomingMsgSizeLimit, EmsAbIncomingPassword, EmsAbInsadmin, EmsAbInsadminO, EmsAbInstanceType, EmsAbInternationalIsdnNumber, EmsAbInvocationId, EmsAbIsDeleted, EmsAbIsSingleValued, EmsAbKccStatus, EmsAbKmServer, EmsAbKmServerO, EmsAbKnowledgeInformation, EmsAbLabeleduri, EmsAbLanguage, EmsAbLanguageIso639, EmsAbLdapDisplayName, EmsAbLdapSearchCfg, EmsAbLineWrap, EmsAbLinkId, EmsAbListPublicFolders, EmsAbLocalBridgeHead, EmsAbLocalBridgeHeadAddress, EmsAbLocalInitialTurn, EmsAbLocalScope, EmsAbLocalScopeO, EmsAbLogFilename, EmsAbLogRolloverInterval, EmsAbMailDrop, EmsAbMaintainAutoreplyHistory, EmsAbMapiDisplayType, EmsAbMapiId, EmsAbMaximumObjectId, EmsAbMdbBackoffInterval, EmsAbMdbMsgTimeOutPeriod, EmsAbMdbOverQuotaLimit, EmsAbMdbStorageQuota, EmsAbMdbUnreadLimit, EmsAbMdbUseDefaults, EmsAbMessageTrackingEnabled, EmsAbMimeTypes, EmsAbModerated, EmsAbModerator, EmsAbMonitorClock, EmsAbMonitorServers, EmsAbMonitorServices, EmsAbMonitoredConfigurations, EmsAbMonitoredConfigurationsO, EmsAbMonitoredServers, EmsAbMonitoredServersO, EmsAbMonitoredServices, EmsAbMonitoringAlertDelay, EmsAbMonitoringAlertUnits, EmsAbMonitoringAvailabilityStyle, EmsAbMonitoringAvailabilityWindow, EmsAbMonitoringCachedViaMail, EmsAbMonitoringCachedViaMailO, EmsAbMonitoringCachedViaRpc, EmsAbMonitoringCachedViaRpcO, EmsAbMonitoringEscalationProcedure, EmsAbMonitoringHotsitePollInterval, EmsAbMonitoringHotsitePollUnits, EmsAbMonitoringMailUpdateInterval, EmsAbMonitoringMailUpdateUnits, EmsAbMonitoringNormalPollInterval, EmsAbMonitoringNormalPollUnits, EmsAbMonitoringRecipients, EmsAbMonitoringRecipientsNdr, EmsAbMonitoringRecipientsNdrO, EmsAbMonitoringRecipientsO, EmsAbMonitoringRpcUpdateInterval, EmsAbMonitoringRpcUpdateUnits, EmsAbMonitoringWarningDelay, EmsAbMonitoringWarningUnits, EmsAbMtaLocalCred, EmsAbMtaLocalDesig, EmsAbNAddress, EmsAbNAddressType, EmsAbNewsfeedType, EmsAbNewsgroup, EmsAbNewsgroupList, EmsAbNntpCharacterSet, EmsAbNntpContentFormat, EmsAbNntpDistributions, EmsAbNntpDistributionsFlag, EmsAbNntpNewsfeeds, EmsAbNntpNewsfeedsO, EmsAbNtMachineName, EmsAbNtSecurityDescriptor, EmsAbNumOfOpenRetries, EmsAbNumOfTransferRetries, EmsAbObjViewContainers, EmsAbObjViewContainersO, EmsAbObjectClassCategory, EmsAbObjectOid, EmsAbObjectVersion, EmsAbOffLineAbContainers, EmsAbOffLineAbContainersO, EmsAbOffLineAbSchedule, EmsAbOffLineAbServer, EmsAbOffLineAbServerO, EmsAbOffLineAbStyle, EmsAbOidType, EmsAbOmObjectClass, EmsAbOmSyntax, EmsAbOofReplyToOriginator, EmsAbOpenRetryInterval, EmsAbOrganizationName, EmsAbOrganizationalUnitName, EmsAbOriginalDisplayTable, EmsAbOriginalDisplayTableMsdos, EmsAbOtherRecips, EmsAbOutboundHost, EmsAbOutboundHostType, EmsAbOutboundNewsfeed, EmsAbOutboundSites, EmsAbOutboundSitesO, EmsAbOutgoingMsgSizeLimit, EmsAbOverrideNntpContentFormat, EmsAbOwaServer, EmsAbPSelector, EmsAbPSelectorInbound, EmsAbPerMsgDialogDisplayTable, EmsAbPerRecipDialogDisplayTable, EmsAbPeriodRepSyncTimes, EmsAbPeriodReplStagger, EmsAbPersonalTitle, EmsAbPfContacts, EmsAbPfContactsO, EmsAbPopCharacterSet, EmsAbPopContentFormat, EmsAbPortNumber, EmsAbPostalAddress, EmsAbPreferredDeliveryMethod, EmsAbPreserveInternetContent, EmsAbPrmd, EmsAbPromoExpiration, EmsAbProtocolSettings, EmsAbProxyGenerationEnabled, EmsAbProxyGeneratorDll, EmsAbPublicDelegatesBl, EmsAbPublicDelegatesBlO, EmsAbQuotaNotificationSchedule, EmsAbQuotaNotificationStyle, EmsAbRangeLower, EmsAbRangeUpper, EmsAbRasAccount, EmsAbRasCallbackNumber, EmsAbRasPassword, EmsAbRasPhoneNumber, EmsAbRasPhonebookEntryName, EmsAbRasRemoteSrvrName, EmsAbReferralList, EmsAbRegisteredAddress, EmsAbRemoteBridgeHead, EmsAbRemoteBridgeHeadAddress, EmsAbRemoteOutBhServer, EmsAbRemoteOutBhServerO, EmsAbRemoteSite, EmsAbRemoteSiteO, EmsAbReplicatedObjectVersion, EmsAbReplicationMailMsgSize, EmsAbReplicationSensitivity, EmsAbReplicationStagger, EmsAbReportToOriginator, EmsAbReportToOwner, EmsAbReqSeq, EmsAbRequireSsl, EmsAbResponsibleLocalDxa, EmsAbResponsibleLocalDxaO, EmsAbReturnExactMsgSize, EmsAbRidServer, EmsAbRidServerO, EmsAbRoleOccupant, EmsAbRoleOccupantO, EmsAbRootNewsgroupsFolderId, EmsAbRoutingList, EmsAbRtsCheckpointSize, EmsAbRtsRecoveryTimeout, EmsAbRtsWindowSize, EmsAbRunsOn, EmsAbRunsOnO, EmsAbSSelector, EmsAbSSelectorInbound, EmsAbSchemaFlags, EmsAbSchemaVersion, EmsAbSearchFlags, EmsAbSearchGuide, EmsAbSecurityPolicy, EmsAbSecurityProtocol, EmsAbSeeAlso, EmsAbSeeAlsoO, EmsAbSendEmailMessage, EmsAbSendTnef, EmsAbSerialNumber, EmsAbServer, EmsAbServiceActionFirst, EmsAbServiceActionOther, EmsAbServiceActionSecond, EmsAbServiceRestartDelay, EmsAbServiceRestartMessage, EmsAbSessionDisconnectTimer, EmsAbSiteAffinity, EmsAbSiteFolderGuid, EmsAbSiteFolderServer, EmsAbSiteFolderServerO, EmsAbSiteProxySpace, EmsAbSmimeAlgListNa, EmsAbSmimeAlgListOther, EmsAbSmimeAlgSelectedNa, EmsAbSmimeAlgSelectedOther, EmsAbSpaceLastComputed, EmsAbStreetAddress, EmsAbSubRefs, EmsAbSubRefsO, EmsAbSubSite, EmsAbSubmissionContLength, EmsAbSupportSmimeSignatures, EmsAbSupportedAlgorithms, EmsAbSupportedApplicationContext, EmsAbSupportingStack, EmsAbSupportingStackBl, EmsAbSupportingStackBlO, EmsAbSupportingStackO, EmsAbTSelector, EmsAbTSelectorInbound, EmsAbTargetMtas, EmsAbTelephoneNumber, EmsAbTelephonePersonalPager, EmsAbTeletexTerminalIdentifier, EmsAbTempAssocThreshold, EmsAbTombstoneLifetime, EmsAbTrackingLogPathName, EmsAbTransRetryMins, EmsAbTransTimeoutMins, EmsAbTransferRetryInterval, EmsAbTransferTimeoutNonUrgent, EmsAbTransferTimeoutNormal, EmsAbTransferTimeoutUrgent, EmsAbTranslationTableUsed, EmsAbTransportExpeditedData, EmsAbTrustLevel, EmsAbTurnRequestThreshold, EmsAbTwoWayAlternateFacility, EmsAbType, EmsAbUnauthOrigBl, EmsAbUnauthOrigBlO, EmsAbUseServerValues, EmsAbUseSiteValues, EmsAbUsenetSiteName, EmsAbUserPassword, EmsAbUsnChanged, EmsAbUsnCreated, EmsAbUsnDsaLastObjRemoved, EmsAbUsnIntersite, EmsAbUsnLastObjRem, EmsAbUsnSource, EmsAbViewContainer1, EmsAbViewContainer2, EmsAbViewContainer3, EmsAbViewDefinition, EmsAbViewFlags, EmsAbViewSite, EmsAbVoiceMailFlags, EmsAbVoiceMailGreetings, EmsAbVoiceMailPassword, EmsAbVoiceMailRecordedName, EmsAbVoiceMailRecordingLength, EmsAbVoiceMailSpeed, EmsAbVoiceMailSystemGuid, EmsAbVoiceMailUserId, EmsAbVoiceMailVolume, EmsAbWwwHomePage, EmsAbX121Address, EmsAbX25CallUserDataIncoming, EmsAbX25CallUserDataOutgoing, EmsAbX25FacilitiesDataIncoming, EmsAbX25FacilitiesDataOutgoing, EmsAbX25LeasedLinePort, EmsAbX25LeasedOrSwitched, EmsAbX25RemoteMtaPhone, EmsAbX400AttachmentType, EmsAbX400SelectorSyntax, EmsAbX500AccessControlList, EmsAbX500Nc, EmsAbX500Rdn, EmsAbXmitTimeoutNonUrgent, EmsAbXmitTimeoutNormal, EmsAbXmitTimeoutUrgent, EventsRootFolderEntryid, ExcessStorageUsed, ExtendedAclData, FastTransfer, FavoritesDefaultName, FolderChildCount, FolderDesignFlags, FolderPathname, ForeignId, ForeignReportId, ForeignSubjectId, FreeBusyForLocalSiteEntryid, GwAdminOperations, GwMtsinEntryid, GwMtsoutEntryid, HasModeratorRules, HierarchyServer, HierarchySynchronizer, ImapInternalDate, InTransit, InboundNewsfeedDn, InternetCharset, InternetNewsgroupName, IpmDafEntryid, IpmFavoritesEntryid, IpmPublicFoldersEntryid, IsNewsgroup, IsNewsgroupAnchor, LastAccessTime, LastFullBackup, LastLogoffTime, LastLogonTime, LongtermEntryidFromTable, MessageProcessed, MessageSiteName, MoveToFolderEntryid, MoveToStoreEntryid, MsgBodyId, MtsSubjectId, NewSubsGetAutoAdd, NewsfeedInfo, NewsgroupComponent, NewsgroupRootFolderEntryid, NntpArticleFolderEntryid, NntpControlFolderEntryid, NonIpmSubtreeEntryid, NormalMessageSize, NormalMessageSizeExtended, NormalMsgWAttachCount, NtUserName, OfflineAddrbookEntryid, OfflineFlags, OfflineMessageEntryid, OldestDeletedOn, OriginatorAddr, OriginatorAddrtype, OriginatorEntryid, OriginatorName, OstEncryption, OutboundNewsfeedDn, OverallAgeLimit, OverallMsgAgeLimit, OwaUrl, OwnerCount, P1Content, P1ContentType, PreventMsgCreate, Preview, PreviewUnread, ProfileAbFilesPath, ProfileAddrInfo, ProfileAllpubComment, ProfileAllpubDisplayName, ProfileBindingOrder, ProfileConfigFlags, ProfileConnectFlags, ProfileFavfldComment, ProfileFavfldDisplayName, ProfileHomeServer, ProfileHomeServerAddrs, ProfileHomeServerDn, ProfileMailbox, ProfileMaxRestrict, ProfileMoab, ProfileMoabGuid, ProfileMoabSeq, ProfileOfflineInfo, ProfileOfflineStorePath, ProfileOpenFlags, ProfileOptionsData, ProfileSecureMailbox, ProfileServer, ProfileServerDn, ProfileTransportFlags, ProfileType, ProfileUiState, ProfileUnresolvedName, ProfileUnresolvedServer, ProfileUser, ProfileVersion, PstEncryption, PstPath, PstPwSzOld, PstRememberPw, PublicFolderEntryid, PublishInAddressBook, RecipientNumber, RecipientOnAssocMsgCount, RecipientOnNormalMsgCount, ReplicaList, ReplicaServer, ReplicaVersion, ReplicationAlwaysInterval, ReplicationMessagePriority, ReplicationMsgSize, ReplicationSchedule, ReplicationStyle, ReplyRecipientSmtpProxies, ReportDestinationEntryid, ReportDestinationName, RestrictionCount, RetentionAgeLimit, RuleTriggerHistory, RulesData, RulesTable, ScheduleFolderEntryid, SecureInSite, SecureOrigination, StorageLimitInformation, StorageQuotaLimit, StoreOffline, StoreSlowlink, SubjectTraceInfo, SvrGeneratingQuotaMsg, SynchronizeFlags, SysConfigFolderEntryid, TestLineSpeed, TraceInfo, TransferEnabled, UserName, X400EnvelopeType, AbDefaultDir, AbDefaultPab, AbProviderId, AbProviders, AbSearchPath, AbSearchPathUpdate, AlternateRecipient, AssocContentCount, AttachmentX400Parameters, AuthorizingUsers, BodyCrc, CommonViewsEntryid, ContactAddrtypes, ContactDefaultAddressIndex, ContactEmailAddresses, ContactEntryids, ContactVersion, ContainerModifyVersion, ContentConfidentialityAlgorithmId, ContentCorrelator, ContentIdentifier, ContentIntegrityCheck, ContentLength, ContentReturnRequested, ContentsSortOrder, ControlFlags, ControlId, ControlStructure, ControlType, ConversationKey, ConversionEits, ConversionProhibited, ConversionWithLossProhibited, ConvertedEits, Correlate, CorrelateMtsid, CreateTemplates, CreationVersion, ExCurrentVersion, DefCreateDl, DefCreateMailuser, DefaultProfile, DefaultStore, DefaultViewEntryid, Delegation, DeliveryPoint, Deltax, Deltay, DetailsTable, DiscVal, DiscardReason, DiscloseRecipients, DisclosureOfRecipients, DiscreteValues, DlExpansionHistory, DlExpansionProhibited, ExplicitConversion, FilteringHooks, FinderEntryid, FormCategory, FormCategorySub, FormClsid, FormContactName, FormDesignerGuid, FormDesignerName, FormHidden, FormHostMap, FormMessageBehavior, FormVersion, HeaderFolderEntryid, Icon, IdentityDisplay, IdentityEntryid, IdentitySearchKey, ImplicitConversionProhibited, IncompleteCopy, InternetApproved, InternetArticleNumber, InternetControl, InternetDistribution, InternetFollowupTo, InternetLines, InternetNewsgroups, InternetNntpPath, InternetOrganization, InternetPrecedence, IpmId, IpmOutboxEntryid, IpmOutboxSearchKey, IpmReturnRequested, IpmSentmailEntryid, IpmSentmailSearchKey, IpmSubtreeEntryid, IpmSubtreeSearchKey, IpmWastebasketEntryid, IpmWastebasketSearchKey, Languages, LatestDeliveryTime, MailPermission, MdbProvider, MessageDeliveryId, MessageDownloadTime, MessageSecurityLabel, MessageToken, MiniIcon, ModifyVersion, NewsgroupName, NntpXref, NonReceiptReason, ObsoletedIpms, OriginCheck, OriginalAuthorAddrtype, OriginalAuthorEmailAddress, OriginalAuthorSearchKey, OriginalDisplayName, OriginalEits, OriginalSearchKey, OriginallyIntendedRecipAddrtype, OriginallyIntendedRecipEmailAddress, OriginallyIntendedRecipEntryid, OriginallyIntendedRecipientName, OriginatingMtaCertificate, OriginatorAndDlExpansionHistory, OriginatorCertificate, OriginatorRequestedAlternateRecipient, OriginatorReturnAddress, OwnStoreEntryid, ParentDisplay, PhysicalDeliveryBureauFaxDelivery, PhysicalDeliveryMode, PhysicalDeliveryReportRequest, PhysicalForwardingAddress, PhysicalForwardingAddressRequested, PhysicalForwardingProhibited, PhysicalRenditionAttributes, PostFolderEntries, PostFolderNames, PostReplyDenied, PostReplyFolderEntries, PostReplyFolderNames, Preprocess, PrimaryCapability, ProfileName, ProofOfDelivery, ProofOfDeliveryRequested, ProofOfSubmission, ProofOfSubmissionRequested, ProviderDisplay, ProviderDllName, ProviderOrdinal, ProviderSubmitTime, ProviderUid, ReceiveFolderSettings, RecipientCertificate, RecipientNumberForAdvice, RecipientStatus, RedirectionHistory, RegisteredMailType, RelatedIpms, RemoteProgress, RemoteProgressText, RemoteValidateOk, ReportingDlName, ReportingMtaCertificate, RequestedDeliveryMethod, ResourceFlags, ResourceMethods, ResourcePath, ResourceType, ReturnedIpm, RtfSyncBodyCount, RtfSyncBodyCrc, RtfSyncBodyTag, RtfSyncPrefixCount, RtfSyncTrailingCount, Search, ExSecurity, SentmailEntryid, ServiceDeleteFiles, ServiceDllName, ServiceEntryName, ServiceExtraUids, ServiceName, ServiceSupportFiles, ServiceUid, Services, SpoolerStatus, Status, StatusCode, StatusString, StoreProviders, StoreRecordKey, SubjectIpm, SubmitFlags, Supersedes, TransportKey, TransportProviders, TransportStatus, TypeOfMtsUser, ValidFolderMask, ViewsEntryid, X400ContentType, X400DeferredDeliveryCancel, Xpos, Ypos | - -Parent class: [MapiPropertyDescriptor](MapiPropertyDescriptor.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiLegacyFreeBusyPropertyDto.md b/sdk/docs/MapiLegacyFreeBusyPropertyDto.md deleted file mode 100644 index 24ed391..0000000 --- a/sdk/docs/MapiLegacyFreeBusyPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiLegacyFreeBusyPropertyDto - -Mapi property with LegacyFreeBusyType value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Represents the free/busy status for a calendar event. Enum, available values: Free, Tentative, Busy, Oof, WorkingElsewhere, NoData | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMessageApi.md b/sdk/docs/MapiMessageApi.md deleted file mode 100644 index 7e6e9b7..0000000 --- a/sdk/docs/MapiMessageApi.md +++ /dev/null @@ -1,627 +0,0 @@ -# AsposeEmailCloudSdk.MapiMessageApi (EmailCloud.mapi.message) - -MAPI message operations - - -## as_email_dto - -Description: Converts MAPI message model to EmailDto model - -Returns: EmailDto model - -Method call example: -```python -result = api.mapi.message.as_email_dto(mapi_message) -``` - -### Parameter: mapi_message - -Description: MAPI message model to convert - -See parameter model documentation at [MapiMessageDto](MapiMessageDto.md) - -
- Parameter initialization example: - -```python -mapi_message = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` - -
- -### Result - -Description: EmailDto model - -Return type: [**EmailDto**](EmailDto.md) - -
- Result example - -```python -result = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -mapi_message = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') - -// Call method: -result = api.mapi.message.as_email_dto(mapi_message) - -// Result example: -result = models.EmailDto( - attachments=[ - models.Attachment( - name='some-file.txt', - base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], - body='Some body', - body_type='Html', - delivery_notification_options=[ - 'OnSuccess', - 'Delay'], - _from=models.MailAddress( - display_name='From Address', - address='from@aspose.com'), - html_body='Some body', - is_body_html=True, - is_draft=True, - subject='Re: Some subject', - to=[ - models.MailAddress( - display_name='To Address', - address='to@aspose.com')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## as_file - -Description: Converts MAPI message model to specified format and returns as file. - -Returns: File stream in specified format. - -Method call example: -```python -result = api.mapi.message.as_file(request) -``` - -### Parameter: request - -Description: MAPI message model to convert. - -See parameter model documentation at [MapiMessageAsFileRequest](MapiMessageAsFileRequest.md) - -
- Parameter initialization example: - -```python -request = models.MapiMessageAsFileRequest( - format='Msg', - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) -``` - -
- -### Result - -Description: File stream in specified format. - -Return type: **Stream** - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiMessageAsFileRequest( - format='Msg', - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) - -// Call method: -result = api.mapi.message.as_file(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## from_file - -Description: Converts email file to a MAPI model representation - -Returns: MAPI model - -Method call example: -```python -result = api.mapi.message.from_file(request) -``` - -### Parameter: request - -Description: from_file method request. - -See parameter model documentation at [MapiMessageFromFileRequest](MapiMessageFromFileRequest.md). - -
- Parameter initialization example: - -```python -request = models.MapiMessageFromFileRequest( - format='Msg', - file='/path/to/message.msg') -``` - -
- -### Result - -Description: MAPI model - -Return type: [**MapiMessageDto**](MapiMessageDto.md) - -
- Result example - -```python -result = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiMessageFromFileRequest( - format='Msg', - file='/path/to/message.msg') - -// Call method: -result = api.mapi.message.from_file(request) - -// Result example: -result = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get - -Description: Get MAPI message document. - -Returns: MAPI message document. - -Method call example: -```python -result = api.mapi.message.get(request) -``` - -### Parameter: request - -Description: get method request. - -See parameter model documentation at [MapiMessageGetRequest](MapiMessageGetRequest.md). - -
- Parameter initialization example: - -```python -request = models.MapiMessageGetRequest( - format='Eml', - file_name='email.eml', - folder='folder/on/storage', - storage='First Storage') -``` - -
- -### Result - -Description: MAPI message document. - -Return type: [**MapiMessageDto**](MapiMessageDto.md) - -
- Result example - -```python -result = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiMessageGetRequest( - format='Eml', - file_name='email.eml', - folder='folder/on/storage', - storage='First Storage') - -// Call method: -result = api.mapi.message.get(request) - -// Result example: -result = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## save - -Description: Save MAPI message to storage. - -Method call example: -```python -api.mapi.message.save(request) -``` - -### Parameter: request - -Description: Message create/update request. - -See parameter model documentation at [MapiMessageSaveRequest](MapiMessageSaveRequest.md) - -
- Parameter initialization example: - -```python -request = models.MapiMessageSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='message.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) -``` - -
- -### Result - -Return type: void (empty response body) - -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.MapiMessageSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='message.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) - -// Call method: -api.mapi.message.save(request) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMessageApi_list.md b/sdk/docs/MapiMessageApi_list.md deleted file mode 100644 index 0dcf87e..0000000 --- a/sdk/docs/MapiMessageApi_list.md +++ /dev/null @@ -1,11 +0,0 @@ -## Documentation for MapiMessageApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**as_email_dto**](MapiMessageApi.md#as_email_dto)| **PUT** /email/MapiMessage/as-email-dto| Converts MAPI message model to EmailDto model -[**as_file**](MapiMessageApi.md#as_file)| **PUT** /email/MapiMessage/as-file| Converts MAPI message model to specified format and returns as file. -[**from_file**](MapiMessageApi.md#from_file)| **PUT** /email/MapiMessage/from-file| Converts email file to a MAPI model representation -[**get**](MapiMessageApi.md#get)| **GET** /email/MapiMessage| Get MAPI message document. -[**save**](MapiMessageApi.md#save)| **PUT** /email/MapiMessage| Save MAPI message to storage. diff --git a/sdk/docs/MapiMessageAsFileRequest.md b/sdk/docs/MapiMessageAsFileRequest.md deleted file mode 100644 index 55268a5..0000000 --- a/sdk/docs/MapiMessageAsFileRequest.md +++ /dev/null @@ -1,49 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiMessageAsFileRequest - -Convert MapiMessage to file request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**value** |[**MapiMessageDto**](MapiMessageDto.md) |MAPI message model. | - - - -## Example -```python -mapi_message_as_file_request = models.MapiMessageAsFileRequest( - format='Msg', - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMessageDto.md b/sdk/docs/MapiMessageDto.md deleted file mode 100644 index 0f56ecd..0000000 --- a/sdk/docs/MapiMessageDto.md +++ /dev/null @@ -1,71 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiMessageDto - -Represents an Outlook Message format document. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message_body** |**str** |Message text |[optional] -**client_submit_time** |**datetime** |Date and time the message sender submitted a message. | -**conversation_topic** |**str** |Topic of the first message in a conversation thread. |[optional] -**delivery_time** |**datetime** |Date and time a message was delivered. | -**display_bcc** |**str** |List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). |[optional] -**display_cc** |**str** |List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). |[optional] -**display_name** |**str** |Display name for the message. |[optional] -**display_name_prefix** |**str** |Prefix of the display name. |[optional] -**display_to** |**str** |List of the display names of the primary (To) message recipients, separated by semicolons (;). |[optional] -**flags** |**list[str]** |Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt |[optional] -**headers** |**dict(str, str)** |Transport message headers |[optional] -**internet_message_id** |**str** |Internet message id of the message. |[optional] -**message_format** |**str** |Represents outlook message format. Enum, available values: Ascii, Unicode | -**normalized_subject** |**str** |Normalized subject of the message. |[optional] -**read_receipt_requested** |**bool** |Value indicating whether the read receipt is requested. | -**reply_to** |**str** |Reply to names. |[optional] -**sender_address_type** |**str** |Message sender's e-mail address type. |[optional] -**sender_email_address** |**str** |Message sender's e-mail address. |[optional] -**sender_name** |**str** |Message sender's display name. |[optional] -**sender_smtp_address** |**str** |Message sender's e-mail address. |[optional] -**sent_representing_address_type** |**str** |Address type for the messaging user represented by the sender. |[optional] -**sent_representing_email_address** |**str** |E-mail address for the messaging user represented by the sender. |[optional] -**sent_representing_name** |**str** |Display name for the messaging user represented by the sender. |[optional] -**sent_representing_smtp_address** |**str** |E-mail address for the messaging user represented by the sender. |[optional] -**transport_message_headers** |**str** |Transport-specific message envelope information. |[optional] - -Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) - - -## Example -```python -mapi_message_dto = models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMessageFromFileRequest.md b/sdk/docs/MapiMessageFromFileRequest.md deleted file mode 100644 index 357c980..0000000 --- a/sdk/docs/MapiMessageFromFileRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# MapiMessageFromFileRequest - -Request model for MapiMessageApi.from_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**file** |**str** |File to convert | - -## Example -```python -request = models.MapiMessageFromFileRequest( - format='Msg', - file='/path/to/message.msg') -``` diff --git a/sdk/docs/MapiMessageGetRequest.md b/sdk/docs/MapiMessageGetRequest.md deleted file mode 100644 index 15f7fef..0000000 --- a/sdk/docs/MapiMessageGetRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# MapiMessageGetRequest - -Request model for MapiMessageApi.get - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**file_name** |**str** |Email document file name. | -**folder** |**str** |Path to folder in storage. |[optional] -**storage** |**str** |Storage name. |[optional] - -## Example -```python -request = models.MapiMessageGetRequest( - format='Eml', - file_name='email.eml', - folder='folder/on/storage', - storage='First Storage') -``` diff --git a/sdk/docs/MapiMessageItemBaseDto.md b/sdk/docs/MapiMessageItemBaseDto.md deleted file mode 100644 index cc71a6b..0000000 --- a/sdk/docs/MapiMessageItemBaseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiMessageItemBaseDto - -Base Dto for MapiMessage, MapiCalendar or MapiContact - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachments** |[**list[MapiAttachmentDto]**](MapiAttachmentDto.md) |Message item attachments. |[optional] -**billing** |**str** |Billing information associated with an item. |[optional] -**body** |**str** |Message text. |[optional] -**body_html** |**str** |Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. |[optional] -**body_rtf** |**str** |RTF formatted message text. |[optional] -**body_type** |**str** |The content type of message body. Enum, available values: PlainText, Html, Rtf | -**categories** |**list[str]** |Contains keywords or categories for the message object. |[optional] -**companies** |**list[str]** |Contains the names of the companies that are associated with an item. |[optional] -**item_id** |**str** |The item id, uses with a server. |[optional] -**message_class** |**str** |Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. |[optional] -**mileage** |**str** |Contains the mileage information that is associated with an item. |[optional] -**recipients** |[**list[MapiRecipientDto]**](MapiRecipientDto.md) |Recipients of the message. |[optional] -**sensitivity** |**str** |Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential | -**subject** |**str** |Subject of the message. |[optional] -**subject_prefix** |**str** |Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding. |[optional] -**properties** |[**list[MapiPropertyDto]**](MapiPropertyDto.md) |List of MAPI properties |[optional] -**discriminator** |**str** | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMessageSaveRequest.md b/sdk/docs/MapiMessageSaveRequest.md deleted file mode 100644 index 7859f5e..0000000 --- a/sdk/docs/MapiMessageSaveRequest.md +++ /dev/null @@ -1,53 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiMessageSaveRequest - -MapiMessage save to storage request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - -Parent class: [StorageModelOfMapiMessageDto](StorageModelOfMapiMessageDto.md) - - -## Example -```python -mapi_message_save_request = models.MapiMessageSaveRequest( - format='Msg', - storage_file=models.StorageFileLocation( - file_name='message.msg', - storage='First Storage', - folder_path='file/location/folder/on/storage'), - value=models.MapiMessageDto( - message_body='Some body', - client_submit_time=datetime.today(), - delivery_time=datetime.today(), - display_to='To Address', - flags=[ - 'MsgFlagRead', - 'MsgFlagUnsent', - 'MsgFlagHasAttach'], - normalized_subject='Some subject', - sender_address_type='SMTP', - sender_email_address='from@aspose.com', - sender_name='From Address', - sender_smtp_address='from@aspose.com', - attachments=[ - models.MapiAttachmentDto( - name='some-file.txt', - data_base64='U29tZSBmaWxlIHRleHQ=')], - body='Some body', - message_class='IPM.Note', - recipients=[ - models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo')], - subject='Re: Some subject', - subject_prefix='Re: ')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMultiIntPropertyDto.md b/sdk/docs/MapiMultiIntPropertyDto.md deleted file mode 100644 index 0f9cad4..0000000 --- a/sdk/docs/MapiMultiIntPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiMultiIntPropertyDto - -Mapi property with Multiple Integer values - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**values** |**list[int]** |Property values |[optional] - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiMultiStringPropertyDto.md b/sdk/docs/MapiMultiStringPropertyDto.md deleted file mode 100644 index 5c279ff..0000000 --- a/sdk/docs/MapiMultiStringPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiMultiStringPropertyDto - -Mapi property with Multiple String values - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**values** |**list[str]** |Property values |[optional] - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md b/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md deleted file mode 100644 index 6730e57..0000000 --- a/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPhysicalAddressIndexPropertyDto - -Mapi property with PhysicalAddressIndexType value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Identifies the display types for physical addresses. Enum, available values: None, Home, Business, Other | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPidLidPropertyDescriptor.md b/sdk/docs/MapiPidLidPropertyDescriptor.md deleted file mode 100644 index 0e322ce..0000000 --- a/sdk/docs/MapiPidLidPropertyDescriptor.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPidLidPropertyDescriptor - -Property identified by an unsigned 32-bit quantity along with a property set - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**long_id** |**int** |An unsigned 32-bit quantity that, along with the property set, identifies a named property. | -**property_set** |**str** |A GUID that identifies a group of properties with a similar purpose. | - -Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPidNamePropertyDescriptor.md b/sdk/docs/MapiPidNamePropertyDescriptor.md deleted file mode 100644 index 0a8be7f..0000000 --- a/sdk/docs/MapiPidNamePropertyDescriptor.md +++ /dev/null @@ -1,15 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPidNamePropertyDescriptor - -Property identified by a string name along with a property set - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**property_set** |**str** |A GUID that identifies a group of properties with a similar purpose. | - -Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPidPropertyDescriptor.md b/sdk/docs/MapiPidPropertyDescriptor.md deleted file mode 100644 index f309cc7..0000000 --- a/sdk/docs/MapiPidPropertyDescriptor.md +++ /dev/null @@ -1,18 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPidPropertyDescriptor - -Mapi pid property descriptor base class - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**canonical_name** |**str** |The name used to refer to the property in the documentation. The prefix of the canonical name identifies the basic characteristics of a property to the implementer. The canonical naming structure uses three categories that are denoted by the following prefixes to the canonical property name: * PidLid prefix: Properties identified by an unsigned 32-bit quantity along with a property set. * PidName prefix: Properties identified by a string name along with a property set. * PidTag prefix: Properties identified by an unsigned 16-bit quantity. |[optional] -**data_type** |**str** |[MS-OXCDATA]: Data Structures Enum, available values: Unspecified, Null, Integer16, Integer32, Floating32, Floating64, Currency, FloatingTime, ErrorCode, Boolean, Integer64, String, String8, Time, Guid, ServerId, Restriction, RuleAction, Binary, MultipleInteger16, MultipleInteger32, MultipleFloating32, MultipleFloating64, MultipleCurrency, MultipleFloatingTime, MultipleBoolean, MultipleInteger64, MultipleString, MultipleString8, MultipleTime, MultipleGuid, MultipleBinary, Object | -**multiple_values_data_type** |**bool** |Indicates if data type contains of multiple values | -**name** |**str** |A string that identifies the property |[optional] - -Parent class: [MapiPropertyDescriptor](MapiPropertyDescriptor.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPidTagPropertyDescriptor.md b/sdk/docs/MapiPidTagPropertyDescriptor.md deleted file mode 100644 index ea3a671..0000000 --- a/sdk/docs/MapiPidTagPropertyDescriptor.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPidTagPropertyDescriptor - -A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 - 0x7FFF. Property IDs in the range 0x8000 - 0x8FFF are reserved for assignment to named properties - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** |**int** |An unsigned 16-bit quantity that identifies a tagged property. Property IDs are not necessarily unique. With the exception of property IDs in the range from 0x6800 to 0x7BFF, the combination of property ID and data type are unique. Property IDs in the range from 0x6800 to 0x7BFF are defined by the message class. | -**tag** |**int** |A property tag is a 32-bit number that contains a unique property identifier in bits 16 through 31 and a property type in bits 0 through 15. | - -Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPropertyDescriptor.md b/sdk/docs/MapiPropertyDescriptor.md deleted file mode 100644 index 38f5062..0000000 --- a/sdk/docs/MapiPropertyDescriptor.md +++ /dev/null @@ -1,20 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPropertyDescriptor - -Mapi property descriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**discriminator** |**str** | | - - - -## Example -```python -mapi_property_descriptor = models.MapiPropertyDescriptor( - ) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiPropertyDto.md b/sdk/docs/MapiPropertyDto.md deleted file mode 100644 index c8df300..0000000 --- a/sdk/docs/MapiPropertyDto.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiPropertyDto - -Mapi property - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**descriptor** |[**MapiPropertyDescriptor**](MapiPropertyDescriptor.md) |Property descriptor |[optional] -**discriminator** |**str** | | - - - -## Example -```python -mapi_property_dto = models.MapiPropertyDto( - descriptor=models.MapiKnownPropertyDescriptor( - name='DisplayName')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiRecipientDto.md b/sdk/docs/MapiRecipientDto.md deleted file mode 100644 index ee2c454..0000000 --- a/sdk/docs/MapiRecipientDto.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiRecipientDto - -Represents the recipient information in the Microsoft Outlook Message. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email_address** |**str** |Email address of the message recipient or sender. |[optional] -**address_type** |**str** |Type of the address of the message recipient or sender. |[optional] -**display_name** |**str** |Display name of the message recipient or sender. |[optional] -**recipient_type** |**str** |Represent the PR_RECIPIENT_TYPE property which contains the recipient type for a message recipient. Enum, available values: Unknown, MapiBcc, MapiCc, MapiP1, MapiSubmitted, MapiTo | - - - -## Example -```python -mapi_recipient_dto = models.MapiRecipientDto( - email_address='to@aspose.com', - address_type='SMTP', - display_name='To Address', - recipient_type='MapiTo') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiResponseTypePropertyDto.md b/sdk/docs/MapiResponseTypePropertyDto.md deleted file mode 100644 index e89bb43..0000000 --- a/sdk/docs/MapiResponseTypePropertyDto.md +++ /dev/null @@ -1,23 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiResponseTypePropertyDto - -Mapi property with response type value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Represents the types of recipient responses that are received for a meeting. Enum, available values: Unknown, Organizer, Tentative, Accept, Decline, NoResponseReceived | - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - -## Example -```python -mapi_response_type_property_dto = models.MapiResponseTypePropertyDto( - value='Accept', - descriptor=models.MapiKnownPropertyDescriptor( - name='ResponseStatus')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MapiStringPropertyDto.md b/sdk/docs/MapiStringPropertyDto.md deleted file mode 100644 index dbd5e10..0000000 --- a/sdk/docs/MapiStringPropertyDto.md +++ /dev/null @@ -1,23 +0,0 @@ -# AsposeEmailCloudSdk.models.MapiStringPropertyDto - -Mapi property with string value - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** |Property value |[optional] - -Parent class: [MapiPropertyDto](MapiPropertyDto.md) - - -## Example -```python -mapi_string_property_dto = models.MapiStringPropertyDto( - value='SomeName', - descriptor=models.MapiKnownPropertyDescriptor( - name='DisplayName')) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/Models.md b/sdk/docs/Models.md deleted file mode 100644 index bbfcf5f..0000000 --- a/sdk/docs/Models.md +++ /dev/null @@ -1,248 +0,0 @@ -## Documentation for Models - -- [AsposeEmailCloudSdk.models.AiBcrImage](AiBcrImage.md) -- [AsposeEmailCloudSdk.models.AiBcrOptions](AiBcrOptions.md) -- [AsposeEmailCloudSdk.models.AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) -- [AsposeEmailCloudSdk.models.AiNameComponent](AiNameComponent.md) -- [AsposeEmailCloudSdk.models.AiNameCulturalContext](AiNameCulturalContext.md) -- [AsposeEmailCloudSdk.models.AiNameExtracted](AiNameExtracted.md) -- [AsposeEmailCloudSdk.models.AiNameExtractedComponent](AiNameExtractedComponent.md) -- [AsposeEmailCloudSdk.models.AiNameFormatted](AiNameFormatted.md) -- [AsposeEmailCloudSdk.models.AiNameGenderHypothesis](AiNameGenderHypothesis.md) -- [AsposeEmailCloudSdk.models.AiNameMatchResult](AiNameMatchResult.md) -- [AsposeEmailCloudSdk.models.AiNameMismatch](AiNameMismatch.md) -- [AsposeEmailCloudSdk.models.AiNameParsedRequest](AiNameParsedRequest.md) -- [AsposeEmailCloudSdk.models.AiNameWeighted](AiNameWeighted.md) -- [AsposeEmailCloudSdk.models.AiNameWeightedVariants](AiNameWeightedVariants.md) -- [AsposeEmailCloudSdk.models.AssociatedPerson](AssociatedPerson.md) -- [AsposeEmailCloudSdk.models.AttachmentBase](AttachmentBase.md) -- [AsposeEmailCloudSdk.models.CalendarAsAlternateRequest](CalendarAsAlternateRequest.md) -- [AsposeEmailCloudSdk.models.CalendarAsFileRequest](CalendarAsFileRequest.md) -- [AsposeEmailCloudSdk.models.CalendarDto](CalendarDto.md) -- [AsposeEmailCloudSdk.models.CalendarReminder](CalendarReminder.md) -- [AsposeEmailCloudSdk.models.ClientAccountBaseRequest](ClientAccountBaseRequest.md) -- [AsposeEmailCloudSdk.models.ContactAsFileRequest](ContactAsFileRequest.md) -- [AsposeEmailCloudSdk.models.ContactDto](ContactDto.md) -- [AsposeEmailCloudSdk.models.ContactPhoto](ContactPhoto.md) -- [AsposeEmailCloudSdk.models.ContentType](ContentType.md) -- [AsposeEmailCloudSdk.models.ContentTypeParameter](ContentTypeParameter.md) -- [AsposeEmailCloudSdk.models.CustomerEvent](CustomerEvent.md) -- [AsposeEmailCloudSdk.models.DiscUsage](DiscUsage.md) -- [AsposeEmailCloudSdk.models.DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) -- [AsposeEmailCloudSdk.models.EmailAccountConfig](EmailAccountConfig.md) -- [AsposeEmailCloudSdk.models.EmailAddress](EmailAddress.md) -- [AsposeEmailCloudSdk.models.EmailAsFileRequest](EmailAsFileRequest.md) -- [AsposeEmailCloudSdk.models.EmailClientAccount](EmailClientAccount.md) -- [AsposeEmailCloudSdk.models.EmailClientAccountCredentials](EmailClientAccountCredentials.md) -- [AsposeEmailCloudSdk.models.EmailClientMultiAccount](EmailClientMultiAccount.md) -- [AsposeEmailCloudSdk.models.EmailDto](EmailDto.md) -- [AsposeEmailCloudSdk.models.EmailThread](EmailThread.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfAssociatedPersonCategory](EnumWithCustomOfAssociatedPersonCategory.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfEmailAddressCategory](EnumWithCustomOfEmailAddressCategory.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfEventCategory](EnumWithCustomOfEventCategory.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfInstantMessengerCategory](EnumWithCustomOfInstantMessengerCategory.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfPhoneNumberCategory](EnumWithCustomOfPhoneNumberCategory.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfPostalAddressCategory](EnumWithCustomOfPostalAddressCategory.md) -- [AsposeEmailCloudSdk.models.EnumWithCustomOfUrlCategory](EnumWithCustomOfUrlCategory.md) -- [AsposeEmailCloudSdk.models.Error](Error.md) -- [AsposeEmailCloudSdk.models.ErrorDetails](ErrorDetails.md) -- [AsposeEmailCloudSdk.models.FileVersions](FileVersions.md) -- [AsposeEmailCloudSdk.models.FilesList](FilesList.md) -- [AsposeEmailCloudSdk.models.FilesUploadResult](FilesUploadResult.md) -- [AsposeEmailCloudSdk.models.InstantMessengerAddress](InstantMessengerAddress.md) -- [AsposeEmailCloudSdk.models.ListResponseOfAiNameComponent](ListResponseOfAiNameComponent.md) -- [AsposeEmailCloudSdk.models.ListResponseOfAiNameExtracted](ListResponseOfAiNameExtracted.md) -- [AsposeEmailCloudSdk.models.ListResponseOfAiNameGenderHypothesis](ListResponseOfAiNameGenderHypothesis.md) -- [AsposeEmailCloudSdk.models.ListResponseOfContactDto](ListResponseOfContactDto.md) -- [AsposeEmailCloudSdk.models.ListResponseOfEmailAccountConfig](ListResponseOfEmailAccountConfig.md) -- [AsposeEmailCloudSdk.models.ListResponseOfEmailDto](ListResponseOfEmailDto.md) -- [AsposeEmailCloudSdk.models.ListResponseOfEmailThread](ListResponseOfEmailThread.md) -- [AsposeEmailCloudSdk.models.ListResponseOfMailMessageBase](ListResponseOfMailMessageBase.md) -- [AsposeEmailCloudSdk.models.ListResponseOfMailServerFolder](ListResponseOfMailServerFolder.md) -- [AsposeEmailCloudSdk.models.ListResponseOfStorageFileLocation](ListResponseOfStorageFileLocation.md) -- [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfCalendarDto](ListResponseOfStorageModelOfCalendarDto.md) -- [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfContactDto](ListResponseOfStorageModelOfContactDto.md) -- [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfEmailDto](ListResponseOfStorageModelOfEmailDto.md) -- [AsposeEmailCloudSdk.models.MailAddress](MailAddress.md) -- [AsposeEmailCloudSdk.models.MailMessageBase](MailMessageBase.md) -- [AsposeEmailCloudSdk.models.MailServerFolder](MailServerFolder.md) -- [AsposeEmailCloudSdk.models.MapiAttachmentDto](MapiAttachmentDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarAsFileRequest](MapiCalendarAsFileRequest.md) -- [AsposeEmailCloudSdk.models.MapiCalendarAttendeesDto](MapiCalendarAttendeesDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarEventRecurrenceDto](MapiCalendarEventRecurrenceDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarExceptionInfoDto](MapiCalendarExceptionInfoDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneDto](MapiCalendarTimeZoneDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneInfoDto](MapiCalendarTimeZoneInfoDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneRuleDto](MapiCalendarTimeZoneRuleDto.md) -- [AsposeEmailCloudSdk.models.MapiContactAsFileRequest](MapiContactAsFileRequest.md) -- [AsposeEmailCloudSdk.models.MapiContactElectronicAddressDto](MapiContactElectronicAddressDto.md) -- [AsposeEmailCloudSdk.models.MapiContactElectronicAddressPropertySetDto](MapiContactElectronicAddressPropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactEventPropertySetDto](MapiContactEventPropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactNamePropertySetDto](MapiContactNamePropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactOtherPropertySetDto](MapiContactOtherPropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactPersonalInfoPropertySetDto](MapiContactPersonalInfoPropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactPhysicalAddressDto](MapiContactPhysicalAddressDto.md) -- [AsposeEmailCloudSdk.models.MapiContactPhysicalAddressPropertySetDto](MapiContactPhysicalAddressPropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactProfessionalPropertySetDto](MapiContactProfessionalPropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiContactTelephonePropertySetDto](MapiContactTelephonePropertySetDto.md) -- [AsposeEmailCloudSdk.models.MapiElectronicAddressDto](MapiElectronicAddressDto.md) -- [AsposeEmailCloudSdk.models.MapiMessageAsFileRequest](MapiMessageAsFileRequest.md) -- [AsposeEmailCloudSdk.models.MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) -- [AsposeEmailCloudSdk.models.MapiPropertyDescriptor](MapiPropertyDescriptor.md) -- [AsposeEmailCloudSdk.models.MapiPropertyDto](MapiPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiRecipientDto](MapiRecipientDto.md) -- [AsposeEmailCloudSdk.models.NameValuePair](NameValuePair.md) -- [AsposeEmailCloudSdk.models.ObjectExist](ObjectExist.md) -- [AsposeEmailCloudSdk.models.PhoneNumber](PhoneNumber.md) -- [AsposeEmailCloudSdk.models.PostalAddress](PostalAddress.md) -- [AsposeEmailCloudSdk.models.RecurrencePatternDto](RecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.ReminderAttendee](ReminderAttendee.md) -- [AsposeEmailCloudSdk.models.ReminderTrigger](ReminderTrigger.md) -- [AsposeEmailCloudSdk.models.StorageExist](StorageExist.md) -- [AsposeEmailCloudSdk.models.StorageFile](StorageFile.md) -- [AsposeEmailCloudSdk.models.StorageFolderLocation](StorageFolderLocation.md) -- [AsposeEmailCloudSdk.models.StorageModelOfCalendarDto](StorageModelOfCalendarDto.md) -- [AsposeEmailCloudSdk.models.StorageModelOfContactDto](StorageModelOfContactDto.md) -- [AsposeEmailCloudSdk.models.StorageModelOfEmailClientAccount](StorageModelOfEmailClientAccount.md) -- [AsposeEmailCloudSdk.models.StorageModelOfEmailClientMultiAccount](StorageModelOfEmailClientMultiAccount.md) -- [AsposeEmailCloudSdk.models.StorageModelOfEmailDto](StorageModelOfEmailDto.md) -- [AsposeEmailCloudSdk.models.StorageModelOfMapiCalendarDto](StorageModelOfMapiCalendarDto.md) -- [AsposeEmailCloudSdk.models.StorageModelOfMapiContactDto](StorageModelOfMapiContactDto.md) -- [AsposeEmailCloudSdk.models.StorageModelOfMapiMessageDto](StorageModelOfMapiMessageDto.md) -- [AsposeEmailCloudSdk.models.Url](Url.md) -- [AsposeEmailCloudSdk.models.ValueTOfBoolean](ValueTOfBoolean.md) -- [AsposeEmailCloudSdk.models.ValueTOfString](ValueTOfString.md) -- [AsposeEmailCloudSdk.models.AiBcrImageStorageFile](AiBcrImageStorageFile.md) -- [AsposeEmailCloudSdk.models.AiNameComponentList](AiNameComponentList.md) -- [AsposeEmailCloudSdk.models.AiNameExtractedList](AiNameExtractedList.md) -- [AsposeEmailCloudSdk.models.AiNameGenderHypothesisList](AiNameGenderHypothesisList.md) -- [AsposeEmailCloudSdk.models.AiNameMatchParsedRequest](AiNameMatchParsedRequest.md) -- [AsposeEmailCloudSdk.models.AlternateView](AlternateView.md) -- [AsposeEmailCloudSdk.models.Attachment](Attachment.md) -- [AsposeEmailCloudSdk.models.CalendarSaveRequest](CalendarSaveRequest.md) -- [AsposeEmailCloudSdk.models.CalendarStorageList](CalendarStorageList.md) -- [AsposeEmailCloudSdk.models.ClientAccountSaveMultiRequest](ClientAccountSaveMultiRequest.md) -- [AsposeEmailCloudSdk.models.ClientAccountSaveRequest](ClientAccountSaveRequest.md) -- [AsposeEmailCloudSdk.models.ClientFolderCreateRequest](ClientFolderCreateRequest.md) -- [AsposeEmailCloudSdk.models.ClientFolderDeleteRequest](ClientFolderDeleteRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageAppendRequest](ClientMessageAppendRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageBaseRequest](ClientMessageBaseRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageSendRequest](ClientMessageSendRequest.md) -- [AsposeEmailCloudSdk.models.ClientThreadBaseRequest](ClientThreadBaseRequest.md) -- [AsposeEmailCloudSdk.models.ContactList](ContactList.md) -- [AsposeEmailCloudSdk.models.ContactSaveRequest](ContactSaveRequest.md) -- [AsposeEmailCloudSdk.models.ContactStorageList](ContactStorageList.md) -- [AsposeEmailCloudSdk.models.DailyRecurrencePatternDto](DailyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.EmailAccountConfigList](EmailAccountConfigList.md) -- [AsposeEmailCloudSdk.models.EmailClientAccountOauthCredentials](EmailClientAccountOauthCredentials.md) -- [AsposeEmailCloudSdk.models.EmailClientAccountPasswordCredentials](EmailClientAccountPasswordCredentials.md) -- [AsposeEmailCloudSdk.models.EmailConfigDiscoverOauthRequest](EmailConfigDiscoverOauthRequest.md) -- [AsposeEmailCloudSdk.models.EmailConfigDiscoverPasswordRequest](EmailConfigDiscoverPasswordRequest.md) -- [AsposeEmailCloudSdk.models.EmailList](EmailList.md) -- [AsposeEmailCloudSdk.models.EmailSaveRequest](EmailSaveRequest.md) -- [AsposeEmailCloudSdk.models.EmailStorageList](EmailStorageList.md) -- [AsposeEmailCloudSdk.models.EmailThreadList](EmailThreadList.md) -- [AsposeEmailCloudSdk.models.FileVersion](FileVersion.md) -- [AsposeEmailCloudSdk.models.LinkedResource](LinkedResource.md) -- [AsposeEmailCloudSdk.models.MailMessageBase64](MailMessageBase64.md) -- [AsposeEmailCloudSdk.models.MailMessageBaseList](MailMessageBaseList.md) -- [AsposeEmailCloudSdk.models.MailMessageDto](MailMessageDto.md) -- [AsposeEmailCloudSdk.models.MailMessageMapi](MailMessageMapi.md) -- [AsposeEmailCloudSdk.models.MailServerFolderList](MailServerFolderList.md) -- [AsposeEmailCloudSdk.models.MapiBinaryPropertyDto](MapiBinaryPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiBooleanPropertyDto](MapiBooleanPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarDailyRecurrencePatternDto](MapiCalendarDailyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarDto](MapiCalendarDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarSaveRequest](MapiCalendarSaveRequest.md) -- [AsposeEmailCloudSdk.models.MapiCalendarWeeklyRecurrencePatternDto](MapiCalendarWeeklyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.MapiCalendarYearlyAndMonthlyRecurrencePatternDto](MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.MapiContactDto](MapiContactDto.md) -- [AsposeEmailCloudSdk.models.MapiContactPhotoDto](MapiContactPhotoDto.md) -- [AsposeEmailCloudSdk.models.MapiContactSaveRequest](MapiContactSaveRequest.md) -- [AsposeEmailCloudSdk.models.MapiDateTimePropertyDto](MapiDateTimePropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiFileAsPropertyDto](MapiFileAsPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiImportancePropertyDto](MapiImportancePropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiIntPropertyDto](MapiIntPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiKnownPropertyDescriptor](MapiKnownPropertyDescriptor.md) -- [AsposeEmailCloudSdk.models.MapiLegacyFreeBusyPropertyDto](MapiLegacyFreeBusyPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiMessageDto](MapiMessageDto.md) -- [AsposeEmailCloudSdk.models.MapiMessageSaveRequest](MapiMessageSaveRequest.md) -- [AsposeEmailCloudSdk.models.MapiMultiIntPropertyDto](MapiMultiIntPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiMultiStringPropertyDto](MapiMultiStringPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiPhysicalAddressIndexPropertyDto](MapiPhysicalAddressIndexPropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) -- [AsposeEmailCloudSdk.models.MapiResponseTypePropertyDto](MapiResponseTypePropertyDto.md) -- [AsposeEmailCloudSdk.models.MapiStringPropertyDto](MapiStringPropertyDto.md) -- [AsposeEmailCloudSdk.models.MonthlyRecurrencePatternDto](MonthlyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.StorageFileLocation](StorageFileLocation.md) -- [AsposeEmailCloudSdk.models.StorageFileLocationList](StorageFileLocationList.md) -- [AsposeEmailCloudSdk.models.TaskRegeneratingPatternDto](TaskRegeneratingPatternDto.md) -- [AsposeEmailCloudSdk.models.WeeklyRecurrencePatternDto](WeeklyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.YearlyRecurrencePatternDto](YearlyRecurrencePatternDto.md) -- [AsposeEmailCloudSdk.models.ClientMessageDeleteRequest](ClientMessageDeleteRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageMoveRequest](ClientMessageMoveRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageSetIsReadRequest](ClientMessageSetIsReadRequest.md) -- [AsposeEmailCloudSdk.models.ClientThreadDeleteRequest](ClientThreadDeleteRequest.md) -- [AsposeEmailCloudSdk.models.ClientThreadMoveRequest](ClientThreadMoveRequest.md) -- [AsposeEmailCloudSdk.models.ClientThreadSetIsReadRequest](ClientThreadSetIsReadRequest.md) -- [AsposeEmailCloudSdk.models.MapiPidLidPropertyDescriptor](MapiPidLidPropertyDescriptor.md) -- [AsposeEmailCloudSdk.models.MapiPidNamePropertyDescriptor](MapiPidNamePropertyDescriptor.md) -- [AsposeEmailCloudSdk.models.MapiPidTagPropertyDescriptor](MapiPidTagPropertyDescriptor.md) -- [AsposeEmailCloudSdk.models.AiBcrParseRequest](AiBcrParseRequest.md) -- [AsposeEmailCloudSdk.models.AiNameCompleteRequest](AiNameCompleteRequest.md) -- [AsposeEmailCloudSdk.models.AiNameExpandRequest](AiNameExpandRequest.md) -- [AsposeEmailCloudSdk.models.AiNameFormatRequest](AiNameFormatRequest.md) -- [AsposeEmailCloudSdk.models.AiNameGenderizeRequest](AiNameGenderizeRequest.md) -- [AsposeEmailCloudSdk.models.AiNameMatchRequest](AiNameMatchRequest.md) -- [AsposeEmailCloudSdk.models.AiNameParseRequest](AiNameParseRequest.md) -- [AsposeEmailCloudSdk.models.AiNameParseEmailAddressRequest](AiNameParseEmailAddressRequest.md) -- [AsposeEmailCloudSdk.models.CalendarConvertRequest](CalendarConvertRequest.md) -- [AsposeEmailCloudSdk.models.CalendarFromFileRequest](CalendarFromFileRequest.md) -- [AsposeEmailCloudSdk.models.CalendarGetRequest](CalendarGetRequest.md) -- [AsposeEmailCloudSdk.models.CalendarGetAsAlternateRequest](CalendarGetAsAlternateRequest.md) -- [AsposeEmailCloudSdk.models.CalendarGetAsFileRequest](CalendarGetAsFileRequest.md) -- [AsposeEmailCloudSdk.models.CalendarGetListRequest](CalendarGetListRequest.md) -- [AsposeEmailCloudSdk.models.ClientAccountGetRequest](ClientAccountGetRequest.md) -- [AsposeEmailCloudSdk.models.ClientAccountGetMultiRequest](ClientAccountGetMultiRequest.md) -- [AsposeEmailCloudSdk.models.ClientFolderGetListRequest](ClientFolderGetListRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageAppendFileRequest](ClientMessageAppendFileRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageFetchRequest](ClientMessageFetchRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageFetchFileRequest](ClientMessageFetchFileRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageListRequest](ClientMessageListRequest.md) -- [AsposeEmailCloudSdk.models.ClientMessageSendFileRequest](ClientMessageSendFileRequest.md) -- [AsposeEmailCloudSdk.models.ClientThreadGetListRequest](ClientThreadGetListRequest.md) -- [AsposeEmailCloudSdk.models.ClientThreadGetMessagesRequest](ClientThreadGetMessagesRequest.md) -- [AsposeEmailCloudSdk.models.ContactConvertRequest](ContactConvertRequest.md) -- [AsposeEmailCloudSdk.models.ContactFromFileRequest](ContactFromFileRequest.md) -- [AsposeEmailCloudSdk.models.ContactGetRequest](ContactGetRequest.md) -- [AsposeEmailCloudSdk.models.ContactGetAsFileRequest](ContactGetAsFileRequest.md) -- [AsposeEmailCloudSdk.models.ContactGetListRequest](ContactGetListRequest.md) -- [AsposeEmailCloudSdk.models.DisposableEmailIsDisposableRequest](DisposableEmailIsDisposableRequest.md) -- [AsposeEmailCloudSdk.models.EmailConvertRequest](EmailConvertRequest.md) -- [AsposeEmailCloudSdk.models.EmailFromFileRequest](EmailFromFileRequest.md) -- [AsposeEmailCloudSdk.models.EmailGetRequest](EmailGetRequest.md) -- [AsposeEmailCloudSdk.models.EmailGetAsFileRequest](EmailGetAsFileRequest.md) -- [AsposeEmailCloudSdk.models.EmailGetListRequest](EmailGetListRequest.md) -- [AsposeEmailCloudSdk.models.EmailConfigDiscoverRequest](EmailConfigDiscoverRequest.md) -- [AsposeEmailCloudSdk.models.CopyFileRequest](CopyFileRequest.md) -- [AsposeEmailCloudSdk.models.DeleteFileRequest](DeleteFileRequest.md) -- [AsposeEmailCloudSdk.models.DownloadFileRequest](DownloadFileRequest.md) -- [AsposeEmailCloudSdk.models.MoveFileRequest](MoveFileRequest.md) -- [AsposeEmailCloudSdk.models.UploadFileRequest](UploadFileRequest.md) -- [AsposeEmailCloudSdk.models.CopyFolderRequest](CopyFolderRequest.md) -- [AsposeEmailCloudSdk.models.CreateFolderRequest](CreateFolderRequest.md) -- [AsposeEmailCloudSdk.models.DeleteFolderRequest](DeleteFolderRequest.md) -- [AsposeEmailCloudSdk.models.GetFilesListRequest](GetFilesListRequest.md) -- [AsposeEmailCloudSdk.models.MoveFolderRequest](MoveFolderRequest.md) -- [AsposeEmailCloudSdk.models.MapiCalendarFromFileRequest](MapiCalendarFromFileRequest.md) -- [AsposeEmailCloudSdk.models.MapiCalendarGetRequest](MapiCalendarGetRequest.md) -- [AsposeEmailCloudSdk.models.MapiContactFromFileRequest](MapiContactFromFileRequest.md) -- [AsposeEmailCloudSdk.models.MapiContactGetRequest](MapiContactGetRequest.md) -- [AsposeEmailCloudSdk.models.MapiMessageFromFileRequest](MapiMessageFromFileRequest.md) -- [AsposeEmailCloudSdk.models.MapiMessageGetRequest](MapiMessageGetRequest.md) -- [AsposeEmailCloudSdk.models.GetDiscUsageRequest](GetDiscUsageRequest.md) -- [AsposeEmailCloudSdk.models.GetFileVersionsRequest](GetFileVersionsRequest.md) -- [AsposeEmailCloudSdk.models.ObjectExistsRequest](ObjectExistsRequest.md) -- [AsposeEmailCloudSdk.models.StorageExistsRequest](StorageExistsRequest.md) - diff --git a/sdk/docs/MonthlyRecurrencePatternDto.md b/sdk/docs/MonthlyRecurrencePatternDto.md deleted file mode 100644 index 3de37d3..0000000 --- a/sdk/docs/MonthlyRecurrencePatternDto.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.MonthlyRecurrencePatternDto - -Monthly recurrence pattern. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_day** |**str** |Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | -**start_offset** |**int** |Start offset. | -**start_position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | - -Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) - - -## Example -```python -monthly_recurrence_pattern_dto = models.MonthlyRecurrencePatternDto( - start_day='Monday', - start_position='First', - interval=-1, - week_start='Monday') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/MoveFileRequest.md b/sdk/docs/MoveFileRequest.md deleted file mode 100644 index 797a634..0000000 --- a/sdk/docs/MoveFileRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# MoveFileRequest - -Request model for FileApi.move_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**src_path** |**str** |Source file path e.g. '/src.ext' | -**dest_path** |**str** |Destination file path e.g. '/dest.ext' | -**src_storage_name** |**str** |Source storage name |[optional] -**dest_storage_name** |**str** |Destination storage name |[optional] -**version_id** |**str** |File version ID to move |[optional] - -## Example -```python -request = models.MoveFileRequest( - src_path='/storage/path/to/source/file.ext', - dest_path='/storage/path/to/destination/file.ext', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` diff --git a/sdk/docs/MoveFolderRequest.md b/sdk/docs/MoveFolderRequest.md deleted file mode 100644 index 208b3be..0000000 --- a/sdk/docs/MoveFolderRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# MoveFolderRequest - -Request model for FolderApi.move_folder - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**src_path** |**str** |Folder path to move e.g. '/folder' | -**dest_path** |**str** |Destination folder path to move to e.g '/dst' | -**src_storage_name** |**str** |Source storage name |[optional] -**dest_storage_name** |**str** |Destination storage name |[optional] - -## Example -```python -request = models.MoveFolderRequest( - src_path='/storage/path/to/source/folder', - dest_path='/storage/path/to/destination/folder', - src_storage_name='First Storage', - dest_storage_name='Other Storage') -``` diff --git a/sdk/docs/NameValuePair.md b/sdk/docs/NameValuePair.md deleted file mode 100644 index 09f5020..0000000 --- a/sdk/docs/NameValuePair.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.NameValuePair - -Name-Value property - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |Property name |[optional] -**value** |**str** |Property value |[optional] - - - -## Example -```python -name_value_pair = models.NameValuePair( - name='name', - value='value') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ObjectExist.md b/sdk/docs/ObjectExist.md deleted file mode 100644 index 6e30a98..0000000 --- a/sdk/docs/ObjectExist.md +++ /dev/null @@ -1,21 +0,0 @@ -# AsposeEmailCloudSdk.models.ObjectExist - -Object exists - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**exists** |**bool** |Indicates that the file or folder exists. | -**is_folder** |**bool** |True if it is a folder, false if it is a file. | - - - -## Example -```python -object_exist = models.ObjectExist( - exists=True) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ObjectExistsRequest.md b/sdk/docs/ObjectExistsRequest.md deleted file mode 100644 index cfd9435..0000000 --- a/sdk/docs/ObjectExistsRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# ObjectExistsRequest - -Request model for StorageApi.object_exists - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |File or folder path e.g. '/file.ext' or '/folder' | -**storage_name** |**str** |Storage name |[optional] -**version_id** |**str** |File version ID |[optional] - -## Example -```python -request = models.ObjectExistsRequest( - path='/storage/path/to/folder/or/file.ext', - storage_name='First Storage') -``` diff --git a/sdk/docs/PhoneNumber.md b/sdk/docs/PhoneNumber.md deleted file mode 100644 index d291232..0000000 --- a/sdk/docs/PhoneNumber.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.PhoneNumber - -A phone number. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |[**EnumWithCustomOfPhoneNumberCategory**](EnumWithCustomOfPhoneNumberCategory.md) |Phone number category. |[optional] -**number** |**str** |Phone number. |[optional] -**preferred** |**bool** |Defines whether phone number is preferred. | - - - -## Example -```python -phone_number = models.PhoneNumber( - category=models.EnumWithCustomOfPhoneNumberCategory( - value='Company'), - number='+44 141 628 8900', - preferred=True) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/PostalAddress.md b/sdk/docs/PostalAddress.md deleted file mode 100644 index 2e50bf0..0000000 --- a/sdk/docs/PostalAddress.md +++ /dev/null @@ -1,38 +0,0 @@ -# AsposeEmailCloudSdk.models.PostalAddress - -A postal address - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address** |**str** |Address. |[optional] -**category** |[**EnumWithCustomOfPostalAddressCategory**](EnumWithCustomOfPostalAddressCategory.md) |Address category. |[optional] -**city** |**str** |Address's city. |[optional] -**country** |**str** |Address's country. |[optional] -**country_code** |**str** |Country code. |[optional] -**is_mailing_address** |**bool** |Defines whether address may be used for mailing. | -**postal_code** |**str** |Postal code. |[optional] -**post_office_box** |**str** |Post Office box. |[optional] -**preferred** |**bool** |Defines whether postal address is preferred. | -**state_or_province** |**str** |Address's region. |[optional] -**street** |**str** |Address's street. |[optional] - - - -## Example -```python -postal_address = models.PostalAddress( - address='221b', - category=models.EnumWithCustomOfPostalAddressCategory( - ), - city='London', - country='United Kingdom', - is_mailing_address=True, - postal_code='NW1 6XE', - preferred=True, - street='Baker St') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/README.md b/sdk/docs/README.md deleted file mode 100644 index 7330836..0000000 --- a/sdk/docs/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# Reference documentation for Aspose.Email Cloud API - -`EmailCloud` is the main API class. It provides an access to all of Aspose.Email Cloud functions. -`client_secret` and `client_id` credentials should be obtained from [dashboard](https://dashboard.aspose.cloud/#/) to use `EmailCloud`: - -```python -client_secret = 'Your Client secret' -client_id = 'Your Client id' - -api = EmailCloud(client_secret, client_id) -``` - -All Aspose.Email Cloud functions are divided into groups and represented as `EmailCloud` fields: - -API | Description ---- | ----------- -[EmailCloud.**mapi**](MapiGroup.md) | MAPI operations. -[EmailCloud.**client**](ClientGroup.md) | Builtin Email client operations. -[EmailCloud.**ai**](AiGroup.md) | AI powered operations. -[EmailCloud.**cloud_storage**](CloudStorageGroup.md) | Cloud file storage operations. -[EmailCloud.**calendar**](CalendarApi_list.md) | iCalendar document operations. -[EmailCloud.**contact**](ContactApi_list.md) | Contact document operations. Supported formats: VCard, MSG, WebDav -[EmailCloud.**email**](EmailApi_list.md) | Email document (*.eml) operations. -[EmailCloud.**disposable_email**](DisposableEmailApi_list.md) | Checks if an email is a disposable one -[EmailCloud.**email_config**](EmailConfigApi_list.md) | Email server configuration discovery. - - -List of all available models is available in [Models.md](Models.md) file. \ No newline at end of file diff --git a/sdk/docs/RecurrencePatternDto.md b/sdk/docs/RecurrencePatternDto.md deleted file mode 100644 index e3f972b..0000000 --- a/sdk/docs/RecurrencePatternDto.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.RecurrencePatternDto - -iCalendar recurrence pattern. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**interval** |**int** |Number of recurrence units. | -**occurs** |**int** |Number of occurrences of the recurrence pattern. | -**end_date** |**datetime** |End date. | -**week_start** |**str** |Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | -**discriminator** |**str** | | - - - -## Example -```python -recurrence_pattern_dto = models.RecurrencePatternDto( - interval=-1, - week_start='Monday') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ReminderAttendee.md b/sdk/docs/ReminderAttendee.md deleted file mode 100644 index 35b4f76..0000000 --- a/sdk/docs/ReminderAttendee.md +++ /dev/null @@ -1,20 +0,0 @@ -# AsposeEmailCloudSdk.models.ReminderAttendee - -Defines an \"Attendee\" within a alarm. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address** |**str** |Contains the email address. | - - - -## Example -```python -reminder_attendee = models.ReminderAttendee( - address='attendee@aspose.com') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ReminderTrigger.md b/sdk/docs/ReminderTrigger.md deleted file mode 100644 index 98afc4b..0000000 --- a/sdk/docs/ReminderTrigger.md +++ /dev/null @@ -1,23 +0,0 @@ -# AsposeEmailCloudSdk.models.ReminderTrigger - -Specifies when an alarm will trigger. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**date_time** |**datetime** |A trigger set to an absolute date/time. | -**duration** |**int** |Specifies a relative time in ticks for the trigger of the alarm. |[optional] -**related** |**str** |Specify the relationship of the alarm trigger with respect to the start or end of the event. Enum, available values: Start, End | - - - -## Example -```python -reminder_trigger = models.ReminderTrigger( - date_time=datetime.today(), - duration=600000000) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageApi.md b/sdk/docs/StorageApi.md deleted file mode 100644 index 6d5fa91..0000000 --- a/sdk/docs/StorageApi.md +++ /dev/null @@ -1,289 +0,0 @@ -# AsposeEmailCloudSdk.StorageApi (EmailCloud.cloud_storage.storage) - -Storage operations controller - - -## get_disc_usage - -Description: Get disc usage - -Returns: Disc usage. - -Method call example: -```python -result = api.cloud_storage.storage.get_disc_usage(request) -``` - -### Parameter: request - -Description: get_disc_usage method request. - -See parameter model documentation at [GetDiscUsageRequest](GetDiscUsageRequest.md). - -
- Parameter initialization example: - -```python -request = models.GetDiscUsageRequest( - storage_name='First Storage') -``` - -
- -### Result - -Description: Disc usage. - -Return type: [**DiscUsage**](DiscUsage.md) - -
- Result example - -```python -result = models.DiscUsage( - used_size=1048576, - total_size=3145728) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.GetDiscUsageRequest( - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.storage.get_disc_usage(request) - -// Result example: -result = models.DiscUsage( - used_size=1048576, - total_size=3145728) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## get_file_versions - -Description: Get file versions - -Returns: File versions. - -Method call example: -```python -result = api.cloud_storage.storage.get_file_versions(request) -``` - -### Parameter: request - -Description: get_file_versions method request. - -See parameter model documentation at [GetFileVersionsRequest](GetFileVersionsRequest.md). - -
- Parameter initialization example: - -```python -request = models.GetFileVersionsRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') -``` - -
- -### Result - -Description: File versions. - -Return type: [**FileVersions**](FileVersions.md) - -
- Result example - -```python -result = models.FileVersions( - value=[ - models.FileVersion( - version_id='d5afd857-8797-4ca0-b806-a03fdfc3831f', - is_latest=True, - name='file.ext', - modified_date=datetime.today(), - size=4096, - path='/storage/path/to')]) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.GetFileVersionsRequest( - path='/storage/path/to/file.ext', - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.storage.get_file_versions(request) - -// Result example: -result = models.FileVersions( - value=[ - models.FileVersion( - version_id='d5afd857-8797-4ca0-b806-a03fdfc3831f', - is_latest=True, - name='file.ext', - modified_date=datetime.today(), - size=4096, - path='/storage/path/to')]) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## object_exists - -Description: Check if file or folder exists - -Returns: Object exist result. - -Method call example: -```python -result = api.cloud_storage.storage.object_exists(request) -``` - -### Parameter: request - -Description: object_exists method request. - -See parameter model documentation at [ObjectExistsRequest](ObjectExistsRequest.md). - -
- Parameter initialization example: - -```python -request = models.ObjectExistsRequest( - path='/storage/path/to/folder/or/file.ext', - storage_name='First Storage') -``` - -
- -### Result - -Description: Object exist result. - -Return type: [**ObjectExist**](ObjectExist.md) - -
- Result example - -```python -result = models.ObjectExist( - exists=True) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.ObjectExistsRequest( - path='/storage/path/to/folder/or/file.ext', - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.storage.object_exists(request) - -// Result example: -result = models.ObjectExist( - exists=True) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -## exists - -Description: Check if storage exists - -Returns: Storage exist result. - -Method call example: -```python -result = api.cloud_storage.storage.exists(request) -``` - -### Parameter: request - -Description: exists method request. - -See parameter model documentation at [StorageExistsRequest](StorageExistsRequest.md). - -
- Parameter initialization example: - -```python -request = models.StorageExistsRequest( - storage_name='First Storage') -``` - -
- -### Result - -Description: Storage exist result. - -Return type: [**StorageExist**](StorageExist.md) - -
- Result example - -```python -result = models.StorageExist( - exists=True) -``` -
- -### Complete example - -
- Method call example: - -```python -api = EmailCloud(client_secret, client_id) - -// Prepare parameters: -request = models.StorageExistsRequest( - storage_name='First Storage') - -// Call method: -result = api.cloud_storage.storage.exists(request) - -// Result example: -result = models.StorageExist( - exists=True) -``` - -
- -[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageApi_list.md b/sdk/docs/StorageApi_list.md deleted file mode 100644 index c41850a..0000000 --- a/sdk/docs/StorageApi_list.md +++ /dev/null @@ -1,10 +0,0 @@ -## Documentation for StorageApi operations - -All URIs are relative to *https://api.aspose.cloud/v4.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_disc_usage**](StorageApi.md#get_disc_usage)| **GET** /email/storage/disc| Get disc usage -[**get_file_versions**](StorageApi.md#get_file_versions)| **GET** /email/storage/version/{path}| Get file versions -[**object_exists**](StorageApi.md#object_exists)| **GET** /email/storage/exist/{path}| Check if file or folder exists -[**exists**](StorageApi.md#exists)| **GET** /email/storage/{storageName}/exist| Check if storage exists diff --git a/sdk/docs/StorageExist.md b/sdk/docs/StorageExist.md deleted file mode 100644 index 1b1607e..0000000 --- a/sdk/docs/StorageExist.md +++ /dev/null @@ -1,20 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageExist - -Storage exists - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**exists** |**bool** |Shows that the storage exists. | - - - -## Example -```python -storage_exist = models.StorageExist( - exists=True) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageExistsRequest.md b/sdk/docs/StorageExistsRequest.md deleted file mode 100644 index 5a99c63..0000000 --- a/sdk/docs/StorageExistsRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# StorageExistsRequest - -Request model for StorageApi.exists - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**storage_name** |**str** |Storage name | - -## Example -```python -request = models.StorageExistsRequest( - storage_name='First Storage') -``` - diff --git a/sdk/docs/StorageFile.md b/sdk/docs/StorageFile.md deleted file mode 100644 index 7f15d39..0000000 --- a/sdk/docs/StorageFile.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageFile - -File or folder information - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** |**str** |File or folder name. |[optional] -**is_folder** |**bool** |True if it is a folder. | -**modified_date** |**datetime** |File or folder last modified DateTime. |[optional] -**size** |**int** |File or folder size. | -**path** |**str** |File or folder path. |[optional] - - - -## Example -```python -storage_file = models.StorageFile( - name='file.ext', - modified_date=datetime.today(), - size=4096, - path='/storage/path/to') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageFileLocation.md b/sdk/docs/StorageFileLocation.md deleted file mode 100644 index 1728254..0000000 --- a/sdk/docs/StorageFileLocation.md +++ /dev/null @@ -1,23 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageFileLocation - -A storage file location information - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file_name** |**str** |A file name in storage | - -Parent class: [StorageFolderLocation](StorageFolderLocation.md) - - -## Example -```python -storage_file_location = models.StorageFileLocation( - file_name='fileOnStorage.txt', - storage='First Storage', - folder_path='file/location/folder/on/storage') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageFileLocationList.md b/sdk/docs/StorageFileLocationList.md deleted file mode 100644 index 7c780fc..0000000 --- a/sdk/docs/StorageFileLocationList.md +++ /dev/null @@ -1,24 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageFileLocationList - -List of files located on storage. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -Parent class: [ListResponseOfStorageFileLocation](ListResponseOfStorageFileLocation.md) - - -## Example -```python -storage_file_location_list = models.StorageFileLocationList( - value=[ - models.StorageFileLocation( - file_name='fileOnStorage.txt', - storage='First Storage', - folder_path='file/location/folder/on/storage')]) -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageFolderLocation.md b/sdk/docs/StorageFolderLocation.md deleted file mode 100644 index cf4d129..0000000 --- a/sdk/docs/StorageFolderLocation.md +++ /dev/null @@ -1,22 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageFolderLocation - -A storage folder location information - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage** |**str** |A storage name |[optional] -**folder_path** |**str** |A path to a folder in specified storage |[optional] - - - -## Example -```python -storage_folder_location = models.StorageFolderLocation( - storage='First Storage', - folder_path='folder/on/storage') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfCalendarDto.md b/sdk/docs/StorageModelOfCalendarDto.md deleted file mode 100644 index 4a51445..0000000 --- a/sdk/docs/StorageModelOfCalendarDto.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfCalendarDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**CalendarDto**](CalendarDto.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfContactDto.md b/sdk/docs/StorageModelOfContactDto.md deleted file mode 100644 index ef5bcbb..0000000 --- a/sdk/docs/StorageModelOfContactDto.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfContactDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**ContactDto**](ContactDto.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfEmailClientAccount.md b/sdk/docs/StorageModelOfEmailClientAccount.md deleted file mode 100644 index cb66694..0000000 --- a/sdk/docs/StorageModelOfEmailClientAccount.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfEmailClientAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**EmailClientAccount**](EmailClientAccount.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfEmailClientMultiAccount.md b/sdk/docs/StorageModelOfEmailClientMultiAccount.md deleted file mode 100644 index a0f281b..0000000 --- a/sdk/docs/StorageModelOfEmailClientMultiAccount.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfEmailClientMultiAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**EmailClientMultiAccount**](EmailClientMultiAccount.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfEmailDto.md b/sdk/docs/StorageModelOfEmailDto.md deleted file mode 100644 index 0f740cb..0000000 --- a/sdk/docs/StorageModelOfEmailDto.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfEmailDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**EmailDto**](EmailDto.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfMapiCalendarDto.md b/sdk/docs/StorageModelOfMapiCalendarDto.md deleted file mode 100644 index 76635e3..0000000 --- a/sdk/docs/StorageModelOfMapiCalendarDto.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfMapiCalendarDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**MapiCalendarDto**](MapiCalendarDto.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfMapiContactDto.md b/sdk/docs/StorageModelOfMapiContactDto.md deleted file mode 100644 index 8da6057..0000000 --- a/sdk/docs/StorageModelOfMapiContactDto.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfMapiContactDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**MapiContactDto**](MapiContactDto.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/StorageModelOfMapiMessageDto.md b/sdk/docs/StorageModelOfMapiMessageDto.md deleted file mode 100644 index 79493cd..0000000 --- a/sdk/docs/StorageModelOfMapiMessageDto.md +++ /dev/null @@ -1,13 +0,0 @@ -# AsposeEmailCloudSdk.models.StorageModelOfMapiMessageDto - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | -**value** |[**MapiMessageDto**](MapiMessageDto.md) | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/TaskRegeneratingPatternDto.md b/sdk/docs/TaskRegeneratingPatternDto.md deleted file mode 100644 index 9c6f4f0..0000000 --- a/sdk/docs/TaskRegeneratingPatternDto.md +++ /dev/null @@ -1,24 +0,0 @@ -# AsposeEmailCloudSdk.models.TaskRegeneratingPatternDto - -Represents the regenerating recurrence pattern that specifies how many days, weeks, months or years after the completion of the current task the next occurrence will be due. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**regenerating_type** |**str** |Enumerates the types of regenerating pattern. Enum, available values: Daily, Weekly, Monthly, Yearly | - -Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) - - -## Example -```python -task_regenerating_pattern_dto = models.TaskRegeneratingPatternDto( - interval=1, - occurs=2, - end_date=datetime.today(), - week_start='Sunday') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/UploadFileRequest.md b/sdk/docs/UploadFileRequest.md deleted file mode 100644 index 071ab78..0000000 --- a/sdk/docs/UploadFileRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# UploadFileRequest - -Request model for FileApi.upload_file - -## Properties - -Name | Type | Description | Notes ----- | ---- | ----------- | ----- -**path** |**str** |Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. | -**file** |**str** |File to upload | -**storage_name** |**str** |Storage name |[optional] - -## Example -```python -request = models.UploadFileRequest( - path='/storage/path/to/file.ext', - file='/local/file/system/path/to/file.ext', - storage_name='First Storage') -``` diff --git a/sdk/docs/Url.md b/sdk/docs/Url.md deleted file mode 100644 index 468528c..0000000 --- a/sdk/docs/Url.md +++ /dev/null @@ -1,25 +0,0 @@ -# AsposeEmailCloudSdk.models.Url - -Url and its category. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** |[**EnumWithCustomOfUrlCategory**](EnumWithCustomOfUrlCategory.md) |Url category. |[optional] -**preferred** |**bool** |Defines whether url is preferred. | -**href** |**str** |URL. |[optional] - - - -## Example -```python -url = models.Url( - category=models.EnumWithCustomOfUrlCategory( - value='Work'), - preferred=True, - href='https://products.aspose.cloud/email') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ValueTOfBoolean.md b/sdk/docs/ValueTOfBoolean.md deleted file mode 100644 index c6f4635..0000000 --- a/sdk/docs/ValueTOfBoolean.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ValueTOfBoolean - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**bool** | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/ValueTOfString.md b/sdk/docs/ValueTOfString.md deleted file mode 100644 index 8f6fd64..0000000 --- a/sdk/docs/ValueTOfString.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsposeEmailCloudSdk.models.ValueTOfString - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** |**str** | | - - - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/WeeklyRecurrencePatternDto.md b/sdk/docs/WeeklyRecurrencePatternDto.md deleted file mode 100644 index 831421f..0000000 --- a/sdk/docs/WeeklyRecurrencePatternDto.md +++ /dev/null @@ -1,26 +0,0 @@ -# AsposeEmailCloudSdk.models.WeeklyRecurrencePatternDto - -Weekly recurrence pattern. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_days** |**list[str]** |Start days Items: Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay |[optional] - -Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) - - -## Example -```python -weekly_recurrence_pattern_dto = models.WeeklyRecurrencePatternDto( - start_days=[ - 'Tuesday', - 'Thursday'], - interval=-1, - occurs=10, - week_start='Sunday') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) - diff --git a/sdk/docs/YearlyRecurrencePatternDto.md b/sdk/docs/YearlyRecurrencePatternDto.md deleted file mode 100644 index 17e1a79..0000000 --- a/sdk/docs/YearlyRecurrencePatternDto.md +++ /dev/null @@ -1,27 +0,0 @@ -# AsposeEmailCloudSdk.models.YearlyRecurrencePatternDto - -Yearly recurrence pattern. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_day** |**str** |Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | -**start_month** |**str** |Represents a calendar month. Enum, available values: None, January, February, March, April, May, June, July, August, September, October, November, December | -**start_offset** |**int** |Start offset. | -**start_position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | - -Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) - - -## Example -```python -yearly_recurrence_pattern_dto = models.YearlyRecurrencePatternDto( - start_month='January', - start_offset=30, - interval=-1, - week_start='Monday') -``` - - -[[Back to Model list]](Models.md) [[Back to README]](README.md) -