diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES new file mode 100644 index 00000000..5028909b --- /dev/null +++ b/.openapi-generator/FILES @@ -0,0 +1,990 @@ +.openapi-generator-ignore +Build.ps1 +README.md +appveyor.yml +docs/AbstractWebhookPayload.md +docs/AccountBounceBlockDto.md +docs/AliasControllerApi.md +docs/AliasDto.md +docs/AliasProjection.md +docs/AttachmentControllerApi.md +docs/AttachmentEntity.md +docs/AttachmentMetaData.md +docs/AttachmentProjection.md +docs/BasicAuthOptions.md +docs/BounceControllerApi.md +docs/BounceProjection.md +docs/BounceRecipientProjection.md +docs/BouncedEmailDto.md +docs/BouncedRecipientDto.md +docs/BulkActionsControllerApi.md +docs/BulkSendEmailOptions.md +docs/CanSendEmailResults.md +docs/CheckEmailBodyFeatureSupportResults.md +docs/CheckEmailBodyResults.md +docs/CheckEmailClientSupportOptions.md +docs/CheckEmailClientSupportResults.md +docs/CheckEmailFeaturesClientSupportOptions.md +docs/CheckEmailFeaturesClientSupportResults.md +docs/CommonActionsControllerApi.md +docs/Complaint.md +docs/ConditionOption.md +docs/ConnectorControllerApi.md +docs/ConnectorDto.md +docs/ConnectorImapConnectionDto.md +docs/ConnectorProjection.md +docs/ConnectorSmtpConnectionDto.md +docs/ConnectorSyncEventDto.md +docs/ConnectorSyncEventProjection.md +docs/ConnectorSyncRequestResult.md +docs/ConnectorSyncRequestResultException.md +docs/ConnectorSyncRequestResultExceptionCause.md +docs/ConnectorSyncRequestResultExceptionCauseStackTrace.md +docs/ConnectorSyncResult.md +docs/ContactControllerApi.md +docs/ContactDto.md +docs/ContactProjection.md +docs/ContentMatchOptions.md +docs/CountDto.md +docs/CreateAliasOptions.md +docs/CreateConnectorImapConnectionOptions.md +docs/CreateConnectorOptions.md +docs/CreateConnectorSmtpConnectionOptions.md +docs/CreateContactOptions.md +docs/CreateDomainOptions.md +docs/CreateEmergencyAddressOptions.md +docs/CreateGroupOptions.md +docs/CreateInboxDto.md +docs/CreateInboxForwarderOptions.md +docs/CreateInboxReplierOptions.md +docs/CreateInboxRulesetOptions.md +docs/CreateTemplateOptions.md +docs/CreateTrackingPixelOptions.md +docs/CreateWebhookOptions.md +docs/DNSLookupOptions.md +docs/DNSLookupResult.md +docs/DNSLookupResults.md +docs/DNSLookupsOptions.md +docs/DeliveryStatusDto.md +docs/DescribeDomainOptions.md +docs/DescribeMailServerDomainResult.md +docs/DomainControllerApi.md +docs/DomainDto.md +docs/DomainGroup.md +docs/DomainGroupsDto.md +docs/DomainInformation.md +docs/DomainIssuesDto.md +docs/DomainNameRecord.md +docs/DomainPreview.md +docs/DownloadAttachmentDto.md +docs/Email.md +docs/EmailAnalysis.md +docs/EmailContentMatchResult.md +docs/EmailContentPartResult.md +docs/EmailControllerApi.md +docs/EmailFeatureCategoryName.md +docs/EmailFeatureFamilyName.md +docs/EmailFeatureFamilyStatistics.md +docs/EmailFeatureNames.md +docs/EmailFeatureOverview.md +docs/EmailFeaturePlatformName.md +docs/EmailFeaturePlatformStatistics.md +docs/EmailFeatureSupportFlags.md +docs/EmailFeatureSupportResult.md +docs/EmailFeatureSupportStatusPercentage.md +docs/EmailFeatureVersionStatistics.md +docs/EmailHtmlDto.md +docs/EmailLinksResult.md +docs/EmailPreview.md +docs/EmailPreviewUrls.md +docs/EmailProjection.md +docs/EmailRecipients.md +docs/EmailScreenshotResult.md +docs/EmailTextLinesResult.md +docs/EmailValidationRequestDto.md +docs/EmailVerificationControllerApi.md +docs/EmailVerificationResult.md +docs/EmergencyAddress.md +docs/EmergencyAddressDto.md +docs/EmptyResponseDto.md +docs/ExpirationDefaults.md +docs/ExpiredControllerApi.md +docs/ExpiredInboxDto.md +docs/ExpiredInboxRecordProjection.md +docs/ExportControllerApi.md +docs/ExportLink.md +docs/ExportOptions.md +docs/FakeEmailDto.md +docs/FakeEmailPreview.md +docs/FakeEmailResult.md +docs/FilterBouncedRecipientsOptions.md +docs/FilterBouncedRecipientsResult.md +docs/FlushExpiredInboxesResult.md +docs/FormControllerApi.md +docs/ForwardEmailOptions.md +docs/GenerateBimiRecordOptions.md +docs/GenerateBimiRecordResults.md +docs/GenerateDmarcRecordOptions.md +docs/GenerateDmarcRecordResults.md +docs/GenerateMtaStsRecordOptions.md +docs/GenerateMtaStsRecordResults.md +docs/GenerateTlsReportingRecordOptions.md +docs/GenerateTlsReportingRecordResults.md +docs/GetEmailScreenshotOptions.md +docs/GravatarUrl.md +docs/GroupContactsDto.md +docs/GroupControllerApi.md +docs/GroupDto.md +docs/GroupProjection.md +docs/HTMLValidationResult.md +docs/IPAddressResult.md +docs/ImageIssue.md +docs/ImapAccessDetails.md +docs/ImapControllerApi.md +docs/ImapEmailProjection.md +docs/ImapFlagOperationOptions.md +docs/ImapMailboxStatus.md +docs/ImapServerFetchItem.md +docs/ImapServerFetchResult.md +docs/ImapServerGetResult.md +docs/ImapServerListOptions.md +docs/ImapServerListResult.md +docs/ImapServerSearchOptions.md +docs/ImapServerSearchResult.md +docs/ImapServerStatusOptions.md +docs/ImapServerStatusResult.md +docs/ImapSmtpAccessDetails.md +docs/ImapSmtpAccessServers.md +docs/ImapUpdateFlagsOptions.md +docs/InboxByEmailAddressResult.md +docs/InboxByNameResult.md +docs/InboxControllerApi.md +docs/InboxDto.md +docs/InboxExistsDto.md +docs/InboxForwarderControllerApi.md +docs/InboxForwarderDto.md +docs/InboxForwarderEventDto.md +docs/InboxForwarderEventProjection.md +docs/InboxForwarderTestOptions.md +docs/InboxForwarderTestResult.md +docs/InboxIdItem.md +docs/InboxIdsResult.md +docs/InboxPreview.md +docs/InboxReplierControllerApi.md +docs/InboxReplierDto.md +docs/InboxReplierEventProjection.md +docs/InboxRulesetControllerApi.md +docs/InboxRulesetDto.md +docs/InboxRulesetTestOptions.md +docs/InboxRulesetTestResult.md +docs/InlineObject.md +docs/JSONSchemaDto.md +docs/LinkIssue.md +docs/ListUnsubscribeRecipientProjection.md +docs/LookupBimiDomainOptions.md +docs/LookupBimiDomainResults.md +docs/LookupDmarcDomainOptions.md +docs/LookupDmarcDomainResults.md +docs/LookupMtaStsDomainOptions.md +docs/LookupMtaStsDomainResults.md +docs/LookupTlsReportingDomainOptions.md +docs/LookupTlsReportingDomainResults.md +docs/MailServerControllerApi.md +docs/MatchOption.md +docs/MatchOptions.md +docs/MissedEmailControllerApi.md +docs/MissedEmailDto.md +docs/MissedEmailProjection.md +docs/NameServerRecord.md +docs/NewFakeEmailAddressResult.md +docs/OrganizationInboxProjection.md +docs/PageAlias.md +docs/PageAttachmentEntity.md +docs/PageBouncedEmail.md +docs/PageBouncedRecipients.md +docs/PageComplaint.md +docs/PageConnector.md +docs/PageConnectorSyncEvents.md +docs/PageContactProjection.md +docs/PageDeliveryStatus.md +docs/PageEmailPreview.md +docs/PageEmailProjection.md +docs/PageEmailValidationRequest.md +docs/PageExpiredInboxRecordProjection.md +docs/PageGroupProjection.md +docs/PageInboxForwarderDto.md +docs/PageInboxForwarderEvents.md +docs/PageInboxProjection.md +docs/PageInboxReplierDto.md +docs/PageInboxReplierEvents.md +docs/PageInboxRulesetDto.md +docs/PageListUnsubscribeRecipients.md +docs/PageMissedEmailProjection.md +docs/PageOrganizationInboxProjection.md +docs/PagePhoneNumberProjection.md +docs/PageScheduledJobs.md +docs/PageSentEmailProjection.md +docs/PageSentEmailWithQueueProjection.md +docs/PageSmsProjection.md +docs/PageTemplateProjection.md +docs/PageThreadProjection.md +docs/PageTrackingPixelProjection.md +docs/PageUnknownMissedEmailProjection.md +docs/PageWebhookProjection.md +docs/PageWebhookResult.md +docs/PageableObject.md +docs/PhoneControllerApi.md +docs/PhoneNumberDto.md +docs/PhoneNumberProjection.md +docs/PhonePlanDto.md +docs/RawEmailJson.md +docs/Recipient.md +docs/ReplyForSms.md +docs/ReplyToAliasEmailOptions.md +docs/ReplyToEmailOptions.md +docs/ScheduledJob.md +docs/ScheduledJobDto.md +docs/SearchEmailsOptions.md +docs/SearchInboxesOptions.md +docs/SendEmailBodyPart.md +docs/SendEmailOptions.md +docs/SendSMTPEnvelopeOptions.md +docs/SendWithQueueResult.md +docs/Sender.md +docs/SentEmailDto.md +docs/SentEmailProjection.md +docs/SentEmailsControllerApi.md +docs/SentSmsDto.md +docs/ServerEndpoints.md +docs/SetInboxFavouritedOptions.md +docs/SimpleSendEmailOptions.md +docs/SmsControllerApi.md +docs/SmsDto.md +docs/SmsMatchOption.md +docs/SmsPreview.md +docs/SmsProjection.md +docs/SmsReplyOptions.md +docs/SmtpAccessDetails.md +docs/SortObject.md +docs/SpellingIssue.md +docs/TemplateControllerApi.md +docs/TemplateDto.md +docs/TemplatePreview.md +docs/TemplateProjection.md +docs/TemplateVariable.md +docs/TestInboxRulesetReceivingOptions.md +docs/TestInboxRulesetReceivingResult.md +docs/TestInboxRulesetSendingOptions.md +docs/TestInboxRulesetSendingResult.md +docs/TestNewInboxForwarderOptions.md +docs/TestNewInboxRulesetOptions.md +docs/TestPhoneNumberOptions.md +docs/ThreadProjection.md +docs/ToolsControllerApi.md +docs/TrackingControllerApi.md +docs/TrackingPixelDto.md +docs/TrackingPixelProjection.md +docs/UnknownMissedEmailProjection.md +docs/UnreadCount.md +docs/UnseenErrorCountDto.md +docs/UpdateAliasOptions.md +docs/UpdateDomainOptions.md +docs/UpdateGroupContacts.md +docs/UpdateImapAccessOptions.md +docs/UpdateInboxOptions.md +docs/UpdateInboxReplierOptions.md +docs/UpdateSmtpAccessOptions.md +docs/UploadAttachmentOptions.md +docs/UserControllerApi.md +docs/UserInfoDto.md +docs/ValidateEmailAddressListOptions.md +docs/ValidateEmailAddressListResult.md +docs/ValidationDto.md +docs/ValidationMessage.md +docs/VerifyEmailAddressOptions.md +docs/VerifyWebhookSignatureOptions.md +docs/VerifyWebhookSignatureResults.md +docs/WaitForConditions.md +docs/WaitForControllerApi.md +docs/WaitForSingleSmsOptions.md +docs/WaitForSmsConditions.md +docs/WebhookBouncePayload.md +docs/WebhookBounceRecipientPayload.md +docs/WebhookControllerApi.md +docs/WebhookDeliveryStatusPayload.md +docs/WebhookDto.md +docs/WebhookEmailOpenedPayload.md +docs/WebhookEmailReadPayload.md +docs/WebhookHeaderNameValue.md +docs/WebhookHeaders.md +docs/WebhookNewAttachmentPayload.md +docs/WebhookNewContactPayload.md +docs/WebhookNewEmailPayload.md +docs/WebhookNewSmsPayload.md +docs/WebhookProjection.md +docs/WebhookRedriveAllResult.md +docs/WebhookRedriveResult.md +docs/WebhookResultDto.md +docs/WebhookTestRequest.md +docs/WebhookTestResponse.md +docs/WebhookTestResult.md +src/maislurp-client-powershell/Api/AliasControllerApi.ps1 +src/maislurp-client-powershell/Api/AttachmentControllerApi.ps1 +src/maislurp-client-powershell/Api/BounceControllerApi.ps1 +src/maislurp-client-powershell/Api/BulkActionsControllerApi.ps1 +src/maislurp-client-powershell/Api/CommonActionsControllerApi.ps1 +src/maislurp-client-powershell/Api/ConnectorControllerApi.ps1 +src/maislurp-client-powershell/Api/ContactControllerApi.ps1 +src/maislurp-client-powershell/Api/DomainControllerApi.ps1 +src/maislurp-client-powershell/Api/EmailControllerApi.ps1 +src/maislurp-client-powershell/Api/EmailVerificationControllerApi.ps1 +src/maislurp-client-powershell/Api/ExpiredControllerApi.ps1 +src/maislurp-client-powershell/Api/ExportControllerApi.ps1 +src/maislurp-client-powershell/Api/FormControllerApi.ps1 +src/maislurp-client-powershell/Api/GroupControllerApi.ps1 +src/maislurp-client-powershell/Api/ImapControllerApi.ps1 +src/maislurp-client-powershell/Api/InboxControllerApi.ps1 +src/maislurp-client-powershell/Api/InboxForwarderControllerApi.ps1 +src/maislurp-client-powershell/Api/InboxReplierControllerApi.ps1 +src/maislurp-client-powershell/Api/InboxRulesetControllerApi.ps1 +src/maislurp-client-powershell/Api/MailServerControllerApi.ps1 +src/maislurp-client-powershell/Api/MissedEmailControllerApi.ps1 +src/maislurp-client-powershell/Api/PhoneControllerApi.ps1 +src/maislurp-client-powershell/Api/SentEmailsControllerApi.ps1 +src/maislurp-client-powershell/Api/SmsControllerApi.ps1 +src/maislurp-client-powershell/Api/TemplateControllerApi.ps1 +src/maislurp-client-powershell/Api/ToolsControllerApi.ps1 +src/maislurp-client-powershell/Api/TrackingControllerApi.ps1 +src/maislurp-client-powershell/Api/UserControllerApi.ps1 +src/maislurp-client-powershell/Api/WaitForControllerApi.ps1 +src/maislurp-client-powershell/Api/WebhookControllerApi.ps1 +src/maislurp-client-powershell/Client/Configuration.ps1 +src/maislurp-client-powershell/Model/AbstractWebhookPayload.ps1 +src/maislurp-client-powershell/Model/AccountBounceBlockDto.ps1 +src/maislurp-client-powershell/Model/AliasDto.ps1 +src/maislurp-client-powershell/Model/AliasProjection.ps1 +src/maislurp-client-powershell/Model/AttachmentEntity.ps1 +src/maislurp-client-powershell/Model/AttachmentMetaData.ps1 +src/maislurp-client-powershell/Model/AttachmentProjection.ps1 +src/maislurp-client-powershell/Model/BasicAuthOptions.ps1 +src/maislurp-client-powershell/Model/BounceProjection.ps1 +src/maislurp-client-powershell/Model/BounceRecipientProjection.ps1 +src/maislurp-client-powershell/Model/BouncedEmailDto.ps1 +src/maislurp-client-powershell/Model/BouncedRecipientDto.ps1 +src/maislurp-client-powershell/Model/BulkSendEmailOptions.ps1 +src/maislurp-client-powershell/Model/CanSendEmailResults.ps1 +src/maislurp-client-powershell/Model/CheckEmailBodyFeatureSupportResults.ps1 +src/maislurp-client-powershell/Model/CheckEmailBodyResults.ps1 +src/maislurp-client-powershell/Model/CheckEmailClientSupportOptions.ps1 +src/maislurp-client-powershell/Model/CheckEmailClientSupportResults.ps1 +src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportOptions.ps1 +src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportResults.ps1 +src/maislurp-client-powershell/Model/Complaint.ps1 +src/maislurp-client-powershell/Model/ConditionOption.ps1 +src/maislurp-client-powershell/Model/ConnectorDto.ps1 +src/maislurp-client-powershell/Model/ConnectorImapConnectionDto.ps1 +src/maislurp-client-powershell/Model/ConnectorProjection.ps1 +src/maislurp-client-powershell/Model/ConnectorSmtpConnectionDto.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncEventDto.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncEventProjection.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncRequestResult.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncRequestResultException.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCause.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.ps1 +src/maislurp-client-powershell/Model/ConnectorSyncResult.ps1 +src/maislurp-client-powershell/Model/ContactDto.ps1 +src/maislurp-client-powershell/Model/ContactProjection.ps1 +src/maislurp-client-powershell/Model/ContentMatchOptions.ps1 +src/maislurp-client-powershell/Model/CountDto.ps1 +src/maislurp-client-powershell/Model/CreateAliasOptions.ps1 +src/maislurp-client-powershell/Model/CreateConnectorImapConnectionOptions.ps1 +src/maislurp-client-powershell/Model/CreateConnectorOptions.ps1 +src/maislurp-client-powershell/Model/CreateConnectorSmtpConnectionOptions.ps1 +src/maislurp-client-powershell/Model/CreateContactOptions.ps1 +src/maislurp-client-powershell/Model/CreateDomainOptions.ps1 +src/maislurp-client-powershell/Model/CreateEmergencyAddressOptions.ps1 +src/maislurp-client-powershell/Model/CreateGroupOptions.ps1 +src/maislurp-client-powershell/Model/CreateInboxDto.ps1 +src/maislurp-client-powershell/Model/CreateInboxForwarderOptions.ps1 +src/maislurp-client-powershell/Model/CreateInboxReplierOptions.ps1 +src/maislurp-client-powershell/Model/CreateInboxRulesetOptions.ps1 +src/maislurp-client-powershell/Model/CreateTemplateOptions.ps1 +src/maislurp-client-powershell/Model/CreateTrackingPixelOptions.ps1 +src/maislurp-client-powershell/Model/CreateWebhookOptions.ps1 +src/maislurp-client-powershell/Model/DNSLookupOptions.ps1 +src/maislurp-client-powershell/Model/DNSLookupResult.ps1 +src/maislurp-client-powershell/Model/DNSLookupResults.ps1 +src/maislurp-client-powershell/Model/DNSLookupsOptions.ps1 +src/maislurp-client-powershell/Model/DeliveryStatusDto.ps1 +src/maislurp-client-powershell/Model/DescribeDomainOptions.ps1 +src/maislurp-client-powershell/Model/DescribeMailServerDomainResult.ps1 +src/maislurp-client-powershell/Model/DomainDto.ps1 +src/maislurp-client-powershell/Model/DomainGroup.ps1 +src/maislurp-client-powershell/Model/DomainGroupsDto.ps1 +src/maislurp-client-powershell/Model/DomainInformation.ps1 +src/maislurp-client-powershell/Model/DomainIssuesDto.ps1 +src/maislurp-client-powershell/Model/DomainNameRecord.ps1 +src/maislurp-client-powershell/Model/DomainPreview.ps1 +src/maislurp-client-powershell/Model/DownloadAttachmentDto.ps1 +src/maislurp-client-powershell/Model/Email.ps1 +src/maislurp-client-powershell/Model/EmailAnalysis.ps1 +src/maislurp-client-powershell/Model/EmailContentMatchResult.ps1 +src/maislurp-client-powershell/Model/EmailContentPartResult.ps1 +src/maislurp-client-powershell/Model/EmailFeatureCategoryName.ps1 +src/maislurp-client-powershell/Model/EmailFeatureFamilyName.ps1 +src/maislurp-client-powershell/Model/EmailFeatureFamilyStatistics.ps1 +src/maislurp-client-powershell/Model/EmailFeatureNames.ps1 +src/maislurp-client-powershell/Model/EmailFeatureOverview.ps1 +src/maislurp-client-powershell/Model/EmailFeaturePlatformName.ps1 +src/maislurp-client-powershell/Model/EmailFeaturePlatformStatistics.ps1 +src/maislurp-client-powershell/Model/EmailFeatureSupportFlags.ps1 +src/maislurp-client-powershell/Model/EmailFeatureSupportResult.ps1 +src/maislurp-client-powershell/Model/EmailFeatureSupportStatusPercentage.ps1 +src/maislurp-client-powershell/Model/EmailFeatureVersionStatistics.ps1 +src/maislurp-client-powershell/Model/EmailHtmlDto.ps1 +src/maislurp-client-powershell/Model/EmailLinksResult.ps1 +src/maislurp-client-powershell/Model/EmailPreview.ps1 +src/maislurp-client-powershell/Model/EmailPreviewUrls.ps1 +src/maislurp-client-powershell/Model/EmailProjection.ps1 +src/maislurp-client-powershell/Model/EmailRecipients.ps1 +src/maislurp-client-powershell/Model/EmailScreenshotResult.ps1 +src/maislurp-client-powershell/Model/EmailTextLinesResult.ps1 +src/maislurp-client-powershell/Model/EmailValidationRequestDto.ps1 +src/maislurp-client-powershell/Model/EmailVerificationResult.ps1 +src/maislurp-client-powershell/Model/EmergencyAddress.ps1 +src/maislurp-client-powershell/Model/EmergencyAddressDto.ps1 +src/maislurp-client-powershell/Model/EmptyResponseDto.ps1 +src/maislurp-client-powershell/Model/ExpirationDefaults.ps1 +src/maislurp-client-powershell/Model/ExpiredInboxDto.ps1 +src/maislurp-client-powershell/Model/ExpiredInboxRecordProjection.ps1 +src/maislurp-client-powershell/Model/ExportLink.ps1 +src/maislurp-client-powershell/Model/ExportOptions.ps1 +src/maislurp-client-powershell/Model/FakeEmailDto.ps1 +src/maislurp-client-powershell/Model/FakeEmailPreview.ps1 +src/maislurp-client-powershell/Model/FakeEmailResult.ps1 +src/maislurp-client-powershell/Model/FilterBouncedRecipientsOptions.ps1 +src/maislurp-client-powershell/Model/FilterBouncedRecipientsResult.ps1 +src/maislurp-client-powershell/Model/FlushExpiredInboxesResult.ps1 +src/maislurp-client-powershell/Model/ForwardEmailOptions.ps1 +src/maislurp-client-powershell/Model/GenerateBimiRecordOptions.ps1 +src/maislurp-client-powershell/Model/GenerateBimiRecordResults.ps1 +src/maislurp-client-powershell/Model/GenerateDmarcRecordOptions.ps1 +src/maislurp-client-powershell/Model/GenerateDmarcRecordResults.ps1 +src/maislurp-client-powershell/Model/GenerateMtaStsRecordOptions.ps1 +src/maislurp-client-powershell/Model/GenerateMtaStsRecordResults.ps1 +src/maislurp-client-powershell/Model/GenerateTlsReportingRecordOptions.ps1 +src/maislurp-client-powershell/Model/GenerateTlsReportingRecordResults.ps1 +src/maislurp-client-powershell/Model/GetEmailScreenshotOptions.ps1 +src/maislurp-client-powershell/Model/GravatarUrl.ps1 +src/maislurp-client-powershell/Model/GroupContactsDto.ps1 +src/maislurp-client-powershell/Model/GroupDto.ps1 +src/maislurp-client-powershell/Model/GroupProjection.ps1 +src/maislurp-client-powershell/Model/HTMLValidationResult.ps1 +src/maislurp-client-powershell/Model/IPAddressResult.ps1 +src/maislurp-client-powershell/Model/ImageIssue.ps1 +src/maislurp-client-powershell/Model/ImapAccessDetails.ps1 +src/maislurp-client-powershell/Model/ImapEmailProjection.ps1 +src/maislurp-client-powershell/Model/ImapFlagOperationOptions.ps1 +src/maislurp-client-powershell/Model/ImapMailboxStatus.ps1 +src/maislurp-client-powershell/Model/ImapServerFetchItem.ps1 +src/maislurp-client-powershell/Model/ImapServerFetchResult.ps1 +src/maislurp-client-powershell/Model/ImapServerGetResult.ps1 +src/maislurp-client-powershell/Model/ImapServerListOptions.ps1 +src/maislurp-client-powershell/Model/ImapServerListResult.ps1 +src/maislurp-client-powershell/Model/ImapServerSearchOptions.ps1 +src/maislurp-client-powershell/Model/ImapServerSearchResult.ps1 +src/maislurp-client-powershell/Model/ImapServerStatusOptions.ps1 +src/maislurp-client-powershell/Model/ImapServerStatusResult.ps1 +src/maislurp-client-powershell/Model/ImapSmtpAccessDetails.ps1 +src/maislurp-client-powershell/Model/ImapSmtpAccessServers.ps1 +src/maislurp-client-powershell/Model/ImapUpdateFlagsOptions.ps1 +src/maislurp-client-powershell/Model/InboxByEmailAddressResult.ps1 +src/maislurp-client-powershell/Model/InboxByNameResult.ps1 +src/maislurp-client-powershell/Model/InboxDto.ps1 +src/maislurp-client-powershell/Model/InboxExistsDto.ps1 +src/maislurp-client-powershell/Model/InboxForwarderDto.ps1 +src/maislurp-client-powershell/Model/InboxForwarderEventDto.ps1 +src/maislurp-client-powershell/Model/InboxForwarderEventProjection.ps1 +src/maislurp-client-powershell/Model/InboxForwarderTestOptions.ps1 +src/maislurp-client-powershell/Model/InboxForwarderTestResult.ps1 +src/maislurp-client-powershell/Model/InboxIdItem.ps1 +src/maislurp-client-powershell/Model/InboxIdsResult.ps1 +src/maislurp-client-powershell/Model/InboxPreview.ps1 +src/maislurp-client-powershell/Model/InboxReplierDto.ps1 +src/maislurp-client-powershell/Model/InboxReplierEventProjection.ps1 +src/maislurp-client-powershell/Model/InboxRulesetDto.ps1 +src/maislurp-client-powershell/Model/InboxRulesetTestOptions.ps1 +src/maislurp-client-powershell/Model/InboxRulesetTestResult.ps1 +src/maislurp-client-powershell/Model/InlineObject.ps1 +src/maislurp-client-powershell/Model/JSONSchemaDto.ps1 +src/maislurp-client-powershell/Model/LinkIssue.ps1 +src/maislurp-client-powershell/Model/ListUnsubscribeRecipientProjection.ps1 +src/maislurp-client-powershell/Model/LookupBimiDomainOptions.ps1 +src/maislurp-client-powershell/Model/LookupBimiDomainResults.ps1 +src/maislurp-client-powershell/Model/LookupDmarcDomainOptions.ps1 +src/maislurp-client-powershell/Model/LookupDmarcDomainResults.ps1 +src/maislurp-client-powershell/Model/LookupMtaStsDomainOptions.ps1 +src/maislurp-client-powershell/Model/LookupMtaStsDomainResults.ps1 +src/maislurp-client-powershell/Model/LookupTlsReportingDomainOptions.ps1 +src/maislurp-client-powershell/Model/LookupTlsReportingDomainResults.ps1 +src/maislurp-client-powershell/Model/MatchOption.ps1 +src/maislurp-client-powershell/Model/MatchOptions.ps1 +src/maislurp-client-powershell/Model/MissedEmailDto.ps1 +src/maislurp-client-powershell/Model/MissedEmailProjection.ps1 +src/maislurp-client-powershell/Model/ModelSender.ps1 +src/maislurp-client-powershell/Model/NameServerRecord.ps1 +src/maislurp-client-powershell/Model/NewFakeEmailAddressResult.ps1 +src/maislurp-client-powershell/Model/OrganizationInboxProjection.ps1 +src/maislurp-client-powershell/Model/PageAlias.ps1 +src/maislurp-client-powershell/Model/PageAttachmentEntity.ps1 +src/maislurp-client-powershell/Model/PageBouncedEmail.ps1 +src/maislurp-client-powershell/Model/PageBouncedRecipients.ps1 +src/maislurp-client-powershell/Model/PageComplaint.ps1 +src/maislurp-client-powershell/Model/PageConnector.ps1 +src/maislurp-client-powershell/Model/PageConnectorSyncEvents.ps1 +src/maislurp-client-powershell/Model/PageContactProjection.ps1 +src/maislurp-client-powershell/Model/PageDeliveryStatus.ps1 +src/maislurp-client-powershell/Model/PageEmailPreview.ps1 +src/maislurp-client-powershell/Model/PageEmailProjection.ps1 +src/maislurp-client-powershell/Model/PageEmailValidationRequest.ps1 +src/maislurp-client-powershell/Model/PageExpiredInboxRecordProjection.ps1 +src/maislurp-client-powershell/Model/PageGroupProjection.ps1 +src/maislurp-client-powershell/Model/PageInboxForwarderDto.ps1 +src/maislurp-client-powershell/Model/PageInboxForwarderEvents.ps1 +src/maislurp-client-powershell/Model/PageInboxProjection.ps1 +src/maislurp-client-powershell/Model/PageInboxReplierDto.ps1 +src/maislurp-client-powershell/Model/PageInboxReplierEvents.ps1 +src/maislurp-client-powershell/Model/PageInboxRulesetDto.ps1 +src/maislurp-client-powershell/Model/PageListUnsubscribeRecipients.ps1 +src/maislurp-client-powershell/Model/PageMissedEmailProjection.ps1 +src/maislurp-client-powershell/Model/PageOrganizationInboxProjection.ps1 +src/maislurp-client-powershell/Model/PagePhoneNumberProjection.ps1 +src/maislurp-client-powershell/Model/PageScheduledJobs.ps1 +src/maislurp-client-powershell/Model/PageSentEmailProjection.ps1 +src/maislurp-client-powershell/Model/PageSentEmailWithQueueProjection.ps1 +src/maislurp-client-powershell/Model/PageSmsProjection.ps1 +src/maislurp-client-powershell/Model/PageTemplateProjection.ps1 +src/maislurp-client-powershell/Model/PageThreadProjection.ps1 +src/maislurp-client-powershell/Model/PageTrackingPixelProjection.ps1 +src/maislurp-client-powershell/Model/PageUnknownMissedEmailProjection.ps1 +src/maislurp-client-powershell/Model/PageWebhookProjection.ps1 +src/maislurp-client-powershell/Model/PageWebhookResult.ps1 +src/maislurp-client-powershell/Model/PageableObject.ps1 +src/maislurp-client-powershell/Model/PhoneNumberDto.ps1 +src/maislurp-client-powershell/Model/PhoneNumberProjection.ps1 +src/maislurp-client-powershell/Model/PhonePlanDto.ps1 +src/maislurp-client-powershell/Model/RawEmailJson.ps1 +src/maislurp-client-powershell/Model/Recipient.ps1 +src/maislurp-client-powershell/Model/ReplyForSms.ps1 +src/maislurp-client-powershell/Model/ReplyToAliasEmailOptions.ps1 +src/maislurp-client-powershell/Model/ReplyToEmailOptions.ps1 +src/maislurp-client-powershell/Model/ScheduledJob.ps1 +src/maislurp-client-powershell/Model/ScheduledJobDto.ps1 +src/maislurp-client-powershell/Model/SearchEmailsOptions.ps1 +src/maislurp-client-powershell/Model/SearchInboxesOptions.ps1 +src/maislurp-client-powershell/Model/SendEmailBodyPart.ps1 +src/maislurp-client-powershell/Model/SendEmailOptions.ps1 +src/maislurp-client-powershell/Model/SendSMTPEnvelopeOptions.ps1 +src/maislurp-client-powershell/Model/SendWithQueueResult.ps1 +src/maislurp-client-powershell/Model/SentEmailDto.ps1 +src/maislurp-client-powershell/Model/SentEmailProjection.ps1 +src/maislurp-client-powershell/Model/SentSmsDto.ps1 +src/maislurp-client-powershell/Model/ServerEndpoints.ps1 +src/maislurp-client-powershell/Model/SetInboxFavouritedOptions.ps1 +src/maislurp-client-powershell/Model/SimpleSendEmailOptions.ps1 +src/maislurp-client-powershell/Model/SmsDto.ps1 +src/maislurp-client-powershell/Model/SmsMatchOption.ps1 +src/maislurp-client-powershell/Model/SmsPreview.ps1 +src/maislurp-client-powershell/Model/SmsProjection.ps1 +src/maislurp-client-powershell/Model/SmsReplyOptions.ps1 +src/maislurp-client-powershell/Model/SmtpAccessDetails.ps1 +src/maislurp-client-powershell/Model/SortObject.ps1 +src/maislurp-client-powershell/Model/SpellingIssue.ps1 +src/maislurp-client-powershell/Model/TemplateDto.ps1 +src/maislurp-client-powershell/Model/TemplatePreview.ps1 +src/maislurp-client-powershell/Model/TemplateProjection.ps1 +src/maislurp-client-powershell/Model/TemplateVariable.ps1 +src/maislurp-client-powershell/Model/TestInboxRulesetReceivingOptions.ps1 +src/maislurp-client-powershell/Model/TestInboxRulesetReceivingResult.ps1 +src/maislurp-client-powershell/Model/TestInboxRulesetSendingOptions.ps1 +src/maislurp-client-powershell/Model/TestInboxRulesetSendingResult.ps1 +src/maislurp-client-powershell/Model/TestNewInboxForwarderOptions.ps1 +src/maislurp-client-powershell/Model/TestNewInboxRulesetOptions.ps1 +src/maislurp-client-powershell/Model/TestPhoneNumberOptions.ps1 +src/maislurp-client-powershell/Model/ThreadProjection.ps1 +src/maislurp-client-powershell/Model/TrackingPixelDto.ps1 +src/maislurp-client-powershell/Model/TrackingPixelProjection.ps1 +src/maislurp-client-powershell/Model/UnknownMissedEmailProjection.ps1 +src/maislurp-client-powershell/Model/UnreadCount.ps1 +src/maislurp-client-powershell/Model/UnseenErrorCountDto.ps1 +src/maislurp-client-powershell/Model/UpdateAliasOptions.ps1 +src/maislurp-client-powershell/Model/UpdateDomainOptions.ps1 +src/maislurp-client-powershell/Model/UpdateGroupContacts.ps1 +src/maislurp-client-powershell/Model/UpdateImapAccessOptions.ps1 +src/maislurp-client-powershell/Model/UpdateInboxOptions.ps1 +src/maislurp-client-powershell/Model/UpdateInboxReplierOptions.ps1 +src/maislurp-client-powershell/Model/UpdateSmtpAccessOptions.ps1 +src/maislurp-client-powershell/Model/UploadAttachmentOptions.ps1 +src/maislurp-client-powershell/Model/UserInfoDto.ps1 +src/maislurp-client-powershell/Model/ValidateEmailAddressListOptions.ps1 +src/maislurp-client-powershell/Model/ValidateEmailAddressListResult.ps1 +src/maislurp-client-powershell/Model/ValidationDto.ps1 +src/maislurp-client-powershell/Model/ValidationMessage.ps1 +src/maislurp-client-powershell/Model/VerifyEmailAddressOptions.ps1 +src/maislurp-client-powershell/Model/VerifyWebhookSignatureOptions.ps1 +src/maislurp-client-powershell/Model/VerifyWebhookSignatureResults.ps1 +src/maislurp-client-powershell/Model/WaitForConditions.ps1 +src/maislurp-client-powershell/Model/WaitForSingleSmsOptions.ps1 +src/maislurp-client-powershell/Model/WaitForSmsConditions.ps1 +src/maislurp-client-powershell/Model/WebhookBouncePayload.ps1 +src/maislurp-client-powershell/Model/WebhookBounceRecipientPayload.ps1 +src/maislurp-client-powershell/Model/WebhookDeliveryStatusPayload.ps1 +src/maislurp-client-powershell/Model/WebhookDto.ps1 +src/maislurp-client-powershell/Model/WebhookEmailOpenedPayload.ps1 +src/maislurp-client-powershell/Model/WebhookEmailReadPayload.ps1 +src/maislurp-client-powershell/Model/WebhookHeaderNameValue.ps1 +src/maislurp-client-powershell/Model/WebhookHeaders.ps1 +src/maislurp-client-powershell/Model/WebhookNewAttachmentPayload.ps1 +src/maislurp-client-powershell/Model/WebhookNewContactPayload.ps1 +src/maislurp-client-powershell/Model/WebhookNewEmailPayload.ps1 +src/maislurp-client-powershell/Model/WebhookNewSmsPayload.ps1 +src/maislurp-client-powershell/Model/WebhookProjection.ps1 +src/maislurp-client-powershell/Model/WebhookRedriveAllResult.ps1 +src/maislurp-client-powershell/Model/WebhookRedriveResult.ps1 +src/maislurp-client-powershell/Model/WebhookResultDto.ps1 +src/maislurp-client-powershell/Model/WebhookTestRequest.ps1 +src/maislurp-client-powershell/Model/WebhookTestResponse.ps1 +src/maislurp-client-powershell/Model/WebhookTestResult.ps1 +src/maislurp-client-powershell/Private/ApiClient.ps1 +src/maislurp-client-powershell/Private/Get-CommonParameters.ps1 +src/maislurp-client-powershell/Private/HttpSignatureAuth.ps1 +src/maislurp-client-powershell/Private/Out-DebugParameter.ps1 +src/maislurp-client-powershell/Private/RSAEncryptionProvider.cs +src/maislurp-client-powershell/en-US/about_maislurp-client-powershell.help.txt +src/maislurp-client-powershell/maislurp-client-powershell.psm1 +tests/Api/AliasControllerApi.Tests.ps1 +tests/Api/AttachmentControllerApi.Tests.ps1 +tests/Api/BounceControllerApi.Tests.ps1 +tests/Api/BulkActionsControllerApi.Tests.ps1 +tests/Api/CommonActionsControllerApi.Tests.ps1 +tests/Api/ConnectorControllerApi.Tests.ps1 +tests/Api/ContactControllerApi.Tests.ps1 +tests/Api/DomainControllerApi.Tests.ps1 +tests/Api/EmailControllerApi.Tests.ps1 +tests/Api/EmailVerificationControllerApi.Tests.ps1 +tests/Api/ExpiredControllerApi.Tests.ps1 +tests/Api/ExportControllerApi.Tests.ps1 +tests/Api/FormControllerApi.Tests.ps1 +tests/Api/GroupControllerApi.Tests.ps1 +tests/Api/ImapControllerApi.Tests.ps1 +tests/Api/InboxControllerApi.Tests.ps1 +tests/Api/InboxForwarderControllerApi.Tests.ps1 +tests/Api/InboxReplierControllerApi.Tests.ps1 +tests/Api/InboxRulesetControllerApi.Tests.ps1 +tests/Api/MailServerControllerApi.Tests.ps1 +tests/Api/MissedEmailControllerApi.Tests.ps1 +tests/Api/PhoneControllerApi.Tests.ps1 +tests/Api/SentEmailsControllerApi.Tests.ps1 +tests/Api/SmsControllerApi.Tests.ps1 +tests/Api/TemplateControllerApi.Tests.ps1 +tests/Api/ToolsControllerApi.Tests.ps1 +tests/Api/TrackingControllerApi.Tests.ps1 +tests/Api/UserControllerApi.Tests.ps1 +tests/Api/WaitForControllerApi.Tests.ps1 +tests/Api/WebhookControllerApi.Tests.ps1 +tests/Model/AbstractWebhookPayload.Tests.ps1 +tests/Model/AccountBounceBlockDto.Tests.ps1 +tests/Model/AliasDto.Tests.ps1 +tests/Model/AliasProjection.Tests.ps1 +tests/Model/AttachmentEntity.Tests.ps1 +tests/Model/AttachmentMetaData.Tests.ps1 +tests/Model/AttachmentProjection.Tests.ps1 +tests/Model/BasicAuthOptions.Tests.ps1 +tests/Model/BounceProjection.Tests.ps1 +tests/Model/BounceRecipientProjection.Tests.ps1 +tests/Model/BouncedEmailDto.Tests.ps1 +tests/Model/BouncedRecipientDto.Tests.ps1 +tests/Model/BulkSendEmailOptions.Tests.ps1 +tests/Model/CanSendEmailResults.Tests.ps1 +tests/Model/CheckEmailBodyFeatureSupportResults.Tests.ps1 +tests/Model/CheckEmailBodyResults.Tests.ps1 +tests/Model/CheckEmailClientSupportOptions.Tests.ps1 +tests/Model/CheckEmailClientSupportResults.Tests.ps1 +tests/Model/CheckEmailFeaturesClientSupportOptions.Tests.ps1 +tests/Model/CheckEmailFeaturesClientSupportResults.Tests.ps1 +tests/Model/Complaint.Tests.ps1 +tests/Model/ConditionOption.Tests.ps1 +tests/Model/ConnectorDto.Tests.ps1 +tests/Model/ConnectorImapConnectionDto.Tests.ps1 +tests/Model/ConnectorProjection.Tests.ps1 +tests/Model/ConnectorSmtpConnectionDto.Tests.ps1 +tests/Model/ConnectorSyncEventDto.Tests.ps1 +tests/Model/ConnectorSyncEventProjection.Tests.ps1 +tests/Model/ConnectorSyncRequestResult.Tests.ps1 +tests/Model/ConnectorSyncRequestResultException.Tests.ps1 +tests/Model/ConnectorSyncRequestResultExceptionCause.Tests.ps1 +tests/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.Tests.ps1 +tests/Model/ConnectorSyncResult.Tests.ps1 +tests/Model/ContactDto.Tests.ps1 +tests/Model/ContactProjection.Tests.ps1 +tests/Model/ContentMatchOptions.Tests.ps1 +tests/Model/CountDto.Tests.ps1 +tests/Model/CreateAliasOptions.Tests.ps1 +tests/Model/CreateConnectorImapConnectionOptions.Tests.ps1 +tests/Model/CreateConnectorOptions.Tests.ps1 +tests/Model/CreateConnectorSmtpConnectionOptions.Tests.ps1 +tests/Model/CreateContactOptions.Tests.ps1 +tests/Model/CreateDomainOptions.Tests.ps1 +tests/Model/CreateEmergencyAddressOptions.Tests.ps1 +tests/Model/CreateGroupOptions.Tests.ps1 +tests/Model/CreateInboxDto.Tests.ps1 +tests/Model/CreateInboxForwarderOptions.Tests.ps1 +tests/Model/CreateInboxReplierOptions.Tests.ps1 +tests/Model/CreateInboxRulesetOptions.Tests.ps1 +tests/Model/CreateTemplateOptions.Tests.ps1 +tests/Model/CreateTrackingPixelOptions.Tests.ps1 +tests/Model/CreateWebhookOptions.Tests.ps1 +tests/Model/DNSLookupOptions.Tests.ps1 +tests/Model/DNSLookupResult.Tests.ps1 +tests/Model/DNSLookupResults.Tests.ps1 +tests/Model/DNSLookupsOptions.Tests.ps1 +tests/Model/DeliveryStatusDto.Tests.ps1 +tests/Model/DescribeDomainOptions.Tests.ps1 +tests/Model/DescribeMailServerDomainResult.Tests.ps1 +tests/Model/DomainDto.Tests.ps1 +tests/Model/DomainGroup.Tests.ps1 +tests/Model/DomainGroupsDto.Tests.ps1 +tests/Model/DomainInformation.Tests.ps1 +tests/Model/DomainIssuesDto.Tests.ps1 +tests/Model/DomainNameRecord.Tests.ps1 +tests/Model/DomainPreview.Tests.ps1 +tests/Model/DownloadAttachmentDto.Tests.ps1 +tests/Model/Email.Tests.ps1 +tests/Model/EmailAnalysis.Tests.ps1 +tests/Model/EmailContentMatchResult.Tests.ps1 +tests/Model/EmailContentPartResult.Tests.ps1 +tests/Model/EmailFeatureCategoryName.Tests.ps1 +tests/Model/EmailFeatureFamilyName.Tests.ps1 +tests/Model/EmailFeatureFamilyStatistics.Tests.ps1 +tests/Model/EmailFeatureNames.Tests.ps1 +tests/Model/EmailFeatureOverview.Tests.ps1 +tests/Model/EmailFeaturePlatformName.Tests.ps1 +tests/Model/EmailFeaturePlatformStatistics.Tests.ps1 +tests/Model/EmailFeatureSupportFlags.Tests.ps1 +tests/Model/EmailFeatureSupportResult.Tests.ps1 +tests/Model/EmailFeatureSupportStatusPercentage.Tests.ps1 +tests/Model/EmailFeatureVersionStatistics.Tests.ps1 +tests/Model/EmailHtmlDto.Tests.ps1 +tests/Model/EmailLinksResult.Tests.ps1 +tests/Model/EmailPreview.Tests.ps1 +tests/Model/EmailPreviewUrls.Tests.ps1 +tests/Model/EmailProjection.Tests.ps1 +tests/Model/EmailRecipients.Tests.ps1 +tests/Model/EmailScreenshotResult.Tests.ps1 +tests/Model/EmailTextLinesResult.Tests.ps1 +tests/Model/EmailValidationRequestDto.Tests.ps1 +tests/Model/EmailVerificationResult.Tests.ps1 +tests/Model/EmergencyAddress.Tests.ps1 +tests/Model/EmergencyAddressDto.Tests.ps1 +tests/Model/EmptyResponseDto.Tests.ps1 +tests/Model/ExpirationDefaults.Tests.ps1 +tests/Model/ExpiredInboxDto.Tests.ps1 +tests/Model/ExpiredInboxRecordProjection.Tests.ps1 +tests/Model/ExportLink.Tests.ps1 +tests/Model/ExportOptions.Tests.ps1 +tests/Model/FakeEmailDto.Tests.ps1 +tests/Model/FakeEmailPreview.Tests.ps1 +tests/Model/FakeEmailResult.Tests.ps1 +tests/Model/FilterBouncedRecipientsOptions.Tests.ps1 +tests/Model/FilterBouncedRecipientsResult.Tests.ps1 +tests/Model/FlushExpiredInboxesResult.Tests.ps1 +tests/Model/ForwardEmailOptions.Tests.ps1 +tests/Model/GenerateBimiRecordOptions.Tests.ps1 +tests/Model/GenerateBimiRecordResults.Tests.ps1 +tests/Model/GenerateDmarcRecordOptions.Tests.ps1 +tests/Model/GenerateDmarcRecordResults.Tests.ps1 +tests/Model/GenerateMtaStsRecordOptions.Tests.ps1 +tests/Model/GenerateMtaStsRecordResults.Tests.ps1 +tests/Model/GenerateTlsReportingRecordOptions.Tests.ps1 +tests/Model/GenerateTlsReportingRecordResults.Tests.ps1 +tests/Model/GetEmailScreenshotOptions.Tests.ps1 +tests/Model/GravatarUrl.Tests.ps1 +tests/Model/GroupContactsDto.Tests.ps1 +tests/Model/GroupDto.Tests.ps1 +tests/Model/GroupProjection.Tests.ps1 +tests/Model/HTMLValidationResult.Tests.ps1 +tests/Model/IPAddressResult.Tests.ps1 +tests/Model/ImageIssue.Tests.ps1 +tests/Model/ImapAccessDetails.Tests.ps1 +tests/Model/ImapEmailProjection.Tests.ps1 +tests/Model/ImapFlagOperationOptions.Tests.ps1 +tests/Model/ImapMailboxStatus.Tests.ps1 +tests/Model/ImapServerFetchItem.Tests.ps1 +tests/Model/ImapServerFetchResult.Tests.ps1 +tests/Model/ImapServerGetResult.Tests.ps1 +tests/Model/ImapServerListOptions.Tests.ps1 +tests/Model/ImapServerListResult.Tests.ps1 +tests/Model/ImapServerSearchOptions.Tests.ps1 +tests/Model/ImapServerSearchResult.Tests.ps1 +tests/Model/ImapServerStatusOptions.Tests.ps1 +tests/Model/ImapServerStatusResult.Tests.ps1 +tests/Model/ImapSmtpAccessDetails.Tests.ps1 +tests/Model/ImapSmtpAccessServers.Tests.ps1 +tests/Model/ImapUpdateFlagsOptions.Tests.ps1 +tests/Model/InboxByEmailAddressResult.Tests.ps1 +tests/Model/InboxByNameResult.Tests.ps1 +tests/Model/InboxDto.Tests.ps1 +tests/Model/InboxExistsDto.Tests.ps1 +tests/Model/InboxForwarderDto.Tests.ps1 +tests/Model/InboxForwarderEventDto.Tests.ps1 +tests/Model/InboxForwarderEventProjection.Tests.ps1 +tests/Model/InboxForwarderTestOptions.Tests.ps1 +tests/Model/InboxForwarderTestResult.Tests.ps1 +tests/Model/InboxIdItem.Tests.ps1 +tests/Model/InboxIdsResult.Tests.ps1 +tests/Model/InboxPreview.Tests.ps1 +tests/Model/InboxReplierDto.Tests.ps1 +tests/Model/InboxReplierEventProjection.Tests.ps1 +tests/Model/InboxRulesetDto.Tests.ps1 +tests/Model/InboxRulesetTestOptions.Tests.ps1 +tests/Model/InboxRulesetTestResult.Tests.ps1 +tests/Model/InlineObject.Tests.ps1 +tests/Model/JSONSchemaDto.Tests.ps1 +tests/Model/LinkIssue.Tests.ps1 +tests/Model/ListUnsubscribeRecipientProjection.Tests.ps1 +tests/Model/LookupBimiDomainOptions.Tests.ps1 +tests/Model/LookupBimiDomainResults.Tests.ps1 +tests/Model/LookupDmarcDomainOptions.Tests.ps1 +tests/Model/LookupDmarcDomainResults.Tests.ps1 +tests/Model/LookupMtaStsDomainOptions.Tests.ps1 +tests/Model/LookupMtaStsDomainResults.Tests.ps1 +tests/Model/LookupTlsReportingDomainOptions.Tests.ps1 +tests/Model/LookupTlsReportingDomainResults.Tests.ps1 +tests/Model/MatchOption.Tests.ps1 +tests/Model/MatchOptions.Tests.ps1 +tests/Model/MissedEmailDto.Tests.ps1 +tests/Model/MissedEmailProjection.Tests.ps1 +tests/Model/ModelSender.Tests.ps1 +tests/Model/NameServerRecord.Tests.ps1 +tests/Model/NewFakeEmailAddressResult.Tests.ps1 +tests/Model/OrganizationInboxProjection.Tests.ps1 +tests/Model/PageAlias.Tests.ps1 +tests/Model/PageAttachmentEntity.Tests.ps1 +tests/Model/PageBouncedEmail.Tests.ps1 +tests/Model/PageBouncedRecipients.Tests.ps1 +tests/Model/PageComplaint.Tests.ps1 +tests/Model/PageConnector.Tests.ps1 +tests/Model/PageConnectorSyncEvents.Tests.ps1 +tests/Model/PageContactProjection.Tests.ps1 +tests/Model/PageDeliveryStatus.Tests.ps1 +tests/Model/PageEmailPreview.Tests.ps1 +tests/Model/PageEmailProjection.Tests.ps1 +tests/Model/PageEmailValidationRequest.Tests.ps1 +tests/Model/PageExpiredInboxRecordProjection.Tests.ps1 +tests/Model/PageGroupProjection.Tests.ps1 +tests/Model/PageInboxForwarderDto.Tests.ps1 +tests/Model/PageInboxForwarderEvents.Tests.ps1 +tests/Model/PageInboxProjection.Tests.ps1 +tests/Model/PageInboxReplierDto.Tests.ps1 +tests/Model/PageInboxReplierEvents.Tests.ps1 +tests/Model/PageInboxRulesetDto.Tests.ps1 +tests/Model/PageListUnsubscribeRecipients.Tests.ps1 +tests/Model/PageMissedEmailProjection.Tests.ps1 +tests/Model/PageOrganizationInboxProjection.Tests.ps1 +tests/Model/PagePhoneNumberProjection.Tests.ps1 +tests/Model/PageScheduledJobs.Tests.ps1 +tests/Model/PageSentEmailProjection.Tests.ps1 +tests/Model/PageSentEmailWithQueueProjection.Tests.ps1 +tests/Model/PageSmsProjection.Tests.ps1 +tests/Model/PageTemplateProjection.Tests.ps1 +tests/Model/PageThreadProjection.Tests.ps1 +tests/Model/PageTrackingPixelProjection.Tests.ps1 +tests/Model/PageUnknownMissedEmailProjection.Tests.ps1 +tests/Model/PageWebhookProjection.Tests.ps1 +tests/Model/PageWebhookResult.Tests.ps1 +tests/Model/PageableObject.Tests.ps1 +tests/Model/PhoneNumberDto.Tests.ps1 +tests/Model/PhoneNumberProjection.Tests.ps1 +tests/Model/PhonePlanDto.Tests.ps1 +tests/Model/RawEmailJson.Tests.ps1 +tests/Model/Recipient.Tests.ps1 +tests/Model/ReplyForSms.Tests.ps1 +tests/Model/ReplyToAliasEmailOptions.Tests.ps1 +tests/Model/ReplyToEmailOptions.Tests.ps1 +tests/Model/ScheduledJob.Tests.ps1 +tests/Model/ScheduledJobDto.Tests.ps1 +tests/Model/SearchEmailsOptions.Tests.ps1 +tests/Model/SearchInboxesOptions.Tests.ps1 +tests/Model/SendEmailBodyPart.Tests.ps1 +tests/Model/SendEmailOptions.Tests.ps1 +tests/Model/SendSMTPEnvelopeOptions.Tests.ps1 +tests/Model/SendWithQueueResult.Tests.ps1 +tests/Model/SentEmailDto.Tests.ps1 +tests/Model/SentEmailProjection.Tests.ps1 +tests/Model/SentSmsDto.Tests.ps1 +tests/Model/ServerEndpoints.Tests.ps1 +tests/Model/SetInboxFavouritedOptions.Tests.ps1 +tests/Model/SimpleSendEmailOptions.Tests.ps1 +tests/Model/SmsDto.Tests.ps1 +tests/Model/SmsMatchOption.Tests.ps1 +tests/Model/SmsPreview.Tests.ps1 +tests/Model/SmsProjection.Tests.ps1 +tests/Model/SmsReplyOptions.Tests.ps1 +tests/Model/SmtpAccessDetails.Tests.ps1 +tests/Model/SortObject.Tests.ps1 +tests/Model/SpellingIssue.Tests.ps1 +tests/Model/TemplateDto.Tests.ps1 +tests/Model/TemplatePreview.Tests.ps1 +tests/Model/TemplateProjection.Tests.ps1 +tests/Model/TemplateVariable.Tests.ps1 +tests/Model/TestInboxRulesetReceivingOptions.Tests.ps1 +tests/Model/TestInboxRulesetReceivingResult.Tests.ps1 +tests/Model/TestInboxRulesetSendingOptions.Tests.ps1 +tests/Model/TestInboxRulesetSendingResult.Tests.ps1 +tests/Model/TestNewInboxForwarderOptions.Tests.ps1 +tests/Model/TestNewInboxRulesetOptions.Tests.ps1 +tests/Model/TestPhoneNumberOptions.Tests.ps1 +tests/Model/ThreadProjection.Tests.ps1 +tests/Model/TrackingPixelDto.Tests.ps1 +tests/Model/TrackingPixelProjection.Tests.ps1 +tests/Model/UnknownMissedEmailProjection.Tests.ps1 +tests/Model/UnreadCount.Tests.ps1 +tests/Model/UnseenErrorCountDto.Tests.ps1 +tests/Model/UpdateAliasOptions.Tests.ps1 +tests/Model/UpdateDomainOptions.Tests.ps1 +tests/Model/UpdateGroupContacts.Tests.ps1 +tests/Model/UpdateImapAccessOptions.Tests.ps1 +tests/Model/UpdateInboxOptions.Tests.ps1 +tests/Model/UpdateInboxReplierOptions.Tests.ps1 +tests/Model/UpdateSmtpAccessOptions.Tests.ps1 +tests/Model/UploadAttachmentOptions.Tests.ps1 +tests/Model/UserInfoDto.Tests.ps1 +tests/Model/ValidateEmailAddressListOptions.Tests.ps1 +tests/Model/ValidateEmailAddressListResult.Tests.ps1 +tests/Model/ValidationDto.Tests.ps1 +tests/Model/ValidationMessage.Tests.ps1 +tests/Model/VerifyEmailAddressOptions.Tests.ps1 +tests/Model/VerifyWebhookSignatureOptions.Tests.ps1 +tests/Model/VerifyWebhookSignatureResults.Tests.ps1 +tests/Model/WaitForConditions.Tests.ps1 +tests/Model/WaitForSingleSmsOptions.Tests.ps1 +tests/Model/WaitForSmsConditions.Tests.ps1 +tests/Model/WebhookBouncePayload.Tests.ps1 +tests/Model/WebhookBounceRecipientPayload.Tests.ps1 +tests/Model/WebhookDeliveryStatusPayload.Tests.ps1 +tests/Model/WebhookDto.Tests.ps1 +tests/Model/WebhookEmailOpenedPayload.Tests.ps1 +tests/Model/WebhookEmailReadPayload.Tests.ps1 +tests/Model/WebhookHeaderNameValue.Tests.ps1 +tests/Model/WebhookHeaders.Tests.ps1 +tests/Model/WebhookNewAttachmentPayload.Tests.ps1 +tests/Model/WebhookNewContactPayload.Tests.ps1 +tests/Model/WebhookNewEmailPayload.Tests.ps1 +tests/Model/WebhookNewSmsPayload.Tests.ps1 +tests/Model/WebhookProjection.Tests.ps1 +tests/Model/WebhookRedriveAllResult.Tests.ps1 +tests/Model/WebhookRedriveResult.Tests.ps1 +tests/Model/WebhookResultDto.Tests.ps1 +tests/Model/WebhookTestRequest.Tests.ps1 +tests/Model/WebhookTestResponse.Tests.ps1 +tests/Model/WebhookTestResult.Tests.ps1 diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION new file mode 100644 index 00000000..3bff0591 --- /dev/null +++ b/.openapi-generator/VERSION @@ -0,0 +1 @@ +5.1.1 \ No newline at end of file diff --git a/Build.ps1 b/Build.ps1 new file mode 100644 index 00000000..b1c9f1f2 --- /dev/null +++ b/Build.ps1 @@ -0,0 +1,73 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +function Get-FunctionsToExport { + [CmdletBinding()] + Param ( + [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] + [ValidateNotNullOrEmpty()] + [Alias('FullName')] + $Path + ) + + Process { + $Token = $null + $ParserErr = $null + + $Ast = [System.Management.Automation.Language.Parser]::ParseFile( + $Path, + [ref]$Token, + [ref]$ParserErr + ) + + if ($ParserErr) { + throw $ParserErr + } else { + foreach ($name in 'Begin', 'Process', 'End') { + foreach ($Statement in $Ast."${name}Block".Statements) { + if ( + [String]::IsNullOrWhiteSpace($Statement.Name) -or + $Statement.Extent.ToString() -notmatch + ('function\W+{0}' -f $Statement.Name) + ) { + continue + } + + $Statement.Name + } + } + } + } +} + +$ScriptDir = Split-Path $script:MyInvocation.MyCommand.Path +$FunctionPath = 'Api', 'Model', 'Client' | ForEach-Object {Join-Path "$ScriptDir\src\maislurp-client-powershell\" $_} + +$Manifest = @{ + Path = "$ScriptDir\src\maislurp-client-powershell\maislurp-client-powershell.psd1" + + Author = 'OpenAPI Generator Team' + CompanyName = 'openapitools.org' + Description = 'maislurp-client-powershell - the PowerShell module for MailSlurp API' + + ModuleVersion = '15.19.14' + + RootModule = 'maislurp-client-powershell.psm1' + Guid = '{89293684-6A8E-463D-BFB0-6DC75525B18E}' # Has to be static, otherwise each new build will be considered different module + + PowerShellVersion = '6.2' + + FunctionsToExport = $FunctionPath | Get-ChildItem -Filter *.ps1 | Get-FunctionsToExport + + VariablesToExport = @() + AliasesToExport = @() + CmdletsToExport = @() + +} + +New-ModuleManifest @Manifest diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..79326edc --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2024 MailSlurp Email API (Provided by Pettman OÜ, Estonia) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..8c3280c4 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Powershell Email Library + +Send and receive emails in Powershell using MailSlurp. + +## Quick links + +- [API documentation](https://docs.mailslurp.com/api/) +- [Example guide](https://www.mailslurp.com/blog/powershell-send-email/) +- [GitHub source](https://github.com/mailslurp/mailslurp-client-powershell) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..519979d9 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,4 @@ +# Security + +This client calls the MailSlurp API endpoints. Connections should be made over secure HTTPS using your secure API Token. Do not share or commit the token if you can avoid doing so. +To report security issues or talk with MailSlurp support please email [contact@mailslurp.dev](mailto:contact@mailslurp.dev). diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..1727eec5 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,4 @@ +# Support + +To report issues or talk with MailSlurp support please email [contact@mailslurp.dev](mailto:contact@mailslurp.dev). +Alternatively you can visit our [support portal](https://www.mailslurp.com/support/) or open a ticket in the corresponding [Github repository](https://www.github.com/mailslurp). diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 00000000..207c053f --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,41 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +version: 1.0.{build} +image: + - Visual Studio 2019 # PWSH 7.x + #- Visual Studio 2017 # PS 5.x, PWSH 6.x + #- Ubuntu # PWSH 6.x + # ref: https://www.appveyor.com/docs/windows-images-software/ +install: + - pwsh: $PSVersionTable.PSVersion + - pwsh: Install-Module Pester -Force -Scope CurrentUser +build: off +test_script: + - pwsh: | + .\Build.ps1 + Import-Module -Name '.\src\maislurp-client-powershell' + $Result = Invoke-Pester -PassThru + if ($Result.FailedCount -gt 0) { + $host.SetShouldExit($Result.FailedCount) + exit $Result.FailedCount + } +deploy_script: + - pwsh: | + if ($env:APPVEYOR_REPO_TAG -eq $true -and $env:NuGetApiKey -ne $null) { + .\Build.ps1 + try { + Publish-Module -NuGetApiKey $env:NuGetApiKey -Path .\src\maislurp-client-powershell\ -Confirm:$False -Verbose + Write-Host "Successfully published the PowerShell module." + } catch { + $host.SetShouldExit($LastExitCode) + Write-Host "Error when running Publish-Module:" + Write-Host $_ + exit + } + } diff --git a/docs/AbstractWebhookPayload.md b/docs/AbstractWebhookPayload.md new file mode 100644 index 00000000..29682fbf --- /dev/null +++ b/docs/AbstractWebhookPayload.md @@ -0,0 +1,27 @@ +# AbstractWebhookPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventName** | **String** | | +**MessageId** | **String** | | +**WebhookId** | **String** | | +**WebhookName** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AbstractWebhookPayload = Initialize-maislurp-client-powershellAbstractWebhookPayload -EventName null ` + -MessageId null ` + -WebhookId null ` + -WebhookName null +``` + +- Convert the resource to JSON +```powershell +$AbstractWebhookPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/AccountBounceBlockDto.md b/docs/AccountBounceBlockDto.md new file mode 100644 index 00000000..d9b652db --- /dev/null +++ b/docs/AccountBounceBlockDto.md @@ -0,0 +1,29 @@ +# AccountBounceBlockDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsSendingBlocked** | **Boolean** | | +**BounceCount** | **Int64** | | +**BounceCountToday** | **Int64** | | +**MaximumDailyBounces** | **Int64** | | +**MaximumAccountBounces** | **Int64** | | + +## Examples + +- Prepare the resource +```powershell +$AccountBounceBlockDto = Initialize-maislurp-client-powershellAccountBounceBlockDto -IsSendingBlocked null ` + -BounceCount null ` + -BounceCountToday null ` + -MaximumDailyBounces null ` + -MaximumAccountBounces null +``` + +- Convert the resource to JSON +```powershell +$AccountBounceBlockDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/AliasControllerApi.md b/docs/AliasControllerApi.md new file mode 100644 index 00000000..06179c82 --- /dev/null +++ b/docs/AliasControllerApi.md @@ -0,0 +1,634 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.AliasControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Alias**](AliasControllerApi#New-Alias) | **POST** /aliases | Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. +[**Invoke-DeleteAlias**](AliasControllerApi#Invoke-DeleteAlias) | **DELETE** /aliases/{aliasId} | Delete an email alias +[**Get-Alias**](AliasControllerApi#Get-Alias) | **GET** /aliases/{aliasId} | Get an email alias +[**Get-AliasEmails**](AliasControllerApi#Get-AliasEmails) | **GET** /aliases/{aliasId}/emails | Get emails for an alias +[**Get-AliasThreads**](AliasControllerApi#Get-AliasThreads) | **GET** /aliases/{aliasId}/threads | Get threads created for an alias +[**Get-Aliases**](AliasControllerApi#Get-Aliases) | **GET** /aliases | Get all email aliases you have created +[**Get-Thread**](AliasControllerApi#Get-Thread) | **GET** /aliases/threads/{threadId} | Get a thread +[**Get-ThreadsPaginated**](AliasControllerApi#Get-ThreadsPaginated) | **GET** /aliases/threads | Get all threads +[**Invoke-ReplyToAliasEmail**](AliasControllerApi#Invoke-ReplyToAliasEmail) | **PUT** /aliases/{aliasId}/emails/{emailId} | Reply to an email +[**Send-AliasEmail**](AliasControllerApi#Send-AliasEmail) | **POST** /aliases/{aliasId}/emails | Send an email from an alias inbox +[**Update-Alias**](AliasControllerApi#Update-Alias) | **PUT** /aliases/{aliasId} | Update an email alias + + + +# **New-Alias** +> AliasDto New-Alias
+>         [-CreateAliasOptions]
+ +Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. + +Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateAliasOptions = (Initialize-CreateAliasOptions -EmailAddress "EmailAddress_example" -InboxId "InboxId_example" -Name "Name_example" -UseThreads $false -DomainId "DomainId_example" -VerifyEmailAddress $false) # CreateAliasOptions | + +# Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. +try { + $Result = New-Alias -CreateAliasOptions $CreateAliasOptions +} catch { + Write-Host ("Exception occured when calling New-Alias: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateAliasOptions** | [**CreateAliasOptions**](CreateAliasOptions)| | + +### Return type + +[**AliasDto**](AliasDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAlias** +> void Invoke-DeleteAlias
+>         [-AliasId]
+ +Delete an email alias + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | + +# Delete an email alias +try { + $Result = Invoke-DeleteAlias -AliasId $AliasId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAlias: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Alias** +> AliasDto Get-Alias
+>         [-AliasId]
+ +Get an email alias + +Get an email alias by ID + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | + +# Get an email alias +try { + $Result = Get-Alias -AliasId $AliasId +} catch { + Write-Host ("Exception occured when calling Get-Alias: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| | + +### Return type + +[**AliasDto**](AliasDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AliasEmails** +> PageEmailProjection Get-AliasEmails
+>         [-AliasId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get emails for an alias + +Get paginated emails for an alias by ID + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | +$Page = 987 # Int32 | Optional page index alias email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size alias email list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Optional filter by sent after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by sent before given date time (optional) + +# Get emails for an alias +try { + $Result = Get-AliasEmails -AliasId $AliasId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AliasEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| | + **Page** | **Int32**| Optional page index alias email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size alias email list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Optional filter by sent after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by sent before given date time | [optional] + +### Return type + +[**PageEmailProjection**](PageEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AliasThreads** +> PageThreadProjection Get-AliasThreads
+>         [-AliasId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get threads created for an alias + +Returns threads created for an email alias in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | +$Page = 987 # Int32 | Optional page index in thread list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in thread list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Optional filter by sent after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by sent before given date time (optional) + +# Get threads created for an alias +try { + $Result = Get-AliasThreads -AliasId $AliasId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AliasThreads: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in thread list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in thread list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Optional filter by sent after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by sent before given date time | [optional] + +### Return type + +[**PageThreadProjection**](PageThreadProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Aliases** +> PageAlias Get-Aliases
+>         [-Search]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get all email aliases you have created + +Get all email aliases in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Search = "Search_example" # String | Optional search term (optional) +$Page = 987 # Int32 | Optional page index in alias list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in alias list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get all email aliases you have created +try { + $Result = Get-Aliases -Search $Search -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-Aliases: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Search** | **String**| Optional search term | [optional] + **Page** | **Int32**| Optional page index in alias list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in alias list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageAlias**](PageAlias) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Thread** +> ThreadProjection Get-Thread
+>         [-ThreadId]
+ +Get a thread + +Return a thread associated with an alias + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ThreadId = "ThreadId_example" # String | + +# Get a thread +try { + $Result = Get-Thread -ThreadId $ThreadId +} catch { + Write-Host ("Exception occured when calling Get-Thread: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ThreadId** | [**String**](String)| | + +### Return type + +[**ThreadProjection**](ThreadProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ThreadsPaginated** +> PageThreadProjection Get-ThreadsPaginated
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get all threads + +Returns threads created for all aliases in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in thread list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in thread list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Optional filter by sent after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by sent before given date time (optional) + +# Get all threads +try { + $Result = Get-ThreadsPaginated -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-ThreadsPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in thread list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in thread list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Optional filter by sent after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by sent before given date time | [optional] + +### Return type + +[**PageThreadProjection**](PageThreadProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ReplyToAliasEmail** +> SentEmailDto Invoke-ReplyToAliasEmail
+>         [-AliasId]
+>         [-EmailId]
+>         [-ReplyToAliasEmailOptions]
+ +Reply to an email + +Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | ID of the alias that email belongs to +$EmailId = "EmailId_example" # String | ID of the email that should be replied to +$ReplyToAliasEmailOptions = (Initialize-ReplyToAliasEmailOptions -Body "Body_example" -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -CustomHeaders "TODO" -UseInboxName $false -Html $false) # ReplyToAliasEmailOptions | + +# Reply to an email +try { + $Result = Invoke-ReplyToAliasEmail -AliasId $AliasId -EmailId $EmailId -ReplyToAliasEmailOptions $ReplyToAliasEmailOptions +} catch { + Write-Host ("Exception occured when calling Invoke-ReplyToAliasEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| ID of the alias that email belongs to | + **EmailId** | [**String**](String)| ID of the email that should be replied to | + **ReplyToAliasEmailOptions** | [**ReplyToAliasEmailOptions**](ReplyToAliasEmailOptions)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-AliasEmail** +> SentEmailDto Send-AliasEmail
+>         [-AliasId]
+>         [-SendEmailOptions]
+ +Send an email from an alias inbox + +Send an email from an alias. Replies to the email will be forwarded to the alias masked email address + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | +$SendEmailOptions = (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID" -IgnoreEmptyRecipients $false -IsXAmpHtml $false -BodyParts @((Initialize-SendEmailBodyPart -ContentType "ContentType_example" -ContentBody "ContentBody_example"))) # SendEmailOptions | + +# Send an email from an alias inbox +try { + $Result = Send-AliasEmail -AliasId $AliasId -SendEmailOptions $SendEmailOptions +} catch { + Write-Host ("Exception occured when calling Send-AliasEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| | + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-Alias** +> AliasDto Update-Alias
+>         [-AliasId]
+>         [-UpdateAliasOptions]
+ +Update an email alias + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AliasId = "AliasId_example" # String | +$UpdateAliasOptions = (Initialize-UpdateAliasOptions -Name "Name_example") # UpdateAliasOptions | + +# Update an email alias +try { + $Result = Update-Alias -AliasId $AliasId -UpdateAliasOptions $UpdateAliasOptions +} catch { + Write-Host ("Exception occured when calling Update-Alias: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AliasId** | [**String**](String)| | + **UpdateAliasOptions** | [**UpdateAliasOptions**](UpdateAliasOptions)| | + +### Return type + +[**AliasDto**](AliasDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/AliasDto.md b/docs/AliasDto.md new file mode 100644 index 00000000..89209cba --- /dev/null +++ b/docs/AliasDto.md @@ -0,0 +1,41 @@ +# AliasDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**EmailAddress** | **String** | The alias's email address for receiving email | +**MaskedEmailAddress** | **String** | The underlying email address that is hidden and will received forwarded email | [optional] +**UserId** | **String** | | +**InboxId** | **String** | Inbox that is associated with the alias | +**Name** | **String** | | [optional] +**UseThreads** | **Boolean** | If alias will generate response threads or not when email are received by it | [optional] +**IsVerified** | **Boolean** | Has the alias been verified. You must verify an alias if the masked email address has not yet been verified by your account | +**DomainId** | **String** | Domain ID associated with the alias | [optional] +**CreatedAt** | **System.DateTime** | | [optional] +**UpdatedAt** | **System.DateTime** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AliasDto = Initialize-maislurp-client-powershellAliasDto -Id null ` + -EmailAddress null ` + -MaskedEmailAddress null ` + -UserId null ` + -InboxId null ` + -Name null ` + -UseThreads null ` + -IsVerified null ` + -DomainId null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$AliasDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/AliasProjection.md b/docs/AliasProjection.md new file mode 100644 index 00000000..56ac84b0 --- /dev/null +++ b/docs/AliasProjection.md @@ -0,0 +1,35 @@ +# AliasProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | | +**InboxId** | **String** | | +**UserId** | **String** | | +**UseThreads** | **Boolean** | | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | +**Name** | **String** | | [optional] +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$AliasProjection = Initialize-maislurp-client-powershellAliasProjection -EmailAddress null ` + -InboxId null ` + -UserId null ` + -UseThreads null ` + -CreatedAt null ` + -UpdatedAt null ` + -Name null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$AliasProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/AttachmentControllerApi.md b/docs/AttachmentControllerApi.md new file mode 100644 index 00000000..0774cc4d --- /dev/null +++ b/docs/AttachmentControllerApi.md @@ -0,0 +1,543 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.AttachmentControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-DeleteAllAttachments**](AttachmentControllerApi#Invoke-DeleteAllAttachments) | **DELETE** /attachments | Delete all attachments +[**Invoke-DeleteAttachment**](AttachmentControllerApi#Invoke-DeleteAttachment) | **DELETE** /attachments/{attachmentId} | Delete an attachment +[**Invoke-DownloadAttachmentAsBase64Encoded**](AttachmentControllerApi#Invoke-DownloadAttachmentAsBase64Encoded) | **GET** /attachments/{attachmentId}/base64 | Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. +[**Invoke-DownloadAttachmentAsBytes**](AttachmentControllerApi#Invoke-DownloadAttachmentAsBytes) | **GET** /attachments/{attachmentId}/bytes | Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. +[**Get-Attachment**](AttachmentControllerApi#Get-Attachment) | **GET** /attachments/{attachmentId} | Get an attachment entity +[**Get-AttachmentInfo**](AttachmentControllerApi#Get-AttachmentInfo) | **GET** /attachments/{attachmentId}/metadata | Get email attachment metadata information +[**Get-Attachments**](AttachmentControllerApi#Get-Attachments) | **GET** /attachments | Get email attachments +[**Invoke-UploadAttachment**](AttachmentControllerApi#Invoke-UploadAttachment) | **POST** /attachments | Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. +[**Invoke-UploadAttachmentBytes**](AttachmentControllerApi#Invoke-UploadAttachmentBytes) | **POST** /attachments/bytes | Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. +[**Invoke-UploadMultipartForm**](AttachmentControllerApi#Invoke-UploadMultipartForm) | **POST** /attachments/multipart | Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. + + + +# **Invoke-DeleteAllAttachments** +> void Invoke-DeleteAllAttachments
+ +Delete all attachments + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Delete all attachments +try { + $Result = Invoke-DeleteAllAttachments +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllAttachments: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAttachment** +> void Invoke-DeleteAttachment
+>         [-AttachmentId]
+ +Delete an attachment + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Delete an attachment +try { + $Result = Invoke-DeleteAttachment -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAttachment: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AttachmentId** | **String**| ID of attachment | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DownloadAttachmentAsBase64Encoded** +> DownloadAttachmentDto Invoke-DownloadAttachmentAsBase64Encoded
+>         [-AttachmentId]
+ +Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. + +Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. +try { + $Result = Invoke-DownloadAttachmentAsBase64Encoded -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Invoke-DownloadAttachmentAsBase64Encoded: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AttachmentId** | **String**| ID of attachment | + +### Return type + +[**DownloadAttachmentDto**](DownloadAttachmentDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DownloadAttachmentAsBytes** +> SystemByte Invoke-DownloadAttachmentAsBytes
+>         [-AttachmentId]
+ +Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. + +Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. +try { + $Result = Invoke-DownloadAttachmentAsBytes -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Invoke-DownloadAttachmentAsBytes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AttachmentId** | **String**| ID of attachment | + +### Return type + +[**SystemByte**](SystemByte) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Attachment** +> AttachmentEntity Get-Attachment
+>         [-AttachmentId]
+ +Get an attachment entity + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Get an attachment entity +try { + $Result = Get-Attachment -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Get-Attachment: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AttachmentId** | **String**| ID of attachment | + +### Return type + +[**AttachmentEntity**](AttachmentEntity) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AttachmentInfo** +> AttachmentMetaData Get-AttachmentInfo
+>         [-AttachmentId]
+ +Get email attachment metadata information + +Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Get email attachment metadata information +try { + $Result = Get-AttachmentInfo -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Get-AttachmentInfo: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AttachmentId** | **String**| ID of attachment | + +### Return type + +[**AttachmentMetaData**](AttachmentMetaData) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Attachments** +> PageAttachmentEntity Get-Attachments
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-FileNameFilter]
+>         [-Since]
+>         [-Before]
+>         [-InboxId]
+ +Get email attachments + +Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index for list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size for list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$FileNameFilter = "FileNameFilter_example" # String | Optional file name and content type search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$InboxId = "InboxId_example" # String | Optional inboxId to filter attachments by (optional) + +# Get email attachments +try { + $Result = Get-Attachments -Page $Page -Size $Size -Sort $Sort -FileNameFilter $FileNameFilter -Since $Since -Before $Before -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-Attachments: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index for list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size for list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **FileNameFilter** | **String**| Optional file name and content type search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **InboxId** | [**String**](String)| Optional inboxId to filter attachments by | [optional] + +### Return type + +[**PageAttachmentEntity**](PageAttachmentEntity) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-UploadAttachment** +> String[] Invoke-UploadAttachment
+>         [-UploadAttachmentOptions]
+ +Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$UploadAttachmentOptions = (Initialize-UploadAttachmentOptions -ContentId "ContentId_example" -ContentType "ContentType_example" -Filename "Filename_example" -Base64Contents "Base64Contents_example") # UploadAttachmentOptions | + +# Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. +try { + $Result = Invoke-UploadAttachment -UploadAttachmentOptions $UploadAttachmentOptions +} catch { + Write-Host ("Exception occured when calling Invoke-UploadAttachment: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **UploadAttachmentOptions** | [**UploadAttachmentOptions**](UploadAttachmentOptions)| | + +### Return type + +**String[]** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-UploadAttachmentBytes** +> String[] Invoke-UploadAttachmentBytes
+>         [-ContentType]
+>         [-ContentType2]
+>         [-ContentId]
+>         [-Filename]
+>         [-Filename2]
+ +Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ContentType = "ContentType_example" # String | (optional) +$ContentType2 = "ContentType2_example" # String | Optional contentType for file. For instance `application/pdf` (optional) +$ContentId = "ContentId_example" # String | Optional content ID (CID) to save upload with (optional) +$Filename = "Filename_example" # String | Optional filename to save upload with (optional) +$Filename2 = "Filename2_example" # String | (optional) + +# Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. +try { + $Result = Invoke-UploadAttachmentBytes -ContentType $ContentType -ContentType2 $ContentType2 -ContentId $ContentId -Filename $Filename -Filename2 $Filename2 +} catch { + Write-Host ("Exception occured when calling Invoke-UploadAttachmentBytes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ContentType** | **String**| | [optional] + **ContentType2** | **String**| Optional contentType for file. For instance `application/pdf` | [optional] + **ContentId** | **String**| Optional content ID (CID) to save upload with | [optional] + **Filename** | **String**| Optional filename to save upload with | [optional] + **Filename2** | **String**| | [optional] + +### Return type + +**String[]** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-UploadMultipartForm** +> String[] Invoke-UploadMultipartForm
+>         [-ContentId]
+>         [-ContentType]
+>         [-Filename]
+>         [-XFilename]
+>         [-InlineObject]
+ +Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ContentId = "ContentId_example" # String | Optional content ID of attachment (optional) +$ContentType = "ContentType_example" # String | Optional content type of attachment (optional) +$Filename = "Filename_example" # String | Optional name of file (optional) +$XFilename = "XFilename_example" # String | Optional content type header of attachment (optional) +$InlineObject = (Initialize-inline_object -ContentTypeHeader "ContentTypeHeader_example" -File 123) # InlineObject | (optional) + +# Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. +try { + $Result = Invoke-UploadMultipartForm -ContentId $ContentId -ContentType $ContentType -Filename $Filename -XFilename $XFilename -InlineObject $InlineObject +} catch { + Write-Host ("Exception occured when calling Invoke-UploadMultipartForm: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ContentId** | **String**| Optional content ID of attachment | [optional] + **ContentType** | **String**| Optional content type of attachment | [optional] + **Filename** | **String**| Optional name of file | [optional] + **XFilename** | **String**| Optional content type header of attachment | [optional] + **InlineObject** | [**InlineObject**](InlineObject)| | [optional] + +### Return type + +**String[]** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/AttachmentEntity.md b/docs/AttachmentEntity.md new file mode 100644 index 00000000..90f053f5 --- /dev/null +++ b/docs/AttachmentEntity.md @@ -0,0 +1,41 @@ +# AttachmentEntity +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [optional] +**AttachmentId** | **String** | | +**Bucket** | **String** | | [optional] +**UserId** | **String** | | +**ContentType** | **String** | | [optional] +**ContentLength** | **Int64** | | [optional] +**ContentId** | **String** | | [optional] +**Name** | **String** | | [optional] +**InboxId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$AttachmentEntity = Initialize-maislurp-client-powershellAttachmentEntity -Id null ` + -AttachmentId null ` + -Bucket null ` + -UserId null ` + -ContentType null ` + -ContentLength null ` + -ContentId null ` + -Name null ` + -InboxId null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$AttachmentEntity | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/AttachmentMetaData.md b/docs/AttachmentMetaData.md new file mode 100644 index 00000000..ed65add6 --- /dev/null +++ b/docs/AttachmentMetaData.md @@ -0,0 +1,29 @@ +# AttachmentMetaData +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of attachment if given | +**ContentType** | **String** | Content type of attachment such as `image/png` | +**ContentLength** | **Int64** | Size of attachment in bytes | +**Id** | **String** | ID of attachment. Can be used to with attachment controller endpoints to download attachment or with sending methods to attach to an email. | +**ContentId** | **String** | CID of attachment | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttachmentMetaData = Initialize-maislurp-client-powershellAttachmentMetaData -Name null ` + -ContentType null ` + -ContentLength null ` + -Id null ` + -ContentId null +``` + +- Convert the resource to JSON +```powershell +$AttachmentMetaData | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/AttachmentProjection.md b/docs/AttachmentProjection.md new file mode 100644 index 00000000..4197f0a1 --- /dev/null +++ b/docs/AttachmentProjection.md @@ -0,0 +1,35 @@ +# AttachmentProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | | +**ContentId** | **String** | Content ID of attachment. | [optional] +**AttachmentId** | **String** | Attachment ID | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | +**Name** | **String** | | [optional] +**ContentLength** | **Int64** | Content length of attachment in bytes | [optional] +**ContentType** | **String** | Content type of attachment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttachmentProjection = Initialize-maislurp-client-powershellAttachmentProjection -UserId null ` + -ContentId null ` + -AttachmentId null ` + -CreatedAt null ` + -UpdatedAt null ` + -Name null ` + -ContentLength null ` + -ContentType image/png +``` + +- Convert the resource to JSON +```powershell +$AttachmentProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/BasicAuthOptions.md b/docs/BasicAuthOptions.md new file mode 100644 index 00000000..25db6774 --- /dev/null +++ b/docs/BasicAuthOptions.md @@ -0,0 +1,23 @@ +# BasicAuthOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Username** | **String** | | +**Password** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$BasicAuthOptions = Initialize-maislurp-client-powershellBasicAuthOptions -Username null ` + -Password null +``` + +- Convert the resource to JSON +```powershell +$BasicAuthOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/BounceControllerApi.md b/docs/BounceControllerApi.md new file mode 100644 index 00000000..7b0345cc --- /dev/null +++ b/docs/BounceControllerApi.md @@ -0,0 +1,507 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.BounceControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-FilterBouncedRecipient**](BounceControllerApi#Invoke-FilterBouncedRecipient) | **POST** /bounce/filter-recipients | Filter a list of email recipients and remove those who have bounced +[**Get-AccountBounceBlockStatus**](BounceControllerApi#Get-AccountBounceBlockStatus) | **GET** /bounce/account-block | Can account send email +[**Get-BouncedEmail**](BounceControllerApi#Get-BouncedEmail) | **GET** /bounce/emails/{id} | Get a bounced email. +[**Get-BouncedEmails**](BounceControllerApi#Get-BouncedEmails) | **GET** /bounce/emails | Get paginated list of bounced emails. +[**Get-BouncedRecipient**](BounceControllerApi#Get-BouncedRecipient) | **GET** /bounce/recipients/{id} | Get a bounced email. +[**Get-BouncedRecipients**](BounceControllerApi#Get-BouncedRecipients) | **GET** /bounce/recipients | Get paginated list of bounced recipients. +[**Get-Complaint**](BounceControllerApi#Get-Complaint) | **GET** /bounce/complaints/{id} | Get complaint +[**Get-Complaints**](BounceControllerApi#Get-Complaints) | **GET** /bounce/complaints | Get paginated list of complaints. +[**Get-ListUnsubscribeRecipients**](BounceControllerApi#Get-ListUnsubscribeRecipients) | **GET** /bounce/list-unsubscribe-recipients | Get paginated list of unsubscribed recipients. + + + +# **Invoke-FilterBouncedRecipient** +> FilterBouncedRecipientsResult Invoke-FilterBouncedRecipient
+>         [-FilterBouncedRecipientsOptions]
+ +Filter a list of email recipients and remove those who have bounced + +Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$FilterBouncedRecipientsOptions = (Initialize-FilterBouncedRecipientsOptions -EmailRecipients @("EmailRecipients_example")) # FilterBouncedRecipientsOptions | + +# Filter a list of email recipients and remove those who have bounced +try { + $Result = Invoke-FilterBouncedRecipient -FilterBouncedRecipientsOptions $FilterBouncedRecipientsOptions +} catch { + Write-Host ("Exception occured when calling Invoke-FilterBouncedRecipient: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **FilterBouncedRecipientsOptions** | [**FilterBouncedRecipientsOptions**](FilterBouncedRecipientsOptions)| | + +### Return type + +[**FilterBouncedRecipientsResult**](FilterBouncedRecipientsResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AccountBounceBlockStatus** +> AccountBounceBlockDto Get-AccountBounceBlockStatus
+ +Can account send email + +Check if account block status prevents sending + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Can account send email +try { + $Result = Get-AccountBounceBlockStatus +} catch { + Write-Host ("Exception occured when calling Get-AccountBounceBlockStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AccountBounceBlockDto**](AccountBounceBlockDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-BouncedEmail** +> BouncedEmailDto Get-BouncedEmail
+>         [-Id]
+ +Get a bounced email. + +Bounced emails are email you have sent that were rejected by a recipient + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of the bounced email to fetch + +# Get a bounced email. +try { + $Result = Get-BouncedEmail -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-BouncedEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of the bounced email to fetch | + +### Return type + +[**BouncedEmailDto**](BouncedEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-BouncedEmails** +> PageBouncedEmail Get-BouncedEmails
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get paginated list of bounced emails. + +Bounced emails are email you have sent that were rejected by a recipient + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index (optional) (default to 0) +$Size = 987 # Int32 | Optional page size (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get paginated list of bounced emails. +try { + $Result = Get-BouncedEmails -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-BouncedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index | [optional] [default to 0] + **Size** | **Int32**| Optional page size | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageBouncedEmail**](PageBouncedEmail) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-BouncedRecipient** +> BouncedRecipientDto Get-BouncedRecipient
+>         [-Id]
+ +Get a bounced email. + +Bounced emails are email you have sent that were rejected by a recipient + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of the bounced recipient + +# Get a bounced email. +try { + $Result = Get-BouncedRecipient -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-BouncedRecipient: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of the bounced recipient | + +### Return type + +[**BouncedRecipientDto**](BouncedRecipientDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-BouncedRecipients** +> PageBouncedRecipients Get-BouncedRecipients
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get paginated list of bounced recipients. + +Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index (optional) (default to 0) +$Size = 987 # Int32 | Optional page size (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get paginated list of bounced recipients. +try { + $Result = Get-BouncedRecipients -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-BouncedRecipients: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index | [optional] [default to 0] + **Size** | **Int32**| Optional page size | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageBouncedRecipients**](PageBouncedRecipients) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Complaint** +> Complaint Get-Complaint
+>         [-Id]
+ +Get complaint + +Get complaint + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of the complaint + +# Get complaint +try { + $Result = Get-Complaint -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-Complaint: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of the complaint | + +### Return type + +[**Complaint**](Complaint) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Complaints** +> PageComplaint Get-Complaints
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get paginated list of complaints. + +SMTP complaints made against your account + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index (optional) (default to 0) +$Size = 987 # Int32 | Optional page size (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get paginated list of complaints. +try { + $Result = Get-Complaints -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-Complaints: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index | [optional] [default to 0] + **Size** | **Int32**| Optional page size | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageComplaint**](PageComplaint) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ListUnsubscribeRecipients** +> PageListUnsubscribeRecipients Get-ListUnsubscribeRecipients
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-DomainId]
+ +Get paginated list of unsubscribed recipients. + +Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index (optional) (default to 0) +$Size = 987 # Int32 | Optional page size (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$DomainId = "DomainId_example" # String | Filter by domainId (optional) + +# Get paginated list of unsubscribed recipients. +try { + $Result = Get-ListUnsubscribeRecipients -Page $Page -Size $Size -Sort $Sort -DomainId $DomainId +} catch { + Write-Host ("Exception occured when calling Get-ListUnsubscribeRecipients: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index | [optional] [default to 0] + **Size** | **Int32**| Optional page size | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **DomainId** | [**String**](String)| Filter by domainId | [optional] + +### Return type + +[**PageListUnsubscribeRecipients**](PageListUnsubscribeRecipients) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/BounceProjection.md b/docs/BounceProjection.md new file mode 100644 index 00000000..af7a8bed --- /dev/null +++ b/docs/BounceProjection.md @@ -0,0 +1,31 @@ +# BounceProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarSender** | **String** | | +**BounceMta** | **String** | | [optional] +**BounceType** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Subject** | **String** | | [optional] +**Id** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$BounceProjection = Initialize-maislurp-client-powershellBounceProjection -VarSender null ` + -BounceMta null ` + -BounceType null ` + -CreatedAt null ` + -Subject null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$BounceProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/BounceRecipientProjection.md b/docs/BounceRecipientProjection.md new file mode 100644 index 00000000..19d125bb --- /dev/null +++ b/docs/BounceRecipientProjection.md @@ -0,0 +1,33 @@ +# BounceRecipientProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SentEmailId** | **String** | | [optional] +**Recipient** | **String** | | +**Action** | **String** | | [optional] +**BounceType** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | [optional] +**Status** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$BounceRecipientProjection = Initialize-maislurp-client-powershellBounceRecipientProjection -SentEmailId null ` + -Recipient null ` + -Action null ` + -BounceType null ` + -CreatedAt null ` + -Id null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$BounceRecipientProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/BouncedEmailDto.md b/docs/BouncedEmailDto.md new file mode 100644 index 00000000..fd12aca7 --- /dev/null +++ b/docs/BouncedEmailDto.md @@ -0,0 +1,43 @@ +# BouncedEmailDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**NotificationType** | **String** | | +**SentToRecipients** | **String[]** | | [optional] +**VarSender** | **String** | | +**BounceMta** | **String** | | [optional] +**BounceType** | **String** | | [optional] +**BounceRecipients** | **String[]** | | [optional] +**BounceSubType** | **String** | | [optional] +**SentEmailId** | **String** | | [optional] +**Subject** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$BouncedEmailDto = Initialize-maislurp-client-powershellBouncedEmailDto -Id null ` + -UserId null ` + -NotificationType null ` + -SentToRecipients null ` + -VarSender null ` + -BounceMta null ` + -BounceType null ` + -BounceRecipients null ` + -BounceSubType null ` + -SentEmailId null ` + -Subject null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$BouncedEmailDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/BouncedRecipientDto.md b/docs/BouncedRecipientDto.md new file mode 100644 index 00000000..0ca4f8fb --- /dev/null +++ b/docs/BouncedRecipientDto.md @@ -0,0 +1,37 @@ +# BouncedRecipientDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | [optional] +**SentEmailId** | **String** | | [optional] +**Recipient** | **String** | | +**DiagnosticCode** | **String** | | [optional] +**Action** | **String** | | [optional] +**BounceType** | **String** | | [optional] +**Status** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$BouncedRecipientDto = Initialize-maislurp-client-powershellBouncedRecipientDto -Id null ` + -UserId null ` + -SentEmailId null ` + -Recipient null ` + -DiagnosticCode null ` + -Action null ` + -BounceType null ` + -Status null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$BouncedRecipientDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/BulkActionsControllerApi.md b/docs/BulkActionsControllerApi.md new file mode 100644 index 00000000..ee1e31ef --- /dev/null +++ b/docs/BulkActionsControllerApi.md @@ -0,0 +1,155 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.BulkActionsControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-BulkCreateInboxes**](BulkActionsControllerApi#Invoke-BulkCreateInboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses) +[**Invoke-BulkDeleteInboxes**](BulkActionsControllerApi#Invoke-BulkDeleteInboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes +[**Invoke-BulkSendEmails**](BulkActionsControllerApi#Invoke-BulkSendEmails) | **POST** /bulk/send | Bulk Send Emails + + + +# **Invoke-BulkCreateInboxes** +> InboxDto[] Invoke-BulkCreateInboxes
+>         [-Count]
+ +Bulk create Inboxes (email addresses) + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Count = 987 # Int32 | Number of inboxes to be created in bulk + +# Bulk create Inboxes (email addresses) +try { + $Result = Invoke-BulkCreateInboxes -Count $Count +} catch { + Write-Host ("Exception occured when calling Invoke-BulkCreateInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Count** | **Int32**| Number of inboxes to be created in bulk | + +### Return type + +[**InboxDto[]**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-BulkDeleteInboxes** +> void Invoke-BulkDeleteInboxes
+>         [-RequestBody]
+ +Bulk Delete Inboxes + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$RequestBody = @("Property_example") # String[] | + +# Bulk Delete Inboxes +try { + $Result = Invoke-BulkDeleteInboxes -RequestBody $RequestBody +} catch { + Write-Host ("Exception occured when calling Invoke-BulkDeleteInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **RequestBody** | [**String[]**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-BulkSendEmails** +> void Invoke-BulkSendEmails
+>         [-BulkSendEmailOptions]
+ +Bulk Send Emails + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$BulkSendEmailOptions = (Initialize-BulkSendEmailOptions -InboxIds @("InboxIds_example") -SendEmailOptions (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID" -IgnoreEmptyRecipients $false -IsXAmpHtml $false -BodyParts @((Initialize-SendEmailBodyPart -ContentType "ContentType_example" -ContentBody "ContentBody_example")))) # BulkSendEmailOptions | + +# Bulk Send Emails +try { + $Result = Invoke-BulkSendEmails -BulkSendEmailOptions $BulkSendEmailOptions +} catch { + Write-Host ("Exception occured when calling Invoke-BulkSendEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **BulkSendEmailOptions** | [**BulkSendEmailOptions**](BulkSendEmailOptions)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/BulkSendEmailOptions.md b/docs/BulkSendEmailOptions.md new file mode 100644 index 00000000..6170d0e3 --- /dev/null +++ b/docs/BulkSendEmailOptions.md @@ -0,0 +1,23 @@ +# BulkSendEmailOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxIds** | **String[]** | Inboxes to send the email from | +**SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions) | | + +## Examples + +- Prepare the resource +```powershell +$BulkSendEmailOptions = Initialize-maislurp-client-powershellBulkSendEmailOptions -InboxIds null ` + -SendEmailOptions null +``` + +- Convert the resource to JSON +```powershell +$BulkSendEmailOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CanSendEmailResults.md b/docs/CanSendEmailResults.md new file mode 100644 index 00000000..6912c820 --- /dev/null +++ b/docs/CanSendEmailResults.md @@ -0,0 +1,23 @@ +# CanSendEmailResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsSendingPermitted** | **Boolean** | | +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CanSendEmailResults = Initialize-maislurp-client-powershellCanSendEmailResults -IsSendingPermitted null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$CanSendEmailResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CheckEmailBodyFeatureSupportResults.md b/docs/CheckEmailBodyFeatureSupportResults.md new file mode 100644 index 00000000..1fe2eb14 --- /dev/null +++ b/docs/CheckEmailBodyFeatureSupportResults.md @@ -0,0 +1,21 @@ +# CheckEmailBodyFeatureSupportResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Result** | [**EmailFeatureSupportResult**](EmailFeatureSupportResult) | | + +## Examples + +- Prepare the resource +```powershell +$CheckEmailBodyFeatureSupportResults = Initialize-maislurp-client-powershellCheckEmailBodyFeatureSupportResults -Result null +``` + +- Convert the resource to JSON +```powershell +$CheckEmailBodyFeatureSupportResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CheckEmailBodyResults.md b/docs/CheckEmailBodyResults.md new file mode 100644 index 00000000..2c508c3b --- /dev/null +++ b/docs/CheckEmailBodyResults.md @@ -0,0 +1,27 @@ +# CheckEmailBodyResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasIssues** | **Boolean** | | +**LinkIssues** | [**LinkIssue[]**](LinkIssue) | | +**ImageIssues** | [**ImageIssue[]**](ImageIssue) | | +**SpellingIssues** | [**SpellingIssue[]**](SpellingIssue) | | + +## Examples + +- Prepare the resource +```powershell +$CheckEmailBodyResults = Initialize-maislurp-client-powershellCheckEmailBodyResults -HasIssues null ` + -LinkIssues null ` + -ImageIssues null ` + -SpellingIssues null +``` + +- Convert the resource to JSON +```powershell +$CheckEmailBodyResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CheckEmailClientSupportOptions.md b/docs/CheckEmailClientSupportOptions.md new file mode 100644 index 00000000..4d14944b --- /dev/null +++ b/docs/CheckEmailClientSupportOptions.md @@ -0,0 +1,21 @@ +# CheckEmailClientSupportOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailBody** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$CheckEmailClientSupportOptions = Initialize-maislurp-client-powershellCheckEmailClientSupportOptions -EmailBody null +``` + +- Convert the resource to JSON +```powershell +$CheckEmailClientSupportOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CheckEmailClientSupportResults.md b/docs/CheckEmailClientSupportResults.md new file mode 100644 index 00000000..6001107f --- /dev/null +++ b/docs/CheckEmailClientSupportResults.md @@ -0,0 +1,21 @@ +# CheckEmailClientSupportResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Result** | [**EmailFeatureSupportResult**](EmailFeatureSupportResult) | | + +## Examples + +- Prepare the resource +```powershell +$CheckEmailClientSupportResults = Initialize-maislurp-client-powershellCheckEmailClientSupportResults -Result null +``` + +- Convert the resource to JSON +```powershell +$CheckEmailClientSupportResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CheckEmailFeaturesClientSupportOptions.md b/docs/CheckEmailFeaturesClientSupportOptions.md new file mode 100644 index 00000000..6fde5fa0 --- /dev/null +++ b/docs/CheckEmailFeaturesClientSupportOptions.md @@ -0,0 +1,21 @@ +# CheckEmailFeaturesClientSupportOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailBody** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$CheckEmailFeaturesClientSupportOptions = Initialize-maislurp-client-powershellCheckEmailFeaturesClientSupportOptions -EmailBody null +``` + +- Convert the resource to JSON +```powershell +$CheckEmailFeaturesClientSupportOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CheckEmailFeaturesClientSupportResults.md b/docs/CheckEmailFeaturesClientSupportResults.md new file mode 100644 index 00000000..39453339 --- /dev/null +++ b/docs/CheckEmailFeaturesClientSupportResults.md @@ -0,0 +1,21 @@ +# CheckEmailFeaturesClientSupportResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Result** | [**EmailFeatureSupportResult**](EmailFeatureSupportResult) | | + +## Examples + +- Prepare the resource +```powershell +$CheckEmailFeaturesClientSupportResults = Initialize-maislurp-client-powershellCheckEmailFeaturesClientSupportResults -Result null +``` + +- Convert the resource to JSON +```powershell +$CheckEmailFeaturesClientSupportResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CommonActionsControllerApi.md b/docs/CommonActionsControllerApi.md new file mode 100644 index 00000000..79cfb240 --- /dev/null +++ b/docs/CommonActionsControllerApi.md @@ -0,0 +1,407 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.CommonActionsControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-NewEmailAddress**](CommonActionsControllerApi#New-NewEmailAddress) | **POST** /newEmailAddress | Create new random inbox +[**New-RandomInbox**](CommonActionsControllerApi#New-RandomInbox) | **POST** /createInbox | Create new random inbox +[**Invoke-DeleteEmailAddress**](CommonActionsControllerApi#Invoke-DeleteEmailAddress) | **DELETE** /deleteEmailAddress | Delete inbox email address by inbox id +[**Invoke-EmptyInbox**](CommonActionsControllerApi#Invoke-EmptyInbox) | **DELETE** /emptyInbox | Delete all emails in an inbox +[**Send-EmailQuery**](CommonActionsControllerApi#Send-EmailQuery) | **POST** /sendEmailQuery | Send an email using query parameters +[**Send-EmailSimple**](CommonActionsControllerApi#Send-EmailSimple) | **POST** /sendEmail | Send an email + + + +# **New-NewEmailAddress** +> InboxDto New-NewEmailAddress
+>         [-AllowTeamAccess]
+>         [-UseDomainPool]
+>         [-ExpiresAt]
+>         [-ExpiresIn]
+>         [-EmailAddress]
+>         [-InboxType]
+>         [-Description]
+>         [-Name]
+>         [-Tags]
+>         [-Favourite]
+>         [-VirtualInbox]
+>         [-UseShortAddress]
+>         [-DomainName]
+>         [-DomainId]
+>         [-Prefix]
+ +Create new random inbox + +Returns an Inbox with an `id` and an `emailAddress` + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AllowTeamAccess = true # Boolean | (optional) +$UseDomainPool = true # Boolean | (optional) +$ExpiresAt = Get-Date # System.DateTime | (optional) +$ExpiresIn = 987 # Int64 | (optional) +$EmailAddress = "EmailAddress_example" # String | (optional) +$InboxType = "HTTP_INBOX" # String | (optional) +$Description = "Description_example" # String | (optional) +$Name = "Name_example" # String | (optional) +$Tags = @("Inner_example") # String[] | (optional) +$Favourite = true # Boolean | (optional) +$VirtualInbox = true # Boolean | (optional) +$UseShortAddress = true # Boolean | (optional) +$DomainName = "DomainName_example" # String | (optional) +$DomainId = "DomainId_example" # String | (optional) +$Prefix = "Prefix_example" # String | (optional) + +# Create new random inbox +try { + $Result = New-NewEmailAddress -AllowTeamAccess $AllowTeamAccess -UseDomainPool $UseDomainPool -ExpiresAt $ExpiresAt -ExpiresIn $ExpiresIn -EmailAddress $EmailAddress -InboxType $InboxType -Description $Description -Name $Name -Tags $Tags -Favourite $Favourite -VirtualInbox $VirtualInbox -UseShortAddress $UseShortAddress -DomainName $DomainName -DomainId $DomainId -Prefix $Prefix +} catch { + Write-Host ("Exception occured when calling New-NewEmailAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AllowTeamAccess** | **Boolean**| | [optional] + **UseDomainPool** | **Boolean**| | [optional] + **ExpiresAt** | **System.DateTime**| | [optional] + **ExpiresIn** | **Int64**| | [optional] + **EmailAddress** | **String**| | [optional] + **InboxType** | **String**| | [optional] + **Description** | **String**| | [optional] + **Name** | **String**| | [optional] + **Tags** | [**String[]**](String)| | [optional] + **Favourite** | **Boolean**| | [optional] + **VirtualInbox** | **Boolean**| | [optional] + **UseShortAddress** | **Boolean**| | [optional] + **DomainName** | **String**| | [optional] + **DomainId** | [**String**](String)| | [optional] + **Prefix** | **String**| | [optional] + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-RandomInbox** +> InboxDto New-RandomInbox
+>         [-AllowTeamAccess]
+>         [-UseDomainPool]
+>         [-ExpiresAt]
+>         [-ExpiresIn]
+>         [-EmailAddress]
+>         [-InboxType]
+>         [-Description]
+>         [-Name]
+>         [-Tags]
+>         [-Favourite]
+>         [-VirtualInbox]
+>         [-UseShortAddress]
+>         [-DomainName]
+>         [-DomainId]
+>         [-Prefix]
+ +Create new random inbox + +Returns an Inbox with an `id` and an `emailAddress` + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AllowTeamAccess = true # Boolean | (optional) +$UseDomainPool = true # Boolean | (optional) +$ExpiresAt = Get-Date # System.DateTime | (optional) +$ExpiresIn = 987 # Int64 | (optional) +$EmailAddress = "EmailAddress_example" # String | (optional) +$InboxType = "HTTP_INBOX" # String | (optional) +$Description = "Description_example" # String | (optional) +$Name = "Name_example" # String | (optional) +$Tags = @("Inner_example") # String[] | (optional) +$Favourite = true # Boolean | (optional) +$VirtualInbox = true # Boolean | (optional) +$UseShortAddress = true # Boolean | (optional) +$DomainName = "DomainName_example" # String | (optional) +$DomainId = "DomainId_example" # String | (optional) +$Prefix = "Prefix_example" # String | (optional) + +# Create new random inbox +try { + $Result = New-RandomInbox -AllowTeamAccess $AllowTeamAccess -UseDomainPool $UseDomainPool -ExpiresAt $ExpiresAt -ExpiresIn $ExpiresIn -EmailAddress $EmailAddress -InboxType $InboxType -Description $Description -Name $Name -Tags $Tags -Favourite $Favourite -VirtualInbox $VirtualInbox -UseShortAddress $UseShortAddress -DomainName $DomainName -DomainId $DomainId -Prefix $Prefix +} catch { + Write-Host ("Exception occured when calling New-RandomInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AllowTeamAccess** | **Boolean**| | [optional] + **UseDomainPool** | **Boolean**| | [optional] + **ExpiresAt** | **System.DateTime**| | [optional] + **ExpiresIn** | **Int64**| | [optional] + **EmailAddress** | **String**| | [optional] + **InboxType** | **String**| | [optional] + **Description** | **String**| | [optional] + **Name** | **String**| | [optional] + **Tags** | [**String[]**](String)| | [optional] + **Favourite** | **Boolean**| | [optional] + **VirtualInbox** | **Boolean**| | [optional] + **UseShortAddress** | **Boolean**| | [optional] + **DomainName** | **String**| | [optional] + **DomainId** | [**String**](String)| | [optional] + **Prefix** | **String**| | [optional] + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteEmailAddress** +> void Invoke-DeleteEmailAddress
+>         [-InboxId]
+ +Delete inbox email address by inbox id + +Deletes inbox email address + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Delete inbox email address by inbox id +try { + $Result = Invoke-DeleteEmailAddress -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteEmailAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-EmptyInbox** +> void Invoke-EmptyInbox
+>         [-InboxId]
+ +Delete all emails in an inbox + +Deletes all emails + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Delete all emails in an inbox +try { + $Result = Invoke-EmptyInbox -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-EmptyInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-EmailQuery** +> void Send-EmailQuery
+>         [-To]
+>         [-SenderId]
+>         [-Body]
+>         [-Subject]
+ +Send an email using query parameters + +If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$To = "To_example" # String | Email address to send to +$SenderId = "SenderId_example" # String | ID of inbox to send from. If null an inbox will be created for sending (optional) +$Body = "Body_example" # String | Body of the email message. Supports HTML (optional) +$Subject = "Subject_example" # String | Subject line of the email (optional) + +# Send an email using query parameters +try { + $Result = Send-EmailQuery -To $To -SenderId $SenderId -Body $Body -Subject $Subject +} catch { + Write-Host ("Exception occured when calling Send-EmailQuery: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **To** | **String**| Email address to send to | + **SenderId** | [**String**](String)| ID of inbox to send from. If null an inbox will be created for sending | [optional] + **Body** | **String**| Body of the email message. Supports HTML | [optional] + **Subject** | **String**| Subject line of the email | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-EmailSimple** +> void Send-EmailSimple
+>         [-SimpleSendEmailOptions]
+ +Send an email + +If no senderId or inboxId provided a random email address will be used to send from. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SimpleSendEmailOptions = (Initialize-SimpleSendEmailOptions -SenderId "SenderId_example" -To "To_example" -Body "Body_example" -Subject "Subject_example") # SimpleSendEmailOptions | + +# Send an email +try { + $Result = Send-EmailSimple -SimpleSendEmailOptions $SimpleSendEmailOptions +} catch { + Write-Host ("Exception occured when calling Send-EmailSimple: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SimpleSendEmailOptions** | [**SimpleSendEmailOptions**](SimpleSendEmailOptions)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/Complaint.md b/docs/Complaint.md new file mode 100644 index 00000000..56e7b1d1 --- /dev/null +++ b/docs/Complaint.md @@ -0,0 +1,35 @@ +# Complaint +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | [optional] +**EventType** | **String** | | [optional] +**MailSource** | **String** | | [optional] +**MailMessageId** | **String** | | [optional] +**ComplaintRecipient** | **String** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$Complaint = Initialize-maislurp-client-powershellComplaint -Id null ` + -UserId null ` + -EventType null ` + -MailSource null ` + -MailMessageId null ` + -ComplaintRecipient null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$Complaint | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConditionOption.md b/docs/ConditionOption.md new file mode 100644 index 00000000..deca683a --- /dev/null +++ b/docs/ConditionOption.md @@ -0,0 +1,23 @@ +# ConditionOption +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Condition** | **String** | Condition of an email object that can be used to filter results | +**Value** | **String** | Expected condition value | + +## Examples + +- Prepare the resource +```powershell +$ConditionOption = Initialize-maislurp-client-powershellConditionOption -Condition null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$ConditionOption | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorControllerApi.md b/docs/ConnectorControllerApi.md new file mode 100644 index 00000000..de5c2cfc --- /dev/null +++ b/docs/ConnectorControllerApi.md @@ -0,0 +1,749 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.ConnectorControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Connector**](ConnectorControllerApi#New-Connector) | **POST** /connectors | Create an inbox connector +[**New-ConnectorImapConnection**](ConnectorControllerApi#New-ConnectorImapConnection) | **POST** /connectors/{id}/imap | Create an inbox connector IMAP connection +[**New-ConnectorSmtpConnection**](ConnectorControllerApi#New-ConnectorSmtpConnection) | **POST** /connectors/{id}/smtp | Create an inbox connector SMTP connection +[**Invoke-DeleteAllConnector**](ConnectorControllerApi#Invoke-DeleteAllConnector) | **DELETE** /connectors | Delete all inbox connectors +[**Invoke-DeleteConnector**](ConnectorControllerApi#Invoke-DeleteConnector) | **DELETE** /connectors/{id} | Delete an inbox connector +[**Invoke-DeleteConnectorImapConnection**](ConnectorControllerApi#Invoke-DeleteConnectorImapConnection) | **DELETE** /connectors/{id}/imap | Delete an inbox connector IMAP connection +[**Invoke-DeleteConnectorSmtpConnection**](ConnectorControllerApi#Invoke-DeleteConnectorSmtpConnection) | **DELETE** /connectors/{id}/smtp | Delete an inbox connector SMTP connection +[**Get-AllConnectorSyncEvents**](ConnectorControllerApi#Get-AllConnectorSyncEvents) | **GET** /connectors/events | Get all inbox connector sync events +[**Get-Connector**](ConnectorControllerApi#Get-Connector) | **GET** /connectors/{id} | Get an inbox connector +[**Get-ConnectorSyncEvent**](ConnectorControllerApi#Get-ConnectorSyncEvent) | **GET** /connectors/events/{id} | Get an inbox connector sync event +[**Get-ConnectorSyncEvents**](ConnectorControllerApi#Get-ConnectorSyncEvents) | **GET** /connectors/{id}/events | Get an inbox connector sync events +[**Get-Connectors**](ConnectorControllerApi#Get-Connectors) | **GET** /connectors | Get inbox connectors +[**Sync-Connector**](ConnectorControllerApi#Sync-Connector) | **POST** /connectors/{id}/sync | Sync an inbox connector +[**Update-Connector**](ConnectorControllerApi#Update-Connector) | **PUT** /connectors/{id} | Update an inbox connector + + + +# **New-Connector** +> ConnectorDto New-Connector
+>         [-CreateConnectorOptions]
+ +Create an inbox connector + +Sync emails between external mailboxes and MailSlurp inboxes + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateConnectorOptions = (Initialize-CreateConnectorOptions -SyncEnabled $false -SyncScheduleType "INTERVAL" -SyncInterval 123 -Name "Name_example" -EmailAddress "EmailAddress_example" -Enabled $false) # CreateConnectorOptions | + +# Create an inbox connector +try { + $Result = New-Connector -CreateConnectorOptions $CreateConnectorOptions +} catch { + Write-Host ("Exception occured when calling New-Connector: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateConnectorOptions** | [**CreateConnectorOptions**](CreateConnectorOptions)| | + +### Return type + +[**ConnectorDto**](ConnectorDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-ConnectorImapConnection** +> ConnectorImapConnectionDto New-ConnectorImapConnection
+>         [-Id]
+>         [-CreateConnectorImapConnectionOptions]
+ +Create an inbox connector IMAP connection + +Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$CreateConnectorImapConnectionOptions = (Initialize-CreateConnectorImapConnectionOptions -ImapSsl $false -ImapUsername "ImapUsername_example" -ImapPassword "ImapPassword_example" -SelectFolder "SelectFolder_example" -SearchTerms "SearchTerms_example" -ImapPort 123 -ImapHost "ImapHost_example" -Enabled $false) # CreateConnectorImapConnectionOptions | + +# Create an inbox connector IMAP connection +try { + $Result = New-ConnectorImapConnection -Id $Id -CreateConnectorImapConnectionOptions $CreateConnectorImapConnectionOptions +} catch { + Write-Host ("Exception occured when calling New-ConnectorImapConnection: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **CreateConnectorImapConnectionOptions** | [**CreateConnectorImapConnectionOptions**](CreateConnectorImapConnectionOptions)| | + +### Return type + +[**ConnectorImapConnectionDto**](ConnectorImapConnectionDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-ConnectorSmtpConnection** +> ConnectorSmtpConnectionDto New-ConnectorSmtpConnection
+>         [-Id]
+>         [-CreateConnectorSmtpConnectionOptions]
+ +Create an inbox connector SMTP connection + +Allows sending via connector and email is routed to connected inbox and sent via SMTP + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$CreateConnectorSmtpConnectionOptions = (Initialize-CreateConnectorSmtpConnectionOptions -Enabled $false -SmtpHost "SmtpHost_example" -SmtpPort 123 -SmtpSsl $false -SmtpUsername "SmtpUsername_example" -SmtpPassword "SmtpPassword_example") # CreateConnectorSmtpConnectionOptions | + +# Create an inbox connector SMTP connection +try { + $Result = New-ConnectorSmtpConnection -Id $Id -CreateConnectorSmtpConnectionOptions $CreateConnectorSmtpConnectionOptions +} catch { + Write-Host ("Exception occured when calling New-ConnectorSmtpConnection: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **CreateConnectorSmtpConnectionOptions** | [**CreateConnectorSmtpConnectionOptions**](CreateConnectorSmtpConnectionOptions)| | + +### Return type + +[**ConnectorSmtpConnectionDto**](ConnectorSmtpConnectionDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllConnector** +> void Invoke-DeleteAllConnector
+ +Delete all inbox connectors + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Delete all inbox connectors +try { + $Result = Invoke-DeleteAllConnector +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllConnector: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteConnector** +> void Invoke-DeleteConnector
+>         [-Id]
+ +Delete an inbox connector + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Delete an inbox connector +try { + $Result = Invoke-DeleteConnector -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteConnector: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteConnectorImapConnection** +> void Invoke-DeleteConnectorImapConnection
+>         [-Id]
+ +Delete an inbox connector IMAP connection + +Delete IMAP connection for external inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Delete an inbox connector IMAP connection +try { + $Result = Invoke-DeleteConnectorImapConnection -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteConnectorImapConnection: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteConnectorSmtpConnection** +> void Invoke-DeleteConnectorSmtpConnection
+>         [-Id]
+ +Delete an inbox connector SMTP connection + +Delete SMTP connection for external inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Delete an inbox connector SMTP connection +try { + $Result = Invoke-DeleteConnectorSmtpConnection -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteConnectorSmtpConnection: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllConnectorSyncEvents** +> PageConnectorSyncEvents Get-AllConnectorSyncEvents
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get all inbox connector sync events + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in connector list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in connector list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get all inbox connector sync events +try { + $Result = Get-AllConnectorSyncEvents -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllConnectorSyncEvents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in connector list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in connector list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageConnectorSyncEvents**](PageConnectorSyncEvents) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Connector** +> ConnectorDto Get-Connector
+>         [-Id]
+ +Get an inbox connector + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get an inbox connector +try { + $Result = Get-Connector -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-Connector: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**ConnectorDto**](ConnectorDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ConnectorSyncEvent** +> ConnectorSyncEventDto Get-ConnectorSyncEvent
+>         [-Id]
+ +Get an inbox connector sync event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get an inbox connector sync event +try { + $Result = Get-ConnectorSyncEvent -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-ConnectorSyncEvent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**ConnectorSyncEventDto**](ConnectorSyncEventDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ConnectorSyncEvents** +> PageConnectorSyncEvents Get-ConnectorSyncEvents
+>         [-Id]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get an inbox connector sync events + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$Page = 987 # Int32 | Optional page index in connector list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in connector list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get an inbox connector sync events +try { + $Result = Get-ConnectorSyncEvents -Id $Id -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-ConnectorSyncEvents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **Page** | **Int32**| Optional page index in connector list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in connector list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageConnectorSyncEvents**](PageConnectorSyncEvents) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Connectors** +> PageConnector Get-Connectors
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get inbox connectors + +List inbox connectors that sync external emails to MailSlurp inboxes + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in connector list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in connector list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get inbox connectors +try { + $Result = Get-Connectors -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-Connectors: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in connector list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in connector list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageConnector**](PageConnector) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Sync-Connector** +> ConnectorSyncRequestResult Sync-Connector
+>         [-Id]
+ +Sync an inbox connector + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Sync an inbox connector +try { + $Result = Sync-Connector -Id $Id +} catch { + Write-Host ("Exception occured when calling Sync-Connector: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**ConnectorSyncRequestResult**](ConnectorSyncRequestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-Connector** +> ConnectorDto Update-Connector
+>         [-Id]
+>         [-CreateConnectorOptions]
+ +Update an inbox connector + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$CreateConnectorOptions = (Initialize-CreateConnectorOptions -SyncEnabled $false -SyncScheduleType "INTERVAL" -SyncInterval 123 -Name "Name_example" -EmailAddress "EmailAddress_example" -Enabled $false) # CreateConnectorOptions | + +# Update an inbox connector +try { + $Result = Update-Connector -Id $Id -CreateConnectorOptions $CreateConnectorOptions +} catch { + Write-Host ("Exception occured when calling Update-Connector: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **CreateConnectorOptions** | [**CreateConnectorOptions**](CreateConnectorOptions)| | + +### Return type + +[**ConnectorDto**](ConnectorDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/ConnectorDto.md b/docs/ConnectorDto.md new file mode 100644 index 00000000..2d29017e --- /dev/null +++ b/docs/ConnectorDto.md @@ -0,0 +1,41 @@ +# ConnectorDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**Name** | **String** | | [optional] +**Enabled** | **Boolean** | | +**UserId** | **String** | | +**InboxId** | **String** | | +**SyncEnabled** | **Boolean** | | +**SyncScheduleType** | **String** | | [optional] +**SyncInterval** | **Int32** | | [optional] +**HasImapConnection** | **Boolean** | | +**HasSmtpConnection** | **Boolean** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$ConnectorDto = Initialize-maislurp-client-powershellConnectorDto -Id null ` + -Name null ` + -Enabled null ` + -UserId null ` + -InboxId null ` + -SyncEnabled null ` + -SyncScheduleType null ` + -SyncInterval null ` + -HasImapConnection null ` + -HasSmtpConnection null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$ConnectorDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorImapConnectionDto.md b/docs/ConnectorImapConnectionDto.md new file mode 100644 index 00000000..69f0afab --- /dev/null +++ b/docs/ConnectorImapConnectionDto.md @@ -0,0 +1,41 @@ +# ConnectorImapConnectionDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorId** | **String** | | +**ImapHost** | **String** | | [optional] +**ImapPort** | **Int32** | | [optional] +**ImapUsername** | **String** | | [optional] +**ImapPassword** | **String** | | [optional] +**ImapSsl** | **Boolean** | | [optional] +**SelectFolder** | **String** | | [optional] +**SearchTerms** | **String** | | [optional] +**Enabled** | **Boolean** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ConnectorImapConnectionDto = Initialize-maislurp-client-powershellConnectorImapConnectionDto -ConnectorId null ` + -ImapHost null ` + -ImapPort null ` + -ImapUsername null ` + -ImapPassword null ` + -ImapSsl null ` + -SelectFolder null ` + -SearchTerms null ` + -Enabled null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ConnectorImapConnectionDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorProjection.md b/docs/ConnectorProjection.md new file mode 100644 index 00000000..bb5ce42e --- /dev/null +++ b/docs/ConnectorProjection.md @@ -0,0 +1,39 @@ +# ConnectorProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | | [optional] +**EmailAddress** | **String** | | [optional] +**InboxId** | **String** | | +**UserId** | **String** | | +**SyncEnabled** | **Boolean** | | [optional] +**SyncScheduleType** | **String** | | +**SyncInterval** | **Int32** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Name** | **String** | | [optional] +**Id** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorProjection = Initialize-maislurp-client-powershellConnectorProjection -Enabled null ` + -EmailAddress null ` + -InboxId null ` + -UserId null ` + -SyncEnabled null ` + -SyncScheduleType null ` + -SyncInterval null ` + -CreatedAt null ` + -Name null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ConnectorProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSmtpConnectionDto.md b/docs/ConnectorSmtpConnectionDto.md new file mode 100644 index 00000000..19b8e728 --- /dev/null +++ b/docs/ConnectorSmtpConnectionDto.md @@ -0,0 +1,37 @@ +# ConnectorSmtpConnectionDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorId** | **String** | | +**SmtpHost** | **String** | | [optional] +**SmtpPort** | **Int32** | | [optional] +**SmtpUsername** | **String** | | [optional] +**SmtpPassword** | **String** | | [optional] +**SmtpSsl** | **Boolean** | | [optional] +**Enabled** | **Boolean** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ConnectorSmtpConnectionDto = Initialize-maislurp-client-powershellConnectorSmtpConnectionDto -ConnectorId null ` + -SmtpHost null ` + -SmtpPort null ` + -SmtpUsername null ` + -SmtpPassword null ` + -SmtpSsl null ` + -Enabled null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSmtpConnectionDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncEventDto.md b/docs/ConnectorSyncEventDto.md new file mode 100644 index 00000000..454c2825 --- /dev/null +++ b/docs/ConnectorSyncEventDto.md @@ -0,0 +1,31 @@ +# ConnectorSyncEventDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**ConnectorId** | **String** | | +**SyncStatus** | **String** | | +**SyncCount** | **Int64** | | +**Message** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncEventDto = Initialize-maislurp-client-powershellConnectorSyncEventDto -Id null ` + -ConnectorId null ` + -SyncStatus null ` + -SyncCount null ` + -Message null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncEventDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncEventProjection.md b/docs/ConnectorSyncEventProjection.md new file mode 100644 index 00000000..54787c13 --- /dev/null +++ b/docs/ConnectorSyncEventProjection.md @@ -0,0 +1,31 @@ +# ConnectorSyncEventProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorId** | **String** | | +**SyncCount** | **Int64** | | +**SyncStatus** | **String** | | +**CreatedAt** | **System.DateTime** | | +**Message** | **String** | | [optional] +**Id** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncEventProjection = Initialize-maislurp-client-powershellConnectorSyncEventProjection -ConnectorId null ` + -SyncCount null ` + -SyncStatus null ` + -CreatedAt null ` + -Message null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncEventProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncRequestResult.md b/docs/ConnectorSyncRequestResult.md new file mode 100644 index 00000000..a284fec0 --- /dev/null +++ b/docs/ConnectorSyncRequestResult.md @@ -0,0 +1,25 @@ +# ConnectorSyncRequestResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SyncResult** | [**ConnectorSyncResult**](ConnectorSyncResult) | | [optional] +**Exception** | [**ConnectorSyncRequestResultException**](ConnectorSyncRequestResultException) | | [optional] +**EventId** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncRequestResult = Initialize-maislurp-client-powershellConnectorSyncRequestResult -SyncResult null ` + -Exception null ` + -EventId null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncRequestResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncRequestResultException.md b/docs/ConnectorSyncRequestResultException.md new file mode 100644 index 00000000..c09b518e --- /dev/null +++ b/docs/ConnectorSyncRequestResultException.md @@ -0,0 +1,29 @@ +# ConnectorSyncRequestResultException +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Cause** | [**ConnectorSyncRequestResultExceptionCause**](ConnectorSyncRequestResultExceptionCause) | | [optional] +**VarStackTrace** | [**ConnectorSyncRequestResultExceptionCauseStackTrace[]**](ConnectorSyncRequestResultExceptionCauseStackTrace) | | [optional] +**Message** | **String** | | [optional] +**Suppressed** | [**ConnectorSyncRequestResultExceptionCause[]**](ConnectorSyncRequestResultExceptionCause) | | [optional] +**LocalizedMessage** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncRequestResultException = Initialize-maislurp-client-powershellConnectorSyncRequestResultException -Cause null ` + -VarStackTrace null ` + -Message null ` + -Suppressed null ` + -LocalizedMessage null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncRequestResultException | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncRequestResultExceptionCause.md b/docs/ConnectorSyncRequestResultExceptionCause.md new file mode 100644 index 00000000..0669fa58 --- /dev/null +++ b/docs/ConnectorSyncRequestResultExceptionCause.md @@ -0,0 +1,25 @@ +# ConnectorSyncRequestResultExceptionCause +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarStackTrace** | [**ConnectorSyncRequestResultExceptionCauseStackTrace[]**](ConnectorSyncRequestResultExceptionCauseStackTrace) | | [optional] +**Message** | **String** | | [optional] +**LocalizedMessage** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncRequestResultExceptionCause = Initialize-maislurp-client-powershellConnectorSyncRequestResultExceptionCause -VarStackTrace null ` + -Message null ` + -LocalizedMessage null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncRequestResultExceptionCause | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncRequestResultExceptionCauseStackTrace.md b/docs/ConnectorSyncRequestResultExceptionCauseStackTrace.md new file mode 100644 index 00000000..d367543a --- /dev/null +++ b/docs/ConnectorSyncRequestResultExceptionCauseStackTrace.md @@ -0,0 +1,35 @@ +# ConnectorSyncRequestResultExceptionCauseStackTrace +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClassLoaderName** | **String** | | [optional] +**ModuleName** | **String** | | [optional] +**ModuleVersion** | **String** | | [optional] +**MethodName** | **String** | | [optional] +**FileName** | **String** | | [optional] +**LineNumber** | **Int32** | | [optional] +**ClassName** | **String** | | [optional] +**NativeMethod** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncRequestResultExceptionCauseStackTrace = Initialize-maislurp-client-powershellConnectorSyncRequestResultExceptionCauseStackTrace -ClassLoaderName null ` + -ModuleName null ` + -ModuleVersion null ` + -MethodName null ` + -FileName null ` + -LineNumber null ` + -ClassName null ` + -NativeMethod null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncRequestResultExceptionCauseStackTrace | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ConnectorSyncResult.md b/docs/ConnectorSyncResult.md new file mode 100644 index 00000000..dc54d842 --- /dev/null +++ b/docs/ConnectorSyncResult.md @@ -0,0 +1,23 @@ +# ConnectorSyncResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailSyncCount** | **Int32** | | +**LogLines** | **String[]** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorSyncResult = Initialize-maislurp-client-powershellConnectorSyncResult -EmailSyncCount null ` + -LogLines null +``` + +- Convert the resource to JSON +```powershell +$ConnectorSyncResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ContactControllerApi.md b/docs/ContactControllerApi.md new file mode 100644 index 00000000..84b70512 --- /dev/null +++ b/docs/ContactControllerApi.md @@ -0,0 +1,312 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.ContactControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Contact**](ContactControllerApi#New-Contact) | **POST** /contacts | Create a contact +[**Invoke-DeleteContact**](ContactControllerApi#Invoke-DeleteContact) | **DELETE** /contacts/{contactId} | Delete contact +[**Get-AllContacts**](ContactControllerApi#Get-AllContacts) | **GET** /contacts/paginated | Get all contacts +[**Get-Contact**](ContactControllerApi#Get-Contact) | **GET** /contacts/{contactId} | Get contact +[**Get-ContactVCard**](ContactControllerApi#Get-ContactVCard) | **GET** /contacts/{contactId}/download | Get contact vCard vcf file +[**Get-Contacts**](ContactControllerApi#Get-Contacts) | **GET** /contacts | Get all contacts + + + +# **New-Contact** +> ContactDto New-Contact
+>         [-CreateContactOptions]
+ +Create a contact + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateContactOptions = (Initialize-CreateContactOptions -FirstName "FirstName_example" -LastName "LastName_example" -Company "Company_example" -EmailAddresses @("EmailAddresses_example") -Tags @("Tags_example") -MetaData "TODO" -OptOut $false -GroupId "GroupId_example" -VerifyEmailAddresses $false) # CreateContactOptions | + +# Create a contact +try { + $Result = New-Contact -CreateContactOptions $CreateContactOptions +} catch { + Write-Host ("Exception occured when calling New-Contact: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateContactOptions** | [**CreateContactOptions**](CreateContactOptions)| | + +### Return type + +[**ContactDto**](ContactDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteContact** +> void Invoke-DeleteContact
+>         [-ContactId]
+ +Delete contact + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ContactId = "ContactId_example" # String | + +# Delete contact +try { + $Result = Invoke-DeleteContact -ContactId $ContactId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteContact: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ContactId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllContacts** +> PageContactProjection Get-AllContacts
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+>         [-Search]
+ +Get all contacts + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$Search = "Search_example" # String | Search terms (optional) + +# Get all contacts +try { + $Result = Get-AllContacts -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before -Search $Search +} catch { + Write-Host ("Exception occured when calling Get-AllContacts: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **Search** | **String**| Search terms | [optional] + +### Return type + +[**PageContactProjection**](PageContactProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Contact** +> ContactDto Get-Contact
+>         [-ContactId]
+ +Get contact + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ContactId = "ContactId_example" # String | + +# Get contact +try { + $Result = Get-Contact -ContactId $ContactId +} catch { + Write-Host ("Exception occured when calling Get-Contact: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ContactId** | [**String**](String)| | + +### Return type + +[**ContactDto**](ContactDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ContactVCard** +> void Get-ContactVCard
+>         [-ContactId]
+ +Get contact vCard vcf file + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ContactId = "ContactId_example" # String | + +# Get contact vCard vcf file +try { + $Result = Get-ContactVCard -ContactId $ContactId +} catch { + Write-Host ("Exception occured when calling Get-ContactVCard: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ContactId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Contacts** +> ContactProjection[] Get-Contacts
+ +Get all contacts + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get all contacts +try { + $Result = Get-Contacts +} catch { + Write-Host ("Exception occured when calling Get-Contacts: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ContactProjection[]**](ContactProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/ContactDto.md b/docs/ContactDto.md new file mode 100644 index 00000000..e2046eb6 --- /dev/null +++ b/docs/ContactDto.md @@ -0,0 +1,41 @@ +# ContactDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**GroupId** | **String** | | [optional] +**FirstName** | **String** | | [optional] +**LastName** | **String** | | [optional] +**Company** | **String** | | [optional] +**EmailAddresses** | **String[]** | | +**PrimaryEmailAddress** | **String** | | [optional] +**Tags** | **String[]** | | +**MetaData** | [**SystemCollectionsHashtable**]() | | [optional] +**OptOut** | **Boolean** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$ContactDto = Initialize-maislurp-client-powershellContactDto -Id null ` + -GroupId null ` + -FirstName null ` + -LastName null ` + -Company null ` + -EmailAddresses null ` + -PrimaryEmailAddress null ` + -Tags null ` + -MetaData null ` + -OptOut null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$ContactDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ContactProjection.md b/docs/ContactProjection.md new file mode 100644 index 00000000..92d4d27a --- /dev/null +++ b/docs/ContactProjection.md @@ -0,0 +1,37 @@ +# ContactProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | | [optional] +**EmailAddresses** | **String[]** | | [optional] +**FirstName** | **String** | | [optional] +**LastName** | **String** | | [optional] +**Company** | **String** | | [optional] +**OptOut** | **Boolean** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | +**GroupId** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ContactProjection = Initialize-maislurp-client-powershellContactProjection -EmailAddress null ` + -EmailAddresses null ` + -FirstName null ` + -LastName null ` + -Company null ` + -OptOut null ` + -CreatedAt null ` + -Id null ` + -GroupId null +``` + +- Convert the resource to JSON +```powershell +$ContactProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ContentMatchOptions.md b/docs/ContentMatchOptions.md new file mode 100644 index 00000000..f4f10599 --- /dev/null +++ b/docs/ContentMatchOptions.md @@ -0,0 +1,21 @@ +# ContentMatchOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pattern** | **String** | Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. | + +## Examples + +- Prepare the resource +```powershell +$ContentMatchOptions = Initialize-maislurp-client-powershellContentMatchOptions -Pattern null +``` + +- Convert the resource to JSON +```powershell +$ContentMatchOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CountDto.md b/docs/CountDto.md new file mode 100644 index 00000000..f6a14951 --- /dev/null +++ b/docs/CountDto.md @@ -0,0 +1,21 @@ +# CountDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalElements** | **Int64** | | + +## Examples + +- Prepare the resource +```powershell +$CountDto = Initialize-maislurp-client-powershellCountDto -TotalElements null +``` + +- Convert the resource to JSON +```powershell +$CountDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateAliasOptions.md b/docs/CreateAliasOptions.md new file mode 100644 index 00000000..5167672c --- /dev/null +++ b/docs/CreateAliasOptions.md @@ -0,0 +1,31 @@ +# CreateAliasOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. | +**InboxId** | **String** | Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address | [optional] +**Name** | **String** | Optional name for alias | [optional] +**UseThreads** | **Boolean** | Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. | +**DomainId** | **String** | Custom domain ID to use when generating alias email addresses | [optional] +**VerifyEmailAddress** | **Boolean** | Whether to verify the masked email address exists before sending an email to it | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateAliasOptions = Initialize-maislurp-client-powershellCreateAliasOptions -EmailAddress null ` + -InboxId null ` + -Name null ` + -UseThreads null ` + -DomainId null ` + -VerifyEmailAddress null +``` + +- Convert the resource to JSON +```powershell +$CreateAliasOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateConnectorImapConnectionOptions.md b/docs/CreateConnectorImapConnectionOptions.md new file mode 100644 index 00000000..c93fed29 --- /dev/null +++ b/docs/CreateConnectorImapConnectionOptions.md @@ -0,0 +1,35 @@ +# CreateConnectorImapConnectionOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ImapSsl** | **Boolean** | | [optional] +**ImapUsername** | **String** | | [optional] +**ImapPassword** | **String** | | [optional] +**SelectFolder** | **String** | Optional folder to select during IMAP connection | [optional] +**SearchTerms** | **String** | | [optional] +**ImapPort** | **Int32** | IMAP server port | [optional] +**ImapHost** | **String** | IMAP server host | +**Enabled** | **Boolean** | IMAP server enabled | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateConnectorImapConnectionOptions = Initialize-maislurp-client-powershellCreateConnectorImapConnectionOptions -ImapSsl null ` + -ImapUsername null ` + -ImapPassword null ` + -SelectFolder null ` + -SearchTerms null ` + -ImapPort null ` + -ImapHost null ` + -Enabled null +``` + +- Convert the resource to JSON +```powershell +$CreateConnectorImapConnectionOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateConnectorOptions.md b/docs/CreateConnectorOptions.md new file mode 100644 index 00000000..e16726d4 --- /dev/null +++ b/docs/CreateConnectorOptions.md @@ -0,0 +1,31 @@ +# CreateConnectorOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SyncEnabled** | **Boolean** | Enable automatic background sync | [optional] +**SyncScheduleType** | **String** | Sync schedule type | [optional] +**SyncInterval** | **Int32** | Sync interval in minutes | [optional] +**Name** | **String** | Name of connector | [optional] +**EmailAddress** | **String** | Email address of external inbox | [optional] +**Enabled** | **Boolean** | Is connector enabled | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateConnectorOptions = Initialize-maislurp-client-powershellCreateConnectorOptions -SyncEnabled null ` + -SyncScheduleType null ` + -SyncInterval null ` + -Name null ` + -EmailAddress null ` + -Enabled null +``` + +- Convert the resource to JSON +```powershell +$CreateConnectorOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateConnectorSmtpConnectionOptions.md b/docs/CreateConnectorSmtpConnectionOptions.md new file mode 100644 index 00000000..6b8789f7 --- /dev/null +++ b/docs/CreateConnectorSmtpConnectionOptions.md @@ -0,0 +1,31 @@ +# CreateConnectorSmtpConnectionOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | | [optional] +**SmtpHost** | **String** | | +**SmtpPort** | **Int32** | | [optional] +**SmtpSsl** | **Boolean** | | [optional] +**SmtpUsername** | **String** | | [optional] +**SmtpPassword** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateConnectorSmtpConnectionOptions = Initialize-maislurp-client-powershellCreateConnectorSmtpConnectionOptions -Enabled null ` + -SmtpHost null ` + -SmtpPort null ` + -SmtpSsl null ` + -SmtpUsername null ` + -SmtpPassword null +``` + +- Convert the resource to JSON +```powershell +$CreateConnectorSmtpConnectionOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateContactOptions.md b/docs/CreateContactOptions.md new file mode 100644 index 00000000..1ebcafa6 --- /dev/null +++ b/docs/CreateContactOptions.md @@ -0,0 +1,37 @@ +# CreateContactOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FirstName** | **String** | | [optional] +**LastName** | **String** | | [optional] +**Company** | **String** | | [optional] +**EmailAddresses** | **String[]** | Set of email addresses belonging to the contact | [optional] +**Tags** | **String[]** | Tags that can be used to search and group contacts | [optional] +**MetaData** | [**SystemCollectionsHashtable**]() | | [optional] +**OptOut** | **Boolean** | Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions. | [optional] +**GroupId** | **String** | Group IDs that contact belongs to | [optional] +**VerifyEmailAddresses** | **Boolean** | Whether to validate contact email address exists | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateContactOptions = Initialize-maislurp-client-powershellCreateContactOptions -FirstName null ` + -LastName null ` + -Company null ` + -EmailAddresses null ` + -Tags null ` + -MetaData null ` + -OptOut null ` + -GroupId null ` + -VerifyEmailAddresses null +``` + +- Convert the resource to JSON +```powershell +$CreateContactOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateDomainOptions.md b/docs/CreateDomainOptions.md new file mode 100644 index 00000000..96d155a4 --- /dev/null +++ b/docs/CreateDomainOptions.md @@ -0,0 +1,27 @@ +# CreateDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | **String** | The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. | +**Description** | **String** | Optional description of the domain. | [optional] +**CreatedCatchAllInbox** | **Boolean** | Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. | [optional] +**DomainType** | **String** | Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateDomainOptions = Initialize-maislurp-client-powershellCreateDomainOptions -Domain null ` + -Description null ` + -CreatedCatchAllInbox null ` + -DomainType null +``` + +- Convert the resource to JSON +```powershell +$CreateDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateEmergencyAddressOptions.md b/docs/CreateEmergencyAddressOptions.md new file mode 100644 index 00000000..1c988058 --- /dev/null +++ b/docs/CreateEmergencyAddressOptions.md @@ -0,0 +1,33 @@ +# CreateEmergencyAddressOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerName** | **String** | | +**Address1** | **String** | | +**City** | **String** | | +**Region** | **String** | | +**PostalCode** | **String** | | +**IsoCountryCode** | **String** | | +**DisplayName** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateEmergencyAddressOptions = Initialize-maislurp-client-powershellCreateEmergencyAddressOptions -CustomerName null ` + -Address1 null ` + -City null ` + -Region null ` + -PostalCode null ` + -IsoCountryCode null ` + -DisplayName null +``` + +- Convert the resource to JSON +```powershell +$CreateEmergencyAddressOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateGroupOptions.md b/docs/CreateGroupOptions.md new file mode 100644 index 00000000..84fb7362 --- /dev/null +++ b/docs/CreateGroupOptions.md @@ -0,0 +1,23 @@ +# CreateGroupOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | +**Description** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateGroupOptions = Initialize-maislurp-client-powershellCreateGroupOptions -Name null ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$CreateGroupOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateInboxDto.md b/docs/CreateInboxDto.md new file mode 100644 index 00000000..9cdc11ff --- /dev/null +++ b/docs/CreateInboxDto.md @@ -0,0 +1,49 @@ +# CreateInboxDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. | [optional] +**DomainName** | **String** | FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. | [optional] +**DomainId** | **String** | ID of custom domain to use for email address. | [optional] +**Name** | **String** | Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. | [optional] +**Description** | **String** | Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with | [optional] +**UseDomainPool** | **Boolean** | Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. | [optional] +**Tags** | **String[]** | Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. | [optional] +**ExpiresAt** | **System.DateTime** | Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. | [optional] +**Favourite** | **Boolean** | Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering | [optional] +**ExpiresIn** | **Int64** | Number of milliseconds that inbox should exist for | [optional] +**AllowTeamAccess** | **Boolean** | DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. | [optional] +**InboxType** | **String** | Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). | [optional] +**VirtualInbox** | **Boolean** | Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. | [optional] +**UseShortAddress** | **Boolean** | Use a shorter email address under 31 characters | [optional] +**Prefix** | **String** | Prefix to add before the email address for easier labelling or identification. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateInboxDto = Initialize-maislurp-client-powershellCreateInboxDto -EmailAddress null ` + -DomainName null ` + -DomainId null ` + -Name null ` + -Description null ` + -UseDomainPool null ` + -Tags null ` + -ExpiresAt null ` + -Favourite null ` + -ExpiresIn null ` + -AllowTeamAccess null ` + -InboxType null ` + -VirtualInbox null ` + -UseShortAddress null ` + -Prefix null +``` + +- Convert the resource to JSON +```powershell +$CreateInboxDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateInboxForwarderOptions.md b/docs/CreateInboxForwarderOptions.md new file mode 100644 index 00000000..0227d84b --- /dev/null +++ b/docs/CreateInboxForwarderOptions.md @@ -0,0 +1,25 @@ +# CreateInboxForwarderOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **String** | Field to match against to trigger inbox forwarding for inbound email | +**Match** | **String** | String or wildcard style match for field specified when evaluating forwarding rules | +**ForwardToRecipients** | **String[]** | Email addresses to forward an email to if it matches the field and match criteria of the forwarder | + +## Examples + +- Prepare the resource +```powershell +$CreateInboxForwarderOptions = Initialize-maislurp-client-powershellCreateInboxForwarderOptions -Field null ` + -Match null ` + -ForwardToRecipients null +``` + +- Convert the resource to JSON +```powershell +$CreateInboxForwarderOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateInboxReplierOptions.md b/docs/CreateInboxReplierOptions.md new file mode 100644 index 00000000..f23977d3 --- /dev/null +++ b/docs/CreateInboxReplierOptions.md @@ -0,0 +1,45 @@ +# CreateInboxReplierOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | Inbox ID to attach replier to | +**Name** | **String** | Name for replier | [optional] +**Field** | **String** | Field to match against to trigger inbox replier for inbound email | +**Match** | **String** | String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything. | +**ReplyTo** | **String** | Reply-to email address when sending replying | [optional] +**Subject** | **String** | Subject override when replying to email | [optional] +**VarFrom** | **String** | Send email from address | [optional] +**Charset** | **String** | Email reply charset | [optional] +**IgnoreReplyTo** | **Boolean** | Ignore sender replyTo when responding. Send directly to the sender if enabled. | [optional] +**IsHTML** | **Boolean** | Send HTML email | [optional] +**Body** | **String** | Email body for reply | [optional] +**TemplateId** | **String** | ID of template to use when sending a reply | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | Template variable values | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateInboxReplierOptions = Initialize-maislurp-client-powershellCreateInboxReplierOptions -InboxId null ` + -Name null ` + -Field null ` + -Match null ` + -ReplyTo null ` + -Subject null ` + -VarFrom null ` + -Charset null ` + -IgnoreReplyTo null ` + -IsHTML null ` + -Body null ` + -TemplateId null ` + -TemplateVariables null +``` + +- Convert the resource to JSON +```powershell +$CreateInboxReplierOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateInboxRulesetOptions.md b/docs/CreateInboxRulesetOptions.md new file mode 100644 index 00000000..e799e9e7 --- /dev/null +++ b/docs/CreateInboxRulesetOptions.md @@ -0,0 +1,25 @@ +# CreateInboxRulesetOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | **String** | What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. | +**Action** | **String** | Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. | +**Target** | **String** | Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. | + +## Examples + +- Prepare the resource +```powershell +$CreateInboxRulesetOptions = Initialize-maislurp-client-powershellCreateInboxRulesetOptions -Scope null ` + -Action null ` + -Target null +``` + +- Convert the resource to JSON +```powershell +$CreateInboxRulesetOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateTemplateOptions.md b/docs/CreateTemplateOptions.md new file mode 100644 index 00000000..9b597e78 --- /dev/null +++ b/docs/CreateTemplateOptions.md @@ -0,0 +1,23 @@ +# CreateTemplateOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of template | +**Content** | **String** | Template content. Can include moustache style variables such as {{var_name}} | + +## Examples + +- Prepare the resource +```powershell +$CreateTemplateOptions = Initialize-maislurp-client-powershellCreateTemplateOptions -Name null ` + -Content null +``` + +- Convert the resource to JSON +```powershell +$CreateTemplateOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateTrackingPixelOptions.md b/docs/CreateTrackingPixelOptions.md new file mode 100644 index 00000000..f1a3d89b --- /dev/null +++ b/docs/CreateTrackingPixelOptions.md @@ -0,0 +1,23 @@ +# CreateTrackingPixelOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | [optional] +**Recipient** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateTrackingPixelOptions = Initialize-maislurp-client-powershellCreateTrackingPixelOptions -Name null ` + -Recipient null +``` + +- Convert the resource to JSON +```powershell +$CreateTrackingPixelOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/CreateWebhookOptions.md b/docs/CreateWebhookOptions.md new file mode 100644 index 00000000..1d65eb57 --- /dev/null +++ b/docs/CreateWebhookOptions.md @@ -0,0 +1,35 @@ +# CreateWebhookOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation. | +**BasicAuth** | [**BasicAuthOptions**](BasicAuthOptions) | | [optional] +**Name** | **String** | Optional name for the webhook | [optional] +**EventName** | **String** | Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. | [optional] +**IncludeHeaders** | [**WebhookHeaders**](WebhookHeaders) | | [optional] +**RequestBodyTemplate** | **String** | Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style `{{variableName}}` templating to use parts of the standard webhook payload for the given event. | [optional] +**UseStaticIpRange** | **Boolean** | Use static IP range when calling webhook endpoint | [optional] [default to $false] +**IgnoreInsecureSslCertificates** | **Boolean** | Ignore insecure SSL certificates when sending request. Useful for self-signed certs. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateWebhookOptions = Initialize-maislurp-client-powershellCreateWebhookOptions -Url null ` + -BasicAuth null ` + -Name null ` + -EventName null ` + -IncludeHeaders null ` + -RequestBodyTemplate null ` + -UseStaticIpRange null ` + -IgnoreInsecureSslCertificates null +``` + +- Convert the resource to JSON +```powershell +$CreateWebhookOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DNSLookupOptions.md b/docs/DNSLookupOptions.md new file mode 100644 index 00000000..275e42c0 --- /dev/null +++ b/docs/DNSLookupOptions.md @@ -0,0 +1,25 @@ +# DNSLookupOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Hostname** | **String** | List of record types you wish to query such as MX, DNS, TXT, NS, A etc. | +**RecordTypes** | **String[]** | List of record types you wish to query such as MX, DNS, TXT, NS, A etc. | +**OmitFinalDNSDot** | **Boolean** | Optionally control whether to omit the final dot in full DNS name values. | + +## Examples + +- Prepare the resource +```powershell +$DNSLookupOptions = Initialize-maislurp-client-powershellDNSLookupOptions -Hostname null ` + -RecordTypes null ` + -OmitFinalDNSDot null +``` + +- Convert the resource to JSON +```powershell +$DNSLookupOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DNSLookupResult.md b/docs/DNSLookupResult.md new file mode 100644 index 00000000..17dc4e2a --- /dev/null +++ b/docs/DNSLookupResult.md @@ -0,0 +1,27 @@ +# DNSLookupResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RecordType** | **String** | Domain Name Server Record Types | +**Ttl** | **Int64** | | +**RecordEntries** | **String[]** | | +**Name** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$DNSLookupResult = Initialize-maislurp-client-powershellDNSLookupResult -RecordType null ` + -Ttl null ` + -RecordEntries null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$DNSLookupResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DNSLookupResults.md b/docs/DNSLookupResults.md new file mode 100644 index 00000000..23e11925 --- /dev/null +++ b/docs/DNSLookupResults.md @@ -0,0 +1,21 @@ +# DNSLookupResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**DNSLookupResult[]**](DNSLookupResult) | | + +## Examples + +- Prepare the resource +```powershell +$DNSLookupResults = Initialize-maislurp-client-powershellDNSLookupResults -Results null +``` + +- Convert the resource to JSON +```powershell +$DNSLookupResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DNSLookupsOptions.md b/docs/DNSLookupsOptions.md new file mode 100644 index 00000000..db6703c8 --- /dev/null +++ b/docs/DNSLookupsOptions.md @@ -0,0 +1,21 @@ +# DNSLookupsOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lookups** | [**DNSLookupOptions[]**](DNSLookupOptions) | | + +## Examples + +- Prepare the resource +```powershell +$DNSLookupsOptions = Initialize-maislurp-client-powershellDNSLookupsOptions -Lookups null +``` + +- Convert the resource to JSON +```powershell +$DNSLookupsOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DeliveryStatusDto.md b/docs/DeliveryStatusDto.md new file mode 100644 index 00000000..33ce7933 --- /dev/null +++ b/docs/DeliveryStatusDto.md @@ -0,0 +1,47 @@ +# DeliveryStatusDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**SentId** | **String** | | [optional] +**RemoteMtaIp** | **String** | | [optional] +**InboxId** | **String** | | [optional] +**ReportingMta** | **String** | | [optional] +**Recipients** | **String[]** | | [optional] +**SmtpResponse** | **String** | | [optional] +**SmtpStatusCode** | **Int32** | | [optional] +**ProcessingTimeMillis** | **Int64** | | [optional] +**Received** | **System.DateTime** | | [optional] +**Subject** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$DeliveryStatusDto = Initialize-maislurp-client-powershellDeliveryStatusDto -Id null ` + -UserId null ` + -SentId null ` + -RemoteMtaIp null ` + -InboxId null ` + -ReportingMta null ` + -Recipients null ` + -SmtpResponse null ` + -SmtpStatusCode null ` + -ProcessingTimeMillis null ` + -Received null ` + -Subject null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$DeliveryStatusDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DescribeDomainOptions.md b/docs/DescribeDomainOptions.md new file mode 100644 index 00000000..286166f0 --- /dev/null +++ b/docs/DescribeDomainOptions.md @@ -0,0 +1,21 @@ +# DescribeDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$DescribeDomainOptions = Initialize-maislurp-client-powershellDescribeDomainOptions -Domain null +``` + +- Convert the resource to JSON +```powershell +$DescribeDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DescribeMailServerDomainResult.md b/docs/DescribeMailServerDomainResult.md new file mode 100644 index 00000000..81feb0f3 --- /dev/null +++ b/docs/DescribeMailServerDomainResult.md @@ -0,0 +1,25 @@ +# DescribeMailServerDomainResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MxRecords** | [**NameServerRecord[]**](NameServerRecord) | | +**Domain** | **String** | | +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DescribeMailServerDomainResult = Initialize-maislurp-client-powershellDescribeMailServerDomainResult -MxRecords null ` + -Domain null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$DescribeMailServerDomainResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainControllerApi.md b/docs/DomainControllerApi.md new file mode 100644 index 00000000..431075db --- /dev/null +++ b/docs/DomainControllerApi.md @@ -0,0 +1,514 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.DomainControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Add-DomainWildcardCatchAll**](DomainControllerApi#Add-DomainWildcardCatchAll) | **POST** /domains/{id}/wildcard | Add catch all wild card inbox to domain +[**New-Domain**](DomainControllerApi#New-Domain) | **POST** /domains | Create Domain +[**Invoke-DeleteDomain**](DomainControllerApi#Invoke-DeleteDomain) | **DELETE** /domains/{id} | Delete a domain +[**Get-AvailableDomains**](DomainControllerApi#Get-AvailableDomains) | **GET** /domains/available-domains | Get all usable domains +[**Get-Domain**](DomainControllerApi#Get-Domain) | **GET** /domains/{id} | Get a domain +[**Get-DomainIssues**](DomainControllerApi#Get-DomainIssues) | **GET** /domains/issues | Get domain issues +[**Get-DomainWildcardCatchAllInbox**](DomainControllerApi#Get-DomainWildcardCatchAllInbox) | **GET** /domains/{id}/wildcard | Get catch all wild card inbox for domain +[**Get-Domains**](DomainControllerApi#Get-Domains) | **GET** /domains | Get domains +[**Get-MailSlurpDomains**](DomainControllerApi#Get-MailSlurpDomains) | **GET** /domains/mailslurp-domains | Get MailSlurp domains +[**Update-Domain**](DomainControllerApi#Update-Domain) | **PUT** /domains/{id} | Update a domain + + + +# **Add-DomainWildcardCatchAll** +> DomainDto Add-DomainWildcardCatchAll
+>         [-Id]
+ +Add catch all wild card inbox to domain + +Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Add catch all wild card inbox to domain +try { + $Result = Add-DomainWildcardCatchAll -Id $Id +} catch { + Write-Host ("Exception occured when calling Add-DomainWildcardCatchAll: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**DomainDto**](DomainDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-Domain** +> DomainDto New-Domain
+>         [-CreateDomainOptions]
+ +Create Domain + +Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateDomainOptions = (Initialize-CreateDomainOptions -Domain "Domain_example" -Description "Description_example" -CreatedCatchAllInbox $false -DomainType "HTTP_INBOX") # CreateDomainOptions | + +# Create Domain +try { + $Result = New-Domain -CreateDomainOptions $CreateDomainOptions +} catch { + Write-Host ("Exception occured when calling New-Domain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateDomainOptions** | [**CreateDomainOptions**](CreateDomainOptions)| | + +### Return type + +[**DomainDto**](DomainDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteDomain** +> String[] Invoke-DeleteDomain
+>         [-Id]
+ +Delete a domain + +Delete a domain. This will disable any existing inboxes that use this domain. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Delete a domain +try { + $Result = Invoke-DeleteDomain -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +**String[]** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AvailableDomains** +> DomainGroupsDto Get-AvailableDomains
+>         [-InboxType]
+ +Get all usable domains + +List all domains available for use with email address creation + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxType = "HTTP_INBOX" # String | (optional) + +# Get all usable domains +try { + $Result = Get-AvailableDomains -InboxType $InboxType +} catch { + Write-Host ("Exception occured when calling Get-AvailableDomains: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxType** | **String**| | [optional] + +### Return type + +[**DomainGroupsDto**](DomainGroupsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Domain** +> DomainDto Get-Domain
+>         [-Id]
+>         [-CheckForErrors]
+ +Get a domain + +Returns domain verification status and tokens for a given domain + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$CheckForErrors = true # Boolean | (optional) + +# Get a domain +try { + $Result = Get-Domain -Id $Id -CheckForErrors $CheckForErrors +} catch { + Write-Host ("Exception occured when calling Get-Domain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **CheckForErrors** | **Boolean**| | [optional] + +### Return type + +[**DomainDto**](DomainDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-DomainIssues** +> DomainIssuesDto Get-DomainIssues
+ +Get domain issues + +List domain issues for domains you have created + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get domain issues +try { + $Result = Get-DomainIssues +} catch { + Write-Host ("Exception occured when calling Get-DomainIssues: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**DomainIssuesDto**](DomainIssuesDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-DomainWildcardCatchAllInbox** +> InboxDto Get-DomainWildcardCatchAllInbox
+>         [-Id]
+ +Get catch all wild card inbox for domain + +Get the catch all inbox for a domain for missed emails + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get catch all wild card inbox for domain +try { + $Result = Get-DomainWildcardCatchAllInbox -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-DomainWildcardCatchAllInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Domains** +> DomainPreview[] Get-Domains
+ +Get domains + +List all custom domains you have created + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get domains +try { + $Result = Get-Domains +} catch { + Write-Host ("Exception occured when calling Get-Domains: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**DomainPreview[]**](DomainPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-MailSlurpDomains** +> DomainGroupsDto Get-MailSlurpDomains
+>         [-InboxType]
+ +Get MailSlurp domains + +List all MailSlurp domains used with non-custom email addresses + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxType = "HTTP_INBOX" # String | (optional) + +# Get MailSlurp domains +try { + $Result = Get-MailSlurpDomains -InboxType $InboxType +} catch { + Write-Host ("Exception occured when calling Get-MailSlurpDomains: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxType** | **String**| | [optional] + +### Return type + +[**DomainGroupsDto**](DomainGroupsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-Domain** +> DomainDto Update-Domain
+>         [-Id]
+>         [-UpdateDomainOptions]
+ +Update a domain + +Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$UpdateDomainOptions = (Initialize-UpdateDomainOptions -CatchAllInboxId "CatchAllInboxId_example") # UpdateDomainOptions | + +# Update a domain +try { + $Result = Update-Domain -Id $Id -UpdateDomainOptions $UpdateDomainOptions +} catch { + Write-Host ("Exception occured when calling Update-Domain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **UpdateDomainOptions** | [**UpdateDomainOptions**](UpdateDomainOptions)| | + +### Return type + +[**DomainDto**](DomainDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/DomainDto.md b/docs/DomainDto.md new file mode 100644 index 00000000..336c468a --- /dev/null +++ b/docs/DomainDto.md @@ -0,0 +1,45 @@ +# DomainDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**Domain** | **String** | Custom domain name | +**VerificationToken** | **String** | Verification tokens | +**DkimTokens** | **String[]** | Unique token DKIM tokens | +**MissingRecordsMessage** | **String** | If the domain is missing records then show which pairs are missing. | [optional] +**HasMissingRecords** | **Boolean** | Whether the domain has missing required records. If true then see the domain in the dashboard app. | +**IsVerified** | **Boolean** | Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records. | +**DomainNameRecords** | [**DomainNameRecord[]**](DomainNameRecord) | List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider. | +**CatchAllInboxId** | **String** | The optional catch all inbox that will receive emails sent to the domain that cannot be matched. | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | +**DomainType** | **String** | Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. | + +## Examples + +- Prepare the resource +```powershell +$DomainDto = Initialize-maislurp-client-powershellDomainDto -Id null ` + -UserId null ` + -Domain null ` + -VerificationToken null ` + -DkimTokens null ` + -MissingRecordsMessage null ` + -HasMissingRecords null ` + -IsVerified null ` + -DomainNameRecords null ` + -CatchAllInboxId null ` + -CreatedAt null ` + -UpdatedAt null ` + -DomainType null +``` + +- Convert the resource to JSON +```powershell +$DomainDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainGroup.md b/docs/DomainGroup.md new file mode 100644 index 00000000..a535b5a9 --- /dev/null +++ b/docs/DomainGroup.md @@ -0,0 +1,23 @@ +# DomainGroup +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | **String** | | +**Domains** | [**DomainInformation[]**](DomainInformation) | | + +## Examples + +- Prepare the resource +```powershell +$DomainGroup = Initialize-maislurp-client-powershellDomainGroup -Label null ` + -Domains null +``` + +- Convert the resource to JSON +```powershell +$DomainGroup | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainGroupsDto.md b/docs/DomainGroupsDto.md new file mode 100644 index 00000000..3a617fad --- /dev/null +++ b/docs/DomainGroupsDto.md @@ -0,0 +1,21 @@ +# DomainGroupsDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DomainGroups** | [**DomainGroup[]**](DomainGroup) | | + +## Examples + +- Prepare the resource +```powershell +$DomainGroupsDto = Initialize-maislurp-client-powershellDomainGroupsDto -DomainGroups null +``` + +- Convert the resource to JSON +```powershell +$DomainGroupsDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainInformation.md b/docs/DomainInformation.md new file mode 100644 index 00000000..e87f7960 --- /dev/null +++ b/docs/DomainInformation.md @@ -0,0 +1,25 @@ +# DomainInformation +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DomainName** | **String** | | +**Verified** | **Boolean** | | +**DomainType** | **String** | Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. | + +## Examples + +- Prepare the resource +```powershell +$DomainInformation = Initialize-maislurp-client-powershellDomainInformation -DomainName null ` + -Verified null ` + -DomainType null +``` + +- Convert the resource to JSON +```powershell +$DomainInformation | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainIssuesDto.md b/docs/DomainIssuesDto.md new file mode 100644 index 00000000..8b8b6750 --- /dev/null +++ b/docs/DomainIssuesDto.md @@ -0,0 +1,21 @@ +# DomainIssuesDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasIssues** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$DomainIssuesDto = Initialize-maislurp-client-powershellDomainIssuesDto -HasIssues null +``` + +- Convert the resource to JSON +```powershell +$DomainIssuesDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainNameRecord.md b/docs/DomainNameRecord.md new file mode 100644 index 00000000..d9c940d9 --- /dev/null +++ b/docs/DomainNameRecord.md @@ -0,0 +1,31 @@ +# DomainNameRecord +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | **String** | Domain Name Server Record Label | +**Required** | **Boolean** | | +**RecordType** | **String** | Domain Name Server Record Types | +**Name** | **String** | | +**RecordEntries** | **String[]** | | +**Ttl** | **Int64** | | + +## Examples + +- Prepare the resource +```powershell +$DomainNameRecord = Initialize-maislurp-client-powershellDomainNameRecord -Label null ` + -Required null ` + -RecordType null ` + -Name null ` + -RecordEntries null ` + -Ttl null +``` + +- Convert the resource to JSON +```powershell +$DomainNameRecord | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DomainPreview.md b/docs/DomainPreview.md new file mode 100644 index 00000000..61b76372 --- /dev/null +++ b/docs/DomainPreview.md @@ -0,0 +1,33 @@ +# DomainPreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**Domain** | **String** | | +**CatchAllInboxId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**DomainType** | **String** | Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. | +**IsVerified** | **Boolean** | | +**HasMissingRecords** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$DomainPreview = Initialize-maislurp-client-powershellDomainPreview -Id null ` + -Domain null ` + -CatchAllInboxId null ` + -CreatedAt null ` + -DomainType null ` + -IsVerified null ` + -HasMissingRecords null +``` + +- Convert the resource to JSON +```powershell +$DomainPreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/DownloadAttachmentDto.md b/docs/DownloadAttachmentDto.md new file mode 100644 index 00000000..14ea3473 --- /dev/null +++ b/docs/DownloadAttachmentDto.md @@ -0,0 +1,25 @@ +# DownloadAttachmentDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Base64FileContents** | **String** | Base64 encoded string of attachment bytes. Decode the base64 encoded string to get the raw contents. If the file has a content type such as `text/html` you can read the contents directly by converting it to string using `utf-8` encoding. | +**ContentType** | **String** | Content type of attachment. Examples are `image/png`, `application/msword`, `text/csv` etc. | +**SizeBytes** | **Int64** | Size in bytes of attachment content | + +## Examples + +- Prepare the resource +```powershell +$DownloadAttachmentDto = Initialize-maislurp-client-powershellDownloadAttachmentDto -Base64FileContents null ` + -ContentType null ` + -SizeBytes null +``` + +- Convert the resource to JSON +```powershell +$DownloadAttachmentDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/Email.md b/docs/Email.md new file mode 100644 index 00000000..94f6fc3d --- /dev/null +++ b/docs/Email.md @@ -0,0 +1,79 @@ +# Email +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the email entity | +**UserId** | **String** | ID of user that email belongs to | +**InboxId** | **String** | ID of the inbox that received the email | +**DomainId** | **String** | ID of the domain that received the email | [optional] +**To** | **String[]** | List of `To` recipient email addresses that the email was addressed to. See recipients object for names. | +**VarFrom** | **String** | Who the email was sent from. An email address - see fromName for the sender name. | [optional] +**VarSender** | [**ModelSender**](ModelSender) | | [optional] +**Recipients** | [**EmailRecipients**](EmailRecipients) | | [optional] +**ReplyTo** | **String** | The `replyTo` field on the received email message | [optional] +**Cc** | **String[]** | List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. | [optional] +**Bcc** | **String[]** | List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. | [optional] +**Headers** | **System.Collections.Hashtable** | Collection of SMTP headers attached to email | [optional] +**HeadersMap** | [**System.Collections.Hashtable**](Array) | Multi-value map of SMTP headers attached to email | [optional] +**Attachments** | **String[]** | List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension. | [optional] +**Subject** | **String** | The subject line of the email message as specified by SMTP subject header | [optional] +**Body** | **String** | The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests. | [optional] +**BodyExcerpt** | **String** | An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not | [optional] +**TextExcerpt** | **String** | An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists | [optional] +**BodyMD5Hash** | **String** | A hash signature of the email message using MD5. Useful for comparing emails without fetching full body. | [optional] +**IsHTML** | **Boolean** | Is the email body content type HTML? | [optional] +**Charset** | **String** | Detected character set of the email body such as UTF-8 | [optional] +**Analysis** | [**EmailAnalysis**](EmailAnalysis) | | [optional] +**CreatedAt** | **System.DateTime** | When was the email received by MailSlurp | +**UpdatedAt** | **System.DateTime** | When was the email last updated | +**Read** | **Boolean** | Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks. | +**TeamAccess** | **Boolean** | Can the email be accessed by organization team members | +**IsXAmpHtml** | **Boolean** | Is the email body content type x-amp-html Amp4Email? | [optional] +**BodyPartContentTypes** | **String[]** | A list of detected multipart mime message body part content types such as text/plain and text/html. Can be used with email bodyPart endpoints to fetch individual body parts. | [optional] +**Html** | **Boolean** | | [optional] +**XampHtml** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Email = Initialize-maislurp-client-powershellEmail -Id null ` + -UserId null ` + -InboxId null ` + -DomainId null ` + -To null ` + -VarFrom null ` + -VarSender null ` + -Recipients null ` + -ReplyTo null ` + -Cc null ` + -Bcc null ` + -Headers null ` + -HeadersMap null ` + -Attachments null ` + -Subject null ` + -Body null ` + -BodyExcerpt null ` + -TextExcerpt null ` + -BodyMD5Hash null ` + -IsHTML null ` + -Charset null ` + -Analysis null ` + -CreatedAt null ` + -UpdatedAt null ` + -Read null ` + -TeamAccess null ` + -IsXAmpHtml null ` + -BodyPartContentTypes null ` + -Html null ` + -XampHtml null +``` + +- Convert the resource to JSON +```powershell +$Email | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailAnalysis.md b/docs/EmailAnalysis.md new file mode 100644 index 00000000..1b31582a --- /dev/null +++ b/docs/EmailAnalysis.md @@ -0,0 +1,29 @@ +# EmailAnalysis +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SpamVerdict** | **String** | Verdict of spam ranking analysis | [optional] +**VirusVerdict** | **String** | Verdict of virus scan analysis | [optional] +**SpfVerdict** | **String** | Verdict of Send Policy Framework record spoofing analysis | [optional] +**DkimVerdict** | **String** | Verdict of DomainKeys Identified Mail analysis | [optional] +**DmarcVerdict** | **String** | Verdict of Domain-based Message Authentication Reporting and Conformance analysis | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailAnalysis = Initialize-maislurp-client-powershellEmailAnalysis -SpamVerdict null ` + -VirusVerdict null ` + -SpfVerdict null ` + -DkimVerdict null ` + -DmarcVerdict null +``` + +- Convert the resource to JSON +```powershell +$EmailAnalysis | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailContentMatchResult.md b/docs/EmailContentMatchResult.md new file mode 100644 index 00000000..4f4d9d91 --- /dev/null +++ b/docs/EmailContentMatchResult.md @@ -0,0 +1,23 @@ +# EmailContentMatchResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pattern** | **String** | | +**VarMatches** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$EmailContentMatchResult = Initialize-maislurp-client-powershellEmailContentMatchResult -Pattern null ` + -VarMatches null +``` + +- Convert the resource to JSON +```powershell +$EmailContentMatchResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailContentPartResult.md b/docs/EmailContentPartResult.md new file mode 100644 index 00000000..584d3af8 --- /dev/null +++ b/docs/EmailContentPartResult.md @@ -0,0 +1,21 @@ +# EmailContentPartResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailContentPartResult = Initialize-maislurp-client-powershellEmailContentPartResult -Content null +``` + +- Convert the resource to JSON +```powershell +$EmailContentPartResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailControllerApi.md b/docs/EmailControllerApi.md new file mode 100644 index 00000000..aa8d1c0f --- /dev/null +++ b/docs/EmailControllerApi.md @@ -0,0 +1,2232 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.EmailControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-ApplyImapFlagOperation**](EmailControllerApi#Invoke-ApplyImapFlagOperation) | **POST** /emails/{emailId}/imap-flag-operation | Set IMAP flags associated with a message. Only supports '\Seen' flag. +[**Invoke-CanSend**](EmailControllerApi#Invoke-CanSend) | **POST** /emails/can-send | Check if email can be sent and options are valid. +[**Invoke-CheckEmailBody**](EmailControllerApi#Invoke-CheckEmailBody) | **POST** /emails/{emailId}/check-email-body | Detect broken links, spelling, and images in email content +[**Invoke-CheckEmailBodyFeatureSupport**](EmailControllerApi#Invoke-CheckEmailBodyFeatureSupport) | **POST** /emails/{emailId}/check-email-body-feature-support | Show which mail clients support the HTML and CSS features used in an email body. +[**Invoke-CheckEmailClientSupport**](EmailControllerApi#Invoke-CheckEmailClientSupport) | **POST** /emails/check-email-client-support | Show which email programs and devices support the features used in an email body. +[**Invoke-DeleteAllEmails**](EmailControllerApi#Invoke-DeleteAllEmails) | **DELETE** /emails | Delete all emails in all inboxes. +[**Invoke-DeleteEmail**](EmailControllerApi#Invoke-DeleteEmail) | **DELETE** /emails/{emailId} | Delete an email +[**Invoke-DownloadAttachment**](EmailControllerApi#Invoke-DownloadAttachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. +[**Invoke-DownloadAttachmentBase64**](EmailControllerApi#Invoke-DownloadAttachmentBase64) | **GET** /emails/{emailId}/attachments/{attachmentId}/base64 | Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. +[**Invoke-DownloadBody**](EmailControllerApi#Invoke-DownloadBody) | **GET** /emails/{emailId}/body | Get email body as string. Returned as `plain/text` with content type header. +[**Invoke-DownloadBodyBytes**](EmailControllerApi#Invoke-DownloadBodyBytes) | **GET** /emails/{emailId}/body-bytes | Get email body in bytes. Returned as `octet-stream` with content type header. +[**Invoke-ForwardEmail**](EmailControllerApi#Invoke-ForwardEmail) | **POST** /emails/{emailId}/forward | Forward email to recipients +[**Get-AttachmentMetaData**](EmailControllerApi#Get-AttachmentMetaData) | **GET** /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. +[**Get-Email**](EmailControllerApi#Get-Email) | **GET** /emails/{emailId} | Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. +[**Get-EmailAttachments**](EmailControllerApi#Get-EmailAttachments) | **GET** /emails/{emailId}/attachments | Get all email attachment metadata. Metadata includes name and size of attachments. +[**Get-EmailContentMatch**](EmailControllerApi#Get-EmailContentMatch) | **POST** /emails/{emailId}/contentMatch | Get email content regex pattern match results. Runs regex against email body and returns match groups. +[**Get-EmailContentPart**](EmailControllerApi#Get-EmailContentPart) | **GET** /emails/{emailId}/contentPart | Get email content part by content type +[**Get-EmailCount**](EmailControllerApi#Get-EmailCount) | **GET** /emails/emails/count | Get email count +[**Get-EmailHTML**](EmailControllerApi#Get-EmailHTML) | **GET** /emails/{emailId}/html | Get email content as HTML. For displaying emails in browser context. +[**Get-EmailHTMLJson**](EmailControllerApi#Get-EmailHTMLJson) | **GET** /emails/{emailId}/html/json | Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content +[**Get-EmailHTMLQuery**](EmailControllerApi#Get-EmailHTMLQuery) | **GET** /emails/{emailId}/htmlQuery | Parse and return text from an email, stripping HTML and decoding encoded characters +[**Get-EmailLinks**](EmailControllerApi#Get-EmailLinks) | **GET** /emails/{emailId}/links | Parse and return list of links found in an email (only works for HTML content) +[**Get-EmailPreviewURLs**](EmailControllerApi#Get-EmailPreviewURLs) | **GET** /emails/{emailId}/urls | Get email URLs for viewing in browser or downloading +[**Get-EmailScreenshotAsBase64**](EmailControllerApi#Get-EmailScreenshotAsBase64) | **POST** /emails/{emailId}/screenshot/base64 | Take a screenshot of an email in a browser and return base64 encoded string +[**Get-EmailScreenshotAsBinary**](EmailControllerApi#Get-EmailScreenshotAsBinary) | **POST** /emails/{emailId}/screenshot/binary | Take a screenshot of an email in a browser +[**Get-EmailTextLines**](EmailControllerApi#Get-EmailTextLines) | **GET** /emails/{emailId}/textLines | Parse and return text from an email, stripping HTML and decoding encoded characters +[**Get-EmailsOffsetPaginated**](EmailControllerApi#Get-EmailsOffsetPaginated) | **GET** /emails/offset-paginated | Get all emails in all inboxes in paginated form. Email API list all. +[**Get-EmailsPaginated**](EmailControllerApi#Get-EmailsPaginated) | **GET** /emails | Get all emails in all inboxes in paginated form. Email API list all. +[**Get-GravatarUrlForEmailAddress**](EmailControllerApi#Get-GravatarUrlForEmailAddress) | **GET** /emails/gravatarFor | +[**Get-LatestEmail**](EmailControllerApi#Get-LatestEmail) | **GET** /emails/latest | Get latest email in all inboxes. Most recently received. +[**Get-LatestEmailInInbox1**](EmailControllerApi#Get-LatestEmailInInbox1) | **GET** /emails/latestIn | Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. +[**Get-OrganizationEmailsPaginated**](EmailControllerApi#Get-OrganizationEmailsPaginated) | **GET** /emails/organization | Get all organization emails. List team or shared test email accounts +[**Get-RawEmailContents**](EmailControllerApi#Get-RawEmailContents) | **GET** /emails/{emailId}/raw | Get raw email string. Returns unparsed raw SMTP message with headers and body. +[**Get-RawEmailJson**](EmailControllerApi#Get-RawEmailJson) | **GET** /emails/{emailId}/raw/json | Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. +[**Get-UnreadEmailCount**](EmailControllerApi#Get-UnreadEmailCount) | **GET** /emails/unreadCount | Get unread email count +[**Invoke-MarkAllAsRead**](EmailControllerApi#Invoke-MarkAllAsRead) | **PATCH** /emails/read | Mark all emails as read or unread +[**Invoke-MarkAsRead**](EmailControllerApi#Invoke-MarkAsRead) | **PATCH** /emails/{emailId}/read | Mark an email as read or unread +[**Invoke-ReplyToEmail**](EmailControllerApi#Invoke-ReplyToEmail) | **PUT** /emails/{emailId} | Reply to an email +[**Search-Emails**](EmailControllerApi#Search-Emails) | **POST** /emails/search | Get all emails by search criteria. Return in paginated form. +[**Send-EmailSourceOptional**](EmailControllerApi#Send-EmailSourceOptional) | **POST** /emails | Send email +[**Confirm-Email**](EmailControllerApi#Confirm-Email) | **POST** /emails/{emailId}/validate | Validate email HTML contents + + + +# **Invoke-ApplyImapFlagOperation** +> EmailPreview Invoke-ApplyImapFlagOperation
+>         [-EmailId]
+>         [-ImapFlagOperationOptions]
+ +Set IMAP flags associated with a message. Only supports '\Seen' flag. + +Apply RFC3501 section-2.3.2 IMAP flag operations on an email + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$ImapFlagOperationOptions = (Initialize-ImapFlagOperationOptions -FlagOperation "SET_FLAGS" -Flags @("Flags_example")) # ImapFlagOperationOptions | + +# Set IMAP flags associated with a message. Only supports '\Seen' flag. +try { + $Result = Invoke-ApplyImapFlagOperation -EmailId $EmailId -ImapFlagOperationOptions $ImapFlagOperationOptions +} catch { + Write-Host ("Exception occured when calling Invoke-ApplyImapFlagOperation: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **ImapFlagOperationOptions** | [**ImapFlagOperationOptions**](ImapFlagOperationOptions)| | + +### Return type + +[**EmailPreview**](EmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-CanSend** +> CanSendEmailResults Invoke-CanSend
+>         [-InboxId]
+>         [-SendEmailOptions]
+ +Check if email can be sent and options are valid. + +Can user send email to given recipient or is the recipient blocked + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from +$SendEmailOptions = (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID" -IgnoreEmptyRecipients $false -IsXAmpHtml $false -BodyParts @((Initialize-SendEmailBodyPart -ContentType "ContentType_example" -ContentBody "ContentBody_example"))) # SendEmailOptions | + +# Check if email can be sent and options are valid. +try { + $Result = Invoke-CanSend -InboxId $InboxId -SendEmailOptions $SendEmailOptions +} catch { + Write-Host ("Exception occured when calling Invoke-CanSend: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + +### Return type + +[**CanSendEmailResults**](CanSendEmailResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-CheckEmailBody** +> CheckEmailBodyResults Invoke-CheckEmailBody
+>         [-EmailId]
+ +Detect broken links, spelling, and images in email content + +Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | + +# Detect broken links, spelling, and images in email content +try { + $Result = Invoke-CheckEmailBody -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Invoke-CheckEmailBody: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + +### Return type + +[**CheckEmailBodyResults**](CheckEmailBodyResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-CheckEmailBodyFeatureSupport** +> CheckEmailBodyFeatureSupportResults Invoke-CheckEmailBodyFeatureSupport
+>         [-EmailId]
+ +Show which mail clients support the HTML and CSS features used in an email body. + +Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | + +# Show which mail clients support the HTML and CSS features used in an email body. +try { + $Result = Invoke-CheckEmailBodyFeatureSupport -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Invoke-CheckEmailBodyFeatureSupport: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + +### Return type + +[**CheckEmailBodyFeatureSupportResults**](CheckEmailBodyFeatureSupportResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-CheckEmailClientSupport** +> CheckEmailClientSupportResults Invoke-CheckEmailClientSupport
+>         [-CheckEmailClientSupportOptions]
+ +Show which email programs and devices support the features used in an email body. + +Evaluate the features used in an email body and return a report of email client support across different platforms and versions. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CheckEmailClientSupportOptions = (Initialize-CheckEmailClientSupportOptions -EmailBody "EmailBody_example") # CheckEmailClientSupportOptions | + +# Show which email programs and devices support the features used in an email body. +try { + $Result = Invoke-CheckEmailClientSupport -CheckEmailClientSupportOptions $CheckEmailClientSupportOptions +} catch { + Write-Host ("Exception occured when calling Invoke-CheckEmailClientSupport: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CheckEmailClientSupportOptions** | [**CheckEmailClientSupportOptions**](CheckEmailClientSupportOptions)| | + +### Return type + +[**CheckEmailClientSupportResults**](CheckEmailClientSupportResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllEmails** +> void Invoke-DeleteAllEmails
+ +Delete all emails in all inboxes. + +Deletes all emails in your account. Be careful as emails cannot be recovered + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Delete all emails in all inboxes. +try { + $Result = Invoke-DeleteAllEmails +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteEmail** +> void Invoke-DeleteEmail
+>         [-EmailId]
+ +Delete an email + +Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email to delete + +# Delete an email +try { + $Result = Invoke-DeleteEmail -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email to delete | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DownloadAttachment** +> SystemByte Invoke-DownloadAttachment
+>         [-EmailId]
+>         [-AttachmentId]
+>         [-ApiKey]
+ +Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. + +Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email +$AttachmentId = "AttachmentId_example" # String | ID of attachment +$ApiKey = "ApiKey_example" # String | Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional) + +# Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. +try { + $Result = Invoke-DownloadAttachment -EmailId $EmailId -AttachmentId $AttachmentId -ApiKey $ApiKey +} catch { + Write-Host ("Exception occured when calling Invoke-DownloadAttachment: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + **AttachmentId** | **String**| ID of attachment | + **ApiKey** | **String**| Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. | [optional] + +### Return type + +[**SystemByte**](SystemByte) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DownloadAttachmentBase64** +> DownloadAttachmentDto Invoke-DownloadAttachmentBase64
+>         [-EmailId]
+>         [-AttachmentId]
+ +Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. + +Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. +try { + $Result = Invoke-DownloadAttachmentBase64 -EmailId $EmailId -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Invoke-DownloadAttachmentBase64: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + **AttachmentId** | **String**| ID of attachment | + +### Return type + +[**DownloadAttachmentDto**](DownloadAttachmentDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DownloadBody** +> String Invoke-DownloadBody
+>         [-EmailId]
+ +Get email body as string. Returned as `plain/text` with content type header. + +Returns the specified email body for a given email as a string + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get email body as string. Returned as `plain/text` with content type header. +try { + $Result = Invoke-DownloadBody -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Invoke-DownloadBody: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, text/html + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DownloadBodyBytes** +> SystemByte Invoke-DownloadBodyBytes
+>         [-EmailId]
+ +Get email body in bytes. Returned as `octet-stream` with content type header. + +Returns the specified email body for a given email as a stream / array of bytes. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get email body in bytes. Returned as `octet-stream` with content type header. +try { + $Result = Invoke-DownloadBodyBytes -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Invoke-DownloadBodyBytes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +[**SystemByte**](SystemByte) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ForwardEmail** +> SentEmailDto Invoke-ForwardEmail
+>         [-EmailId]
+>         [-ForwardEmailOptions]
+ +Forward email to recipients + +Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email +$ForwardEmailOptions = (Initialize-ForwardEmailOptions -To @("To_example") -Subject "Subject_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -VarFrom "VarFrom_example" -UseInboxName $false -FilterBouncedRecipients $false) # ForwardEmailOptions | + +# Forward email to recipients +try { + $Result = Invoke-ForwardEmail -EmailId $EmailId -ForwardEmailOptions $ForwardEmailOptions +} catch { + Write-Host ("Exception occured when calling Invoke-ForwardEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + **ForwardEmailOptions** | [**ForwardEmailOptions**](ForwardEmailOptions)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AttachmentMetaData** +> AttachmentMetaData Get-AttachmentMetaData
+>         [-EmailId]
+>         [-AttachmentId]
+ +Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. + +Returns the metadata such as name and content-type for a given attachment and email. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email +$AttachmentId = "AttachmentId_example" # String | ID of attachment + +# Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. +try { + $Result = Get-AttachmentMetaData -EmailId $EmailId -AttachmentId $AttachmentId +} catch { + Write-Host ("Exception occured when calling Get-AttachmentMetaData: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + **AttachmentId** | **String**| ID of attachment | + +### Return type + +[**AttachmentMetaData**](AttachmentMetaData) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Email** +> Email Get-Email
+>         [-EmailId]
+>         [-Decode]
+ +Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. + +Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$Decode = true # Boolean | Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional) (default to $false) + +# Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. +try { + $Result = Get-Email -EmailId $EmailId -Decode $Decode +} catch { + Write-Host ("Exception occured when calling Get-Email: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **Decode** | **Boolean**| Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing | [optional] [default to $false] + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailAttachments** +> AttachmentMetaData[] Get-EmailAttachments
+>         [-EmailId]
+ +Get all email attachment metadata. Metadata includes name and size of attachments. + +Returns an array of attachment metadata such as name and content-type for a given email if present. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get all email attachment metadata. Metadata includes name and size of attachments. +try { + $Result = Get-EmailAttachments -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-EmailAttachments: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +[**AttachmentMetaData[]**](AttachmentMetaData) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailContentMatch** +> EmailContentMatchResult Get-EmailContentMatch
+>         [-EmailId]
+>         [-ContentMatchOptions]
+ +Get email content regex pattern match results. Runs regex against email body and returns match groups. + +Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email to match against +$ContentMatchOptions = (Initialize-ContentMatchOptions -Pattern "Pattern_example") # ContentMatchOptions | + +# Get email content regex pattern match results. Runs regex against email body and returns match groups. +try { + $Result = Get-EmailContentMatch -EmailId $EmailId -ContentMatchOptions $ContentMatchOptions +} catch { + Write-Host ("Exception occured when calling Get-EmailContentMatch: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email to match against | + **ContentMatchOptions** | [**ContentMatchOptions**](ContentMatchOptions)| | + +### Return type + +[**EmailContentMatchResult**](EmailContentMatchResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailContentPart** +> EmailContentPartResult Get-EmailContentPart
+>         [-EmailId]
+>         [-ContentType]
+ +Get email content part by content type + +Get email body content parts from a multipart email message for a given content type + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email to match against +$ContentType = "ContentType_example" # String | Content type + +# Get email content part by content type +try { + $Result = Get-EmailContentPart -EmailId $EmailId -ContentType $ContentType +} catch { + Write-Host ("Exception occured when calling Get-EmailContentPart: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email to match against | + **ContentType** | **String**| Content type | + +### Return type + +[**EmailContentPartResult**](EmailContentPartResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailCount** +> CountDto Get-EmailCount
+>         [-InboxId]
+ +Get email count + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | (optional) + +# Get email count +try { + $Result = Get-EmailCount -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-EmailCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | [optional] + +### Return type + +[**CountDto**](CountDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailHTML** +> String Get-EmailHTML
+>         [-EmailId]
+>         [-Decode]
+>         [-ReplaceCidImages]
+ +Get email content as HTML. For displaying emails in browser context. + +Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$Decode = true # Boolean | (optional) (default to $false) +$ReplaceCidImages = true # Boolean | (optional) (default to $false) + +# Get email content as HTML. For displaying emails in browser context. +try { + $Result = Get-EmailHTML -EmailId $EmailId -Decode $Decode -ReplaceCidImages $ReplaceCidImages +} catch { + Write-Host ("Exception occured when calling Get-EmailHTML: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **Decode** | **Boolean**| | [optional] [default to $false] + **ReplaceCidImages** | **Boolean**| | [optional] [default to $false] + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html;charset=utf-8, text/html + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailHTMLJson** +> EmailHtmlDto Get-EmailHTMLJson
+>         [-EmailId]
+>         [-Decode]
+>         [-ReplaceCidImages]
+ +Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content + +Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$Decode = true # Boolean | (optional) (default to $false) +$ReplaceCidImages = true # Boolean | (optional) (default to $false) + +# Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content +try { + $Result = Get-EmailHTMLJson -EmailId $EmailId -Decode $Decode -ReplaceCidImages $ReplaceCidImages +} catch { + Write-Host ("Exception occured when calling Get-EmailHTMLJson: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **Decode** | **Boolean**| | [optional] [default to $false] + **ReplaceCidImages** | **Boolean**| | [optional] [default to $false] + +### Return type + +[**EmailHtmlDto**](EmailHtmlDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailHTMLQuery** +> EmailTextLinesResult Get-EmailHTMLQuery
+>         [-EmailId]
+>         [-HtmlSelector]
+ +Parse and return text from an email, stripping HTML and decoding encoded characters + +Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email to perform HTML query on +$HtmlSelector = "HtmlSelector_example" # String | HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. + +# Parse and return text from an email, stripping HTML and decoding encoded characters +try { + $Result = Get-EmailHTMLQuery -EmailId $EmailId -HtmlSelector $HtmlSelector +} catch { + Write-Host ("Exception occured when calling Get-EmailHTMLQuery: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email to perform HTML query on | + **HtmlSelector** | **String**| HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. | + +### Return type + +[**EmailTextLinesResult**](EmailTextLinesResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailLinks** +> EmailLinksResult Get-EmailLinks
+>         [-EmailId]
+ +Parse and return list of links found in an email (only works for HTML content) + +HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email to fetch text for + +# Parse and return list of links found in an email (only works for HTML content) +try { + $Result = Get-EmailLinks -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-EmailLinks: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email to fetch text for | + +### Return type + +[**EmailLinksResult**](EmailLinksResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailPreviewURLs** +> EmailPreviewUrls Get-EmailPreviewURLs
+>         [-EmailId]
+ +Get email URLs for viewing in browser or downloading + +Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | + +# Get email URLs for viewing in browser or downloading +try { + $Result = Get-EmailPreviewURLs -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-EmailPreviewURLs: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + +### Return type + +[**EmailPreviewUrls**](EmailPreviewUrls) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailScreenshotAsBase64** +> EmailScreenshotResult Get-EmailScreenshotAsBase64
+>         [-EmailId]
+>         [-GetEmailScreenshotOptions]
+ +Take a screenshot of an email in a browser and return base64 encoded string + +Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$GetEmailScreenshotOptions = (Initialize-GetEmailScreenshotOptions -Height 123 -Width 123) # GetEmailScreenshotOptions | + +# Take a screenshot of an email in a browser and return base64 encoded string +try { + $Result = Get-EmailScreenshotAsBase64 -EmailId $EmailId -GetEmailScreenshotOptions $GetEmailScreenshotOptions +} catch { + Write-Host ("Exception occured when calling Get-EmailScreenshotAsBase64: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **GetEmailScreenshotOptions** | [**GetEmailScreenshotOptions**](GetEmailScreenshotOptions)| | + +### Return type + +[**EmailScreenshotResult**](EmailScreenshotResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailScreenshotAsBinary** +> void Get-EmailScreenshotAsBinary
+>         [-EmailId]
+>         [-GetEmailScreenshotOptions]
+ +Take a screenshot of an email in a browser + +Returns binary octet-stream of screenshot of the given email + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$GetEmailScreenshotOptions = (Initialize-GetEmailScreenshotOptions -Height 123 -Width 123) # GetEmailScreenshotOptions | + +# Take a screenshot of an email in a browser +try { + $Result = Get-EmailScreenshotAsBinary -EmailId $EmailId -GetEmailScreenshotOptions $GetEmailScreenshotOptions +} catch { + Write-Host ("Exception occured when calling Get-EmailScreenshotAsBinary: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **GetEmailScreenshotOptions** | [**GetEmailScreenshotOptions**](GetEmailScreenshotOptions)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailTextLines** +> EmailTextLinesResult Get-EmailTextLines
+>         [-EmailId]
+>         [-DecodeHtmlEntities]
+>         [-LineSeparator]
+ +Parse and return text from an email, stripping HTML and decoding encoded characters + +Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email to fetch text for +$DecodeHtmlEntities = true # Boolean | Decode HTML entities (optional) +$LineSeparator = "LineSeparator_example" # String | Line separator character (optional) + +# Parse and return text from an email, stripping HTML and decoding encoded characters +try { + $Result = Get-EmailTextLines -EmailId $EmailId -DecodeHtmlEntities $DecodeHtmlEntities -LineSeparator $LineSeparator +} catch { + Write-Host ("Exception occured when calling Get-EmailTextLines: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email to fetch text for | + **DecodeHtmlEntities** | **Boolean**| Decode HTML entities | [optional] + **LineSeparator** | **String**| Line separator character | [optional] + +### Return type + +[**EmailTextLinesResult**](EmailTextLinesResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailsOffsetPaginated** +> PageEmailProjection Get-EmailsOffsetPaginated
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-UnreadOnly]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get all emails in all inboxes in paginated form. Email API list all. + +By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = @("Inner_example") # String[] | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) +$Page = 987 # Int32 | Optional page index in email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$UnreadOnly = true # Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional) (default to $false) +$SearchFilter = "SearchFilter_example" # String | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) +$Since = Get-Date # System.DateTime | Optional filter emails received after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter emails received before given date time (optional) + +# Get all emails in all inboxes in paginated form. Email API list all. +try { + $Result = Get-EmailsOffsetPaginated -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -UnreadOnly $UnreadOnly -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-EmailsOffsetPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String[]**](String)| Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] + **Page** | **Int32**| Optional page index in email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **UnreadOnly** | **Boolean**| Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to $false] + **SearchFilter** | **String**| Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body | [optional] + **Since** | **System.DateTime**| Optional filter emails received after given date time | [optional] + **Before** | **System.DateTime**| Optional filter emails received before given date time | [optional] + +### Return type + +[**PageEmailProjection**](PageEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmailsPaginated** +> PageEmailProjection Get-EmailsPaginated
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-UnreadOnly]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get all emails in all inboxes in paginated form. Email API list all. + +By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = @("Inner_example") # String[] | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) +$Page = 987 # Int32 | Optional page index in email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$UnreadOnly = true # Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional) (default to $false) +$SearchFilter = "SearchFilter_example" # String | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) +$Since = Get-Date # System.DateTime | Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) +$Before = Get-Date # System.DateTime | Optional filter emails received before given date time (optional) + +# Get all emails in all inboxes in paginated form. Email API list all. +try { + $Result = Get-EmailsPaginated -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -UnreadOnly $UnreadOnly -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-EmailsPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String[]**](String)| Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] + **Page** | **Int32**| Optional page index in email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **UnreadOnly** | **Boolean**| Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to $false] + **SearchFilter** | **String**| Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body | [optional] + **Since** | **System.DateTime**| Optional filter emails received after given date time. If unset will use time 24hours prior to now. | [optional] + **Before** | **System.DateTime**| Optional filter emails received before given date time | [optional] + +### Return type + +[**PageEmailProjection**](PageEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-GravatarUrlForEmailAddress** +> GravatarUrl Get-GravatarUrlForEmailAddress
+>         [-EmailAddress]
+>         [-Size]
+ + + +Get gravatar url for email address + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailAddress = "EmailAddress_example" # String | +$Size = "Size_example" # String | (optional) + +try { + $Result = Get-GravatarUrlForEmailAddress -EmailAddress $EmailAddress -Size $Size +} catch { + Write-Host ("Exception occured when calling Get-GravatarUrlForEmailAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailAddress** | **String**| | + **Size** | **String**| | [optional] + +### Return type + +[**GravatarUrl**](GravatarUrl) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-LatestEmail** +> Email Get-LatestEmail
+>         [-InboxIds]
+ +Get latest email in all inboxes. Most recently received. + +Get the newest email in all inboxes or in a passed set of inbox IDs + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxIds = @("Inner_example") # String[] | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional) + +# Get latest email in all inboxes. Most recently received. +try { + $Result = Get-LatestEmail -InboxIds $InboxIds +} catch { + Write-Host ("Exception occured when calling Get-LatestEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxIds** | [**String[]**](String)| Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes | [optional] + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-LatestEmailInInbox1** +> Email Get-LatestEmailInInbox1
+>         [-InboxId]
+ +Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. + +Get the newest email in all inboxes or in a passed set of inbox IDs + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to get the latest email from + +# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. +try { + $Result = Get-LatestEmailInInbox1 -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-LatestEmailInInbox1: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to get the latest email from | + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-OrganizationEmailsPaginated** +> PageEmailProjection Get-OrganizationEmailsPaginated
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-UnreadOnly]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get all organization emails. List team or shared test email accounts + +By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = @("Inner_example") # String[] | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) +$Page = 987 # Int32 | Optional page index in email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$UnreadOnly = true # Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional) (default to $false) +$SearchFilter = "SearchFilter_example" # String | Optional search filter search filter for emails. (optional) +$Since = Get-Date # System.DateTime | Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) +$Before = Get-Date # System.DateTime | Optional filter emails received before given date time (optional) + +# Get all organization emails. List team or shared test email accounts +try { + $Result = Get-OrganizationEmailsPaginated -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -UnreadOnly $UnreadOnly -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-OrganizationEmailsPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String[]**](String)| Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] + **Page** | **Int32**| Optional page index in email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **UnreadOnly** | **Boolean**| Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to $false] + **SearchFilter** | **String**| Optional search filter search filter for emails. | [optional] + **Since** | **System.DateTime**| Optional filter emails received after given date time. If unset will use time 24hours prior to now. | [optional] + **Before** | **System.DateTime**| Optional filter emails received before given date time | [optional] + +### Return type + +[**PageEmailProjection**](PageEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-RawEmailContents** +> void Get-RawEmailContents
+>         [-EmailId]
+ +Get raw email string. Returns unparsed raw SMTP message with headers and body. + +Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get raw email string. Returns unparsed raw SMTP message with headers and body. +try { + $Result = Get-RawEmailContents -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-RawEmailContents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-RawEmailJson** +> RawEmailJson Get-RawEmailJson
+>         [-EmailId]
+ +Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. + +Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. +try { + $Result = Get-RawEmailJson -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-RawEmailJson: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +[**RawEmailJson**](RawEmailJson) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-UnreadEmailCount** +> UnreadCount Get-UnreadEmailCount
+>         [-InboxId]
+ +Get unread email count + +Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional) + +# Get unread email count +try { + $Result = Get-UnreadEmailCount -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-UnreadEmailCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox ID filter | [optional] + +### Return type + +[**UnreadCount**](UnreadCount) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-MarkAllAsRead** +> void Invoke-MarkAllAsRead
+>         [-Read]
+>         [-InboxId]
+ +Mark all emails as read or unread + +Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Read = true # Boolean | What value to assign to email read property. Default true. (optional) (default to $true) +$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional) + +# Mark all emails as read or unread +try { + $Result = Invoke-MarkAllAsRead -Read $Read -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-MarkAllAsRead: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Read** | **Boolean**| What value to assign to email read property. Default true. | [optional] [default to $true] + **InboxId** | [**String**](String)| Optional inbox ID filter | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-MarkAsRead** +> EmailPreview Invoke-MarkAsRead
+>         [-EmailId]
+>         [-Read]
+ +Mark an email as read or unread + +Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | +$Read = true # Boolean | What value to assign to email read property. Default true. (optional) (default to $true) + +# Mark an email as read or unread +try { + $Result = Invoke-MarkAsRead -EmailId $EmailId -Read $Read +} catch { + Write-Host ("Exception occured when calling Invoke-MarkAsRead: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| | + **Read** | **Boolean**| What value to assign to email read property. Default true. | [optional] [default to $true] + +### Return type + +[**EmailPreview**](EmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ReplyToEmail** +> SentEmailDto Invoke-ReplyToEmail
+>         [-EmailId]
+>         [-ReplyToEmailOptions]
+ +Reply to an email + +Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of the email that should be replied to +$ReplyToEmailOptions = (Initialize-ReplyToEmailOptions -Body "Body_example" -IsHTML $false -VarFrom "VarFrom_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -Html $false) # ReplyToEmailOptions | + +# Reply to an email +try { + $Result = Invoke-ReplyToEmail -EmailId $EmailId -ReplyToEmailOptions $ReplyToEmailOptions +} catch { + Write-Host ("Exception occured when calling Invoke-ReplyToEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of the email that should be replied to | + **ReplyToEmailOptions** | [**ReplyToEmailOptions**](ReplyToEmailOptions)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Search-Emails** +> PageEmailProjection Search-Emails
+>         [-SearchEmailsOptions]
+ +Get all emails by search criteria. Return in paginated form. + +Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SearchEmailsOptions = (Initialize-SearchEmailsOptions -InboxIds @("InboxIds_example") -PageIndex 123 -PageSize 123 -SortDirection "ASC" -UnreadOnly $false -SearchFilter "SearchFilter_example" -Since Get-Date -Before Get-Date) # SearchEmailsOptions | + +# Get all emails by search criteria. Return in paginated form. +try { + $Result = Search-Emails -SearchEmailsOptions $SearchEmailsOptions +} catch { + Write-Host ("Exception occured when calling Search-Emails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SearchEmailsOptions** | [**SearchEmailsOptions**](SearchEmailsOptions)| | + +### Return type + +[**PageEmailProjection**](PageEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-EmailSourceOptional** +> void Send-EmailSourceOptional
+>         [-SendEmailOptions]
+>         [-InboxId]
+>         [-UseDomainPool]
+>         [-VirtualSend]
+ +Send email + +Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SendEmailOptions = (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID" -IgnoreEmptyRecipients $false -IsXAmpHtml $false -BodyParts @((Initialize-SendEmailBodyPart -ContentType "ContentType_example" -ContentBody "ContentBody_example"))) # SendEmailOptions | +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from (optional) +$UseDomainPool = true # Boolean | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) +$VirtualSend = true # Boolean | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) + +# Send email +try { + $Result = Send-EmailSourceOptional -SendEmailOptions $SendEmailOptions -InboxId $InboxId -UseDomainPool $UseDomainPool -VirtualSend $VirtualSend +} catch { + Write-Host ("Exception occured when calling Send-EmailSourceOptional: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | [optional] + **UseDomainPool** | **Boolean**| Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. | [optional] + **VirtualSend** | **Boolean**| Optionally create inbox to send from that is a virtual inbox and won't send to external addresses | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Confirm-Email** +> ValidationDto Confirm-Email
+>         [-EmailId]
+ +Validate email HTML contents + +Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Validate email HTML contents +try { + $Result = Confirm-Email -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Confirm-Email: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +[**ValidationDto**](ValidationDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/EmailFeatureCategoryName.md b/docs/EmailFeatureCategoryName.md new file mode 100644 index 00000000..1f9a3c79 --- /dev/null +++ b/docs/EmailFeatureCategoryName.md @@ -0,0 +1,23 @@ +# EmailFeatureCategoryName +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Slug** | **String** | | +**Name** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureCategoryName = Initialize-maislurp-client-powershellEmailFeatureCategoryName -Slug null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureCategoryName | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureFamilyName.md b/docs/EmailFeatureFamilyName.md new file mode 100644 index 00000000..53c25ab6 --- /dev/null +++ b/docs/EmailFeatureFamilyName.md @@ -0,0 +1,23 @@ +# EmailFeatureFamilyName +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Slug** | **String** | | +**Name** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureFamilyName = Initialize-maislurp-client-powershellEmailFeatureFamilyName -Slug null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureFamilyName | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureFamilyStatistics.md b/docs/EmailFeatureFamilyStatistics.md new file mode 100644 index 00000000..0a31367d --- /dev/null +++ b/docs/EmailFeatureFamilyStatistics.md @@ -0,0 +1,25 @@ +# EmailFeatureFamilyStatistics +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | **String** | | +**Family** | **String** | | +**Platforms** | [**EmailFeaturePlatformStatistics[]**](EmailFeaturePlatformStatistics) | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureFamilyStatistics = Initialize-maislurp-client-powershellEmailFeatureFamilyStatistics -Feature null ` + -Family null ` + -Platforms null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureFamilyStatistics | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureNames.md b/docs/EmailFeatureNames.md new file mode 100644 index 00000000..cd4ca61a --- /dev/null +++ b/docs/EmailFeatureNames.md @@ -0,0 +1,25 @@ +# EmailFeatureNames +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Family** | [**EmailFeatureFamilyName[]**](EmailFeatureFamilyName) | | +**Platform** | [**EmailFeaturePlatformName[]**](EmailFeaturePlatformName) | | +**Category** | [**EmailFeatureCategoryName[]**](EmailFeatureCategoryName) | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureNames = Initialize-maislurp-client-powershellEmailFeatureNames -Family null ` + -Platform null ` + -Category null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureNames | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureOverview.md b/docs/EmailFeatureOverview.md new file mode 100644 index 00000000..a4790bce --- /dev/null +++ b/docs/EmailFeatureOverview.md @@ -0,0 +1,35 @@ +# EmailFeatureOverview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | **String** | | +**Title** | **String** | | [optional] +**Description** | **String** | | [optional] +**Category** | **String** | | [optional] +**Notes** | **String** | | [optional] +**NotesNumbers** | **System.Collections.Hashtable** | | [optional] +**FeatureStatistics** | [**EmailFeatureFamilyStatistics[]**](EmailFeatureFamilyStatistics) | | [optional] +**Statuses** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureOverview = Initialize-maislurp-client-powershellEmailFeatureOverview -Feature null ` + -Title null ` + -Description null ` + -Category null ` + -Notes null ` + -NotesNumbers null ` + -FeatureStatistics null ` + -Statuses null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureOverview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeaturePlatformName.md b/docs/EmailFeaturePlatformName.md new file mode 100644 index 00000000..505d9f3a --- /dev/null +++ b/docs/EmailFeaturePlatformName.md @@ -0,0 +1,23 @@ +# EmailFeaturePlatformName +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Slug** | **String** | | +**Name** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeaturePlatformName = Initialize-maislurp-client-powershellEmailFeaturePlatformName -Slug null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$EmailFeaturePlatformName | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeaturePlatformStatistics.md b/docs/EmailFeaturePlatformStatistics.md new file mode 100644 index 00000000..3b5edd54 --- /dev/null +++ b/docs/EmailFeaturePlatformStatistics.md @@ -0,0 +1,23 @@ +# EmailFeaturePlatformStatistics +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Platform** | **String** | | +**Versions** | [**EmailFeatureVersionStatistics[]**](EmailFeatureVersionStatistics) | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeaturePlatformStatistics = Initialize-maislurp-client-powershellEmailFeaturePlatformStatistics -Platform null ` + -Versions null +``` + +- Convert the resource to JSON +```powershell +$EmailFeaturePlatformStatistics | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureSupportFlags.md b/docs/EmailFeatureSupportFlags.md new file mode 100644 index 00000000..84b3b0b9 --- /dev/null +++ b/docs/EmailFeatureSupportFlags.md @@ -0,0 +1,23 @@ +# EmailFeatureSupportFlags +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | **String** | | +**Notes** | **String[]** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureSupportFlags = Initialize-maislurp-client-powershellEmailFeatureSupportFlags -Status null ` + -Notes null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureSupportFlags | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureSupportResult.md b/docs/EmailFeatureSupportResult.md new file mode 100644 index 00000000..cf55cfa3 --- /dev/null +++ b/docs/EmailFeatureSupportResult.md @@ -0,0 +1,27 @@ +# EmailFeatureSupportResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Names** | [**EmailFeatureNames**](EmailFeatureNames) | | +**DetectedFeatures** | **String[]** | | +**FeatureOverviews** | [**EmailFeatureOverview[]**](EmailFeatureOverview) | | +**FeaturePercentages** | [**EmailFeatureSupportStatusPercentage[]**](EmailFeatureSupportStatusPercentage) | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureSupportResult = Initialize-maislurp-client-powershellEmailFeatureSupportResult -Names null ` + -DetectedFeatures null ` + -FeatureOverviews null ` + -FeaturePercentages null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureSupportResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureSupportStatusPercentage.md b/docs/EmailFeatureSupportStatusPercentage.md new file mode 100644 index 00000000..137f9596 --- /dev/null +++ b/docs/EmailFeatureSupportStatusPercentage.md @@ -0,0 +1,23 @@ +# EmailFeatureSupportStatusPercentage +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | **String** | | +**Percentage** | **Double** | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureSupportStatusPercentage = Initialize-maislurp-client-powershellEmailFeatureSupportStatusPercentage -Status null ` + -Percentage null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureSupportStatusPercentage | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailFeatureVersionStatistics.md b/docs/EmailFeatureVersionStatistics.md new file mode 100644 index 00000000..500d4468 --- /dev/null +++ b/docs/EmailFeatureVersionStatistics.md @@ -0,0 +1,23 @@ +# EmailFeatureVersionStatistics +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **String** | | +**SupportFlags** | [**EmailFeatureSupportFlags**](EmailFeatureSupportFlags) | | + +## Examples + +- Prepare the resource +```powershell +$EmailFeatureVersionStatistics = Initialize-maislurp-client-powershellEmailFeatureVersionStatistics -Version null ` + -SupportFlags null +``` + +- Convert the resource to JSON +```powershell +$EmailFeatureVersionStatistics | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailHtmlDto.md b/docs/EmailHtmlDto.md new file mode 100644 index 00000000..87b5821d --- /dev/null +++ b/docs/EmailHtmlDto.md @@ -0,0 +1,23 @@ +# EmailHtmlDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Subject** | **String** | | [optional] +**Body** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailHtmlDto = Initialize-maislurp-client-powershellEmailHtmlDto -Subject null ` + -Body null +``` + +- Convert the resource to JSON +```powershell +$EmailHtmlDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailLinksResult.md b/docs/EmailLinksResult.md new file mode 100644 index 00000000..d346ca96 --- /dev/null +++ b/docs/EmailLinksResult.md @@ -0,0 +1,23 @@ +# EmailLinksResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | **String[]** | | +**Body** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailLinksResult = Initialize-maislurp-client-powershellEmailLinksResult -Links null ` + -Body null +``` + +- Convert the resource to JSON +```powershell +$EmailLinksResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailPreview.md b/docs/EmailPreview.md new file mode 100644 index 00000000..d030fbfd --- /dev/null +++ b/docs/EmailPreview.md @@ -0,0 +1,39 @@ +# EmailPreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the email entity | +**DomainId** | **String** | ID of the domain that received the email | [optional] +**Subject** | **String** | The subject line of the email message as specified by SMTP subject header | [optional] +**To** | **String[]** | List of `To` recipient email addresses that the email was addressed to. See recipients object for names. | +**VarFrom** | **String** | Who the email was sent from. An email address - see fromName for the sender name. | [optional] +**Bcc** | **String[]** | List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. | [optional] +**Cc** | **String[]** | List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. | [optional] +**CreatedAt** | **System.DateTime** | When was the email received by MailSlurp | +**Read** | **Boolean** | Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks. | +**Attachments** | **String[]** | List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailPreview = Initialize-maislurp-client-powershellEmailPreview -Id null ` + -DomainId null ` + -Subject null ` + -To null ` + -VarFrom null ` + -Bcc null ` + -Cc null ` + -CreatedAt null ` + -Read null ` + -Attachments null +``` + +- Convert the resource to JSON +```powershell +$EmailPreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailPreviewUrls.md b/docs/EmailPreviewUrls.md new file mode 100644 index 00000000..7902a943 --- /dev/null +++ b/docs/EmailPreviewUrls.md @@ -0,0 +1,25 @@ +# EmailPreviewUrls +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RawSmtpMessageUrl** | **String** | | +**PlainHtmlBodyUrl** | **String** | | +**Origin** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailPreviewUrls = Initialize-maislurp-client-powershellEmailPreviewUrls -RawSmtpMessageUrl null ` + -PlainHtmlBodyUrl null ` + -Origin null +``` + +- Convert the resource to JSON +```powershell +$EmailPreviewUrls | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailProjection.md b/docs/EmailProjection.md new file mode 100644 index 00000000..05e54823 --- /dev/null +++ b/docs/EmailProjection.md @@ -0,0 +1,49 @@ +# EmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attachments** | **String[]** | | [optional] +**InboxId** | **String** | | +**To** | **String[]** | | +**DomainId** | **String** | | [optional] +**Bcc** | **String[]** | | [optional] +**Cc** | **String[]** | | [optional] +**Read** | **Boolean** | | +**BodyExcerpt** | **String** | | [optional] +**TeamAccess** | **Boolean** | | +**BodyMD5Hash** | **String** | | [optional] +**TextExcerpt** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Subject** | **String** | | [optional] +**Id** | **String** | | +**VarFrom** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailProjection = Initialize-maislurp-client-powershellEmailProjection -Attachments null ` + -InboxId null ` + -To null ` + -DomainId null ` + -Bcc null ` + -Cc null ` + -Read null ` + -BodyExcerpt null ` + -TeamAccess null ` + -BodyMD5Hash null ` + -TextExcerpt null ` + -CreatedAt null ` + -Subject null ` + -Id null ` + -VarFrom null +``` + +- Convert the resource to JSON +```powershell +$EmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailRecipients.md b/docs/EmailRecipients.md new file mode 100644 index 00000000..f85d6362 --- /dev/null +++ b/docs/EmailRecipients.md @@ -0,0 +1,25 @@ +# EmailRecipients +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**To** | [**Recipient[]**](Recipient) | | [optional] +**Cc** | [**Recipient[]**](Recipient) | | [optional] +**Bcc** | [**Recipient[]**](Recipient) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailRecipients = Initialize-maislurp-client-powershellEmailRecipients -To null ` + -Cc null ` + -Bcc null +``` + +- Convert the resource to JSON +```powershell +$EmailRecipients | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailScreenshotResult.md b/docs/EmailScreenshotResult.md new file mode 100644 index 00000000..e564bb04 --- /dev/null +++ b/docs/EmailScreenshotResult.md @@ -0,0 +1,21 @@ +# EmailScreenshotResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Base64EncodedImage** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailScreenshotResult = Initialize-maislurp-client-powershellEmailScreenshotResult -Base64EncodedImage null +``` + +- Convert the resource to JSON +```powershell +$EmailScreenshotResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailTextLinesResult.md b/docs/EmailTextLinesResult.md new file mode 100644 index 00000000..072c688e --- /dev/null +++ b/docs/EmailTextLinesResult.md @@ -0,0 +1,23 @@ +# EmailTextLinesResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lines** | **String[]** | | +**Body** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmailTextLinesResult = Initialize-maislurp-client-powershellEmailTextLinesResult -Lines null ` + -Body null +``` + +- Convert the resource to JSON +```powershell +$EmailTextLinesResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailValidationRequestDto.md b/docs/EmailValidationRequestDto.md new file mode 100644 index 00000000..9a84605c --- /dev/null +++ b/docs/EmailValidationRequestDto.md @@ -0,0 +1,31 @@ +# EmailValidationRequestDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**EmailAddress** | **String** | | +**IsValid** | **Boolean** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$EmailValidationRequestDto = Initialize-maislurp-client-powershellEmailValidationRequestDto -Id null ` + -UserId null ` + -EmailAddress null ` + -IsValid null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$EmailValidationRequestDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmailVerificationControllerApi.md b/docs/EmailVerificationControllerApi.md new file mode 100644 index 00000000..753371c2 --- /dev/null +++ b/docs/EmailVerificationControllerApi.md @@ -0,0 +1,217 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.EmailVerificationControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-DeleteAllValidationRequests**](EmailVerificationControllerApi#Invoke-DeleteAllValidationRequests) | **DELETE** /email-verification | Delete all validation requests +[**Invoke-DeleteValidationRequest**](EmailVerificationControllerApi#Invoke-DeleteValidationRequest) | **DELETE** /email-verification/{id} | Delete a validation record +[**Get-ValidationRequests**](EmailVerificationControllerApi#Get-ValidationRequests) | **GET** /email-verification/validation-requests | Validate a list of email addresses. Per unit billing. See your plan for pricing. +[**Confirm-EmailAddressList**](EmailVerificationControllerApi#Confirm-EmailAddressList) | **POST** /email-verification/email-address-list | Validate a list of email addresses. Per unit billing. See your plan for pricing. + + + +# **Invoke-DeleteAllValidationRequests** +> void Invoke-DeleteAllValidationRequests
+ +Delete all validation requests + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Delete all validation requests +try { + $Result = Invoke-DeleteAllValidationRequests +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllValidationRequests: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteValidationRequest** +> void Invoke-DeleteValidationRequest
+>         [-Id]
+ +Delete a validation record + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Delete a validation record +try { + $Result = Invoke-DeleteValidationRequest -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteValidationRequest: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ValidationRequests** +> PageEmailValidationRequest Get-ValidationRequests
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+>         [-IsValid]
+ +Validate a list of email addresses. Per unit billing. See your plan for pricing. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size for paginated result list. (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "DESC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$IsValid = true # Boolean | Filter where email is valid is true or false (optional) + +# Validate a list of email addresses. Per unit billing. See your plan for pricing. +try { + $Result = Get-ValidationRequests -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -IsValid $IsValid +} catch { + Write-Host ("Exception occured when calling Get-ValidationRequests: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size for paginated result list. | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "DESC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **IsValid** | **Boolean**| Filter where email is valid is true or false | [optional] + +### Return type + +[**PageEmailValidationRequest**](PageEmailValidationRequest) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Confirm-EmailAddressList** +> ValidateEmailAddressListResult Confirm-EmailAddressList
+>         [-ValidateEmailAddressListOptions]
+ +Validate a list of email addresses. Per unit billing. See your plan for pricing. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ValidateEmailAddressListOptions = (Initialize-ValidateEmailAddressListOptions -EmailAddressList @("EmailAddressList_example") -IgnoreOldResults $false) # ValidateEmailAddressListOptions | + +# Validate a list of email addresses. Per unit billing. See your plan for pricing. +try { + $Result = Confirm-EmailAddressList -ValidateEmailAddressListOptions $ValidateEmailAddressListOptions +} catch { + Write-Host ("Exception occured when calling Confirm-EmailAddressList: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ValidateEmailAddressListOptions** | [**ValidateEmailAddressListOptions**](ValidateEmailAddressListOptions)| | + +### Return type + +[**ValidateEmailAddressListResult**](ValidateEmailAddressListResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/EmailVerificationResult.md b/docs/EmailVerificationResult.md new file mode 100644 index 00000000..97b8b5eb --- /dev/null +++ b/docs/EmailVerificationResult.md @@ -0,0 +1,29 @@ +# EmailVerificationResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DomainName** | **String** | | +**Port** | **Int32** | | +**EmailAddress** | **String** | | +**IsValid** | **Boolean** | | +**VarError** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailVerificationResult = Initialize-maislurp-client-powershellEmailVerificationResult -DomainName null ` + -Port null ` + -EmailAddress null ` + -IsValid null ` + -VarError null +``` + +- Convert the resource to JSON +```powershell +$EmailVerificationResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmergencyAddress.md b/docs/EmergencyAddress.md new file mode 100644 index 00000000..243cc405 --- /dev/null +++ b/docs/EmergencyAddress.md @@ -0,0 +1,45 @@ +# EmergencyAddress +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [optional] +**Sid** | **String** | | +**UserId** | **String** | | +**DisplayName** | **String** | | +**CustomerName** | **String** | | +**Address1** | **String** | | +**City** | **String** | | +**Region** | **String** | | +**PostalCode** | **String** | | +**PhoneCountry** | **String** | | +**AccountSid** | **String** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$EmergencyAddress = Initialize-maislurp-client-powershellEmergencyAddress -Id null ` + -Sid null ` + -UserId null ` + -DisplayName null ` + -CustomerName null ` + -Address1 null ` + -City null ` + -Region null ` + -PostalCode null ` + -PhoneCountry null ` + -AccountSid null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$EmergencyAddress | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmergencyAddressDto.md b/docs/EmergencyAddressDto.md new file mode 100644 index 00000000..3735268c --- /dev/null +++ b/docs/EmergencyAddressDto.md @@ -0,0 +1,25 @@ +# EmergencyAddressDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**Address1** | **String** | | +**PhoneCountry** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$EmergencyAddressDto = Initialize-maislurp-client-powershellEmergencyAddressDto -Id null ` + -Address1 null ` + -PhoneCountry null +``` + +- Convert the resource to JSON +```powershell +$EmergencyAddressDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/EmptyResponseDto.md b/docs/EmptyResponseDto.md new file mode 100644 index 00000000..0447b849 --- /dev/null +++ b/docs/EmptyResponseDto.md @@ -0,0 +1,21 @@ +# EmptyResponseDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmptyResponseDto = Initialize-maislurp-client-powershellEmptyResponseDto -Message null +``` + +- Convert the resource to JSON +```powershell +$EmptyResponseDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ExpirationDefaults.md b/docs/ExpirationDefaults.md new file mode 100644 index 00000000..a05c1b20 --- /dev/null +++ b/docs/ExpirationDefaults.md @@ -0,0 +1,29 @@ +# ExpirationDefaults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultExpirationMillis** | **Int64** | | [optional] +**MaxExpirationMillis** | **Int64** | | [optional] +**DefaultExpiresAt** | **System.DateTime** | | [optional] +**CanPermanentInbox** | **Boolean** | | +**NextInboxAllowsPermanent** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$ExpirationDefaults = Initialize-maislurp-client-powershellExpirationDefaults -DefaultExpirationMillis null ` + -MaxExpirationMillis null ` + -DefaultExpiresAt null ` + -CanPermanentInbox null ` + -NextInboxAllowsPermanent null +``` + +- Convert the resource to JSON +```powershell +$ExpirationDefaults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ExpiredControllerApi.md b/docs/ExpiredControllerApi.md new file mode 100644 index 00000000..6c83d093 --- /dev/null +++ b/docs/ExpiredControllerApi.md @@ -0,0 +1,219 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.ExpiredControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-ExpirationDefaults**](ExpiredControllerApi#Get-ExpirationDefaults) | **GET** /expired/defaults | Get default expiration settings +[**Get-ExpiredInboxByInboxId**](ExpiredControllerApi#Get-ExpiredInboxByInboxId) | **GET** /expired/inbox/{inboxId} | Get expired inbox record for a previously existing inbox +[**Get-ExpiredInboxRecord**](ExpiredControllerApi#Get-ExpiredInboxRecord) | **GET** /expired/{expiredId} | Get an expired inbox record +[**Get-ExpiredInboxes**](ExpiredControllerApi#Get-ExpiredInboxes) | **GET** /expired | List records of expired inboxes + + + +# **Get-ExpirationDefaults** +> ExpirationDefaults Get-ExpirationDefaults
+ +Get default expiration settings + +Return default times used for inbox expiration + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get default expiration settings +try { + $Result = Get-ExpirationDefaults +} catch { + Write-Host ("Exception occured when calling Get-ExpirationDefaults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ExpirationDefaults**](ExpirationDefaults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ExpiredInboxByInboxId** +> ExpiredInboxDto Get-ExpiredInboxByInboxId
+>         [-InboxId]
+ +Get expired inbox record for a previously existing inbox + +Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of inbox you want to retrieve (not the inbox ID) + +# Get expired inbox record for a previously existing inbox +try { + $Result = Get-ExpiredInboxByInboxId -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-ExpiredInboxByInboxId: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of inbox you want to retrieve (not the inbox ID) | + +### Return type + +[**ExpiredInboxDto**](ExpiredInboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ExpiredInboxRecord** +> ExpiredInboxDto Get-ExpiredInboxRecord
+>         [-ExpiredId]
+ +Get an expired inbox record + +Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ExpiredId = "ExpiredId_example" # String | ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId + +# Get an expired inbox record +try { + $Result = Get-ExpiredInboxRecord -ExpiredId $ExpiredId +} catch { + Write-Host ("Exception occured when calling Get-ExpiredInboxRecord: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ExpiredId** | [**String**](String)| ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId | + +### Return type + +[**ExpiredInboxDto**](ExpiredInboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ExpiredInboxes** +> PageExpiredInboxRecordProjection Get-ExpiredInboxes
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +List records of expired inboxes + +Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in inbox sent email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox sent email list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List records of expired inboxes +try { + $Result = Get-ExpiredInboxes -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-ExpiredInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in inbox sent email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox sent email list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageExpiredInboxRecordProjection**](PageExpiredInboxRecordProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/ExpiredInboxDto.md b/docs/ExpiredInboxDto.md new file mode 100644 index 00000000..8f27df75 --- /dev/null +++ b/docs/ExpiredInboxDto.md @@ -0,0 +1,25 @@ +# ExpiredInboxDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**InboxId** | **String** | | +**EmailAddress** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ExpiredInboxDto = Initialize-maislurp-client-powershellExpiredInboxDto -Id null ` + -InboxId null ` + -EmailAddress null +``` + +- Convert the resource to JSON +```powershell +$ExpiredInboxDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ExpiredInboxRecordProjection.md b/docs/ExpiredInboxRecordProjection.md new file mode 100644 index 00000000..0ae7b0fd --- /dev/null +++ b/docs/ExpiredInboxRecordProjection.md @@ -0,0 +1,27 @@ +# ExpiredInboxRecordProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | | +**UserId** | **String** | | +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ExpiredInboxRecordProjection = Initialize-maislurp-client-powershellExpiredInboxRecordProjection -EmailAddress null ` + -UserId null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ExpiredInboxRecordProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ExportControllerApi.md b/docs/ExportControllerApi.md new file mode 100644 index 00000000..a2a6d7ad --- /dev/null +++ b/docs/ExportControllerApi.md @@ -0,0 +1,133 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.ExportControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Export-Entities**](ExportControllerApi#Export-Entities) | **GET** /export | Export inboxes link callable via browser +[**Get-ExportLink**](ExportControllerApi#Get-ExportLink) | **POST** /export | Get export link + + + +# **Export-Entities** +> SystemByte Export-Entities
+>         [-ExportType]
+>         [-ApiKey]
+>         [-OutputFormat]
+>         [-Filter]
+>         [-ListSeparatorToken]
+>         [-ExcludePreviouslyExported]
+>         [-CreatedEarliestTime]
+>         [-CreatedOldestTime]
+ +Export inboxes link callable via browser + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ExportType = "INBOXES" # String | +$ApiKey = "ApiKey_example" # String | +$OutputFormat = "CSV_DEFAULT" # String | +$Filter = "Filter_example" # String | (optional) +$ListSeparatorToken = "ListSeparatorToken_example" # String | (optional) +$ExcludePreviouslyExported = true # Boolean | (optional) +$CreatedEarliestTime = Get-Date # System.DateTime | (optional) +$CreatedOldestTime = Get-Date # System.DateTime | (optional) + +# Export inboxes link callable via browser +try { + $Result = Export-Entities -ExportType $ExportType -ApiKey $ApiKey -OutputFormat $OutputFormat -Filter $Filter -ListSeparatorToken $ListSeparatorToken -ExcludePreviouslyExported $ExcludePreviouslyExported -CreatedEarliestTime $CreatedEarliestTime -CreatedOldestTime $CreatedOldestTime +} catch { + Write-Host ("Exception occured when calling Export-Entities: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ExportType** | **String**| | + **ApiKey** | **String**| | + **OutputFormat** | **String**| | + **Filter** | **String**| | [optional] + **ListSeparatorToken** | **String**| | [optional] + **ExcludePreviouslyExported** | **Boolean**| | [optional] + **CreatedEarliestTime** | **System.DateTime**| | [optional] + **CreatedOldestTime** | **System.DateTime**| | [optional] + +### Return type + +[**SystemByte**](SystemByte) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ExportLink** +> ExportLink Get-ExportLink
+>         [-ExportType]
+>         [-ExportOptions]
+>         [-ApiKey]
+ +Get export link + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ExportType = "INBOXES" # String | +$ExportOptions = (Initialize-ExportOptions -OutputFormat "CSV_DEFAULT" -ExcludePreviouslyExported $false -CreatedEarliestTime Get-Date -CreatedOldestTime Get-Date -VarFilter "VarFilter_example" -ListSeparatorToken "ListSeparatorToken_example") # ExportOptions | +$ApiKey = "ApiKey_example" # String | (optional) + +# Get export link +try { + $Result = Get-ExportLink -ExportType $ExportType -ExportOptions $ExportOptions -ApiKey $ApiKey +} catch { + Write-Host ("Exception occured when calling Get-ExportLink: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ExportType** | **String**| | + **ExportOptions** | [**ExportOptions**](ExportOptions)| | + **ApiKey** | **String**| | [optional] + +### Return type + +[**ExportLink**](ExportLink) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/ExportLink.md b/docs/ExportLink.md new file mode 100644 index 00000000..0b8b0c2e --- /dev/null +++ b/docs/ExportLink.md @@ -0,0 +1,21 @@ +# ExportLink +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DownloadLink** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ExportLink = Initialize-maislurp-client-powershellExportLink -DownloadLink null +``` + +- Convert the resource to JSON +```powershell +$ExportLink | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ExportOptions.md b/docs/ExportOptions.md new file mode 100644 index 00000000..14c8910f --- /dev/null +++ b/docs/ExportOptions.md @@ -0,0 +1,31 @@ +# ExportOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OutputFormat** | **String** | | +**ExcludePreviouslyExported** | **Boolean** | | [optional] +**CreatedEarliestTime** | **System.DateTime** | | [optional] +**CreatedOldestTime** | **System.DateTime** | | [optional] +**VarFilter** | **String** | | [optional] +**ListSeparatorToken** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportOptions = Initialize-maislurp-client-powershellExportOptions -OutputFormat null ` + -ExcludePreviouslyExported null ` + -CreatedEarliestTime null ` + -CreatedOldestTime null ` + -VarFilter null ` + -ListSeparatorToken null +``` + +- Convert the resource to JSON +```powershell +$ExportOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FakeEmailDto.md b/docs/FakeEmailDto.md new file mode 100644 index 00000000..4072ef1e --- /dev/null +++ b/docs/FakeEmailDto.md @@ -0,0 +1,37 @@ +# FakeEmailDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**EmailAddress** | **String** | | +**VarSender** | [**ModelSender**](ModelSender) | | [optional] +**Recipients** | [**EmailRecipients**](EmailRecipients) | | [optional] +**Subject** | **String** | | [optional] +**Preview** | **String** | | [optional] +**Body** | **String** | | +**Seen** | **Boolean** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$FakeEmailDto = Initialize-maislurp-client-powershellFakeEmailDto -Id null ` + -EmailAddress null ` + -VarSender null ` + -Recipients null ` + -Subject null ` + -Preview null ` + -Body null ` + -Seen null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$FakeEmailDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FakeEmailPreview.md b/docs/FakeEmailPreview.md new file mode 100644 index 00000000..c96dac17 --- /dev/null +++ b/docs/FakeEmailPreview.md @@ -0,0 +1,35 @@ +# FakeEmailPreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**EmailAddress** | **String** | | +**VarSender** | [**ModelSender**](ModelSender) | | [optional] +**Recipients** | [**EmailRecipients**](EmailRecipients) | | [optional] +**Subject** | **String** | | [optional] +**Preview** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Seen** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$FakeEmailPreview = Initialize-maislurp-client-powershellFakeEmailPreview -Id null ` + -EmailAddress null ` + -VarSender null ` + -Recipients null ` + -Subject null ` + -Preview null ` + -CreatedAt null ` + -Seen null +``` + +- Convert the resource to JSON +```powershell +$FakeEmailPreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FakeEmailResult.md b/docs/FakeEmailResult.md new file mode 100644 index 00000000..dee15f7c --- /dev/null +++ b/docs/FakeEmailResult.md @@ -0,0 +1,21 @@ +# FakeEmailResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Email** | [**FakeEmailDto**](FakeEmailDto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$FakeEmailResult = Initialize-maislurp-client-powershellFakeEmailResult -Email null +``` + +- Convert the resource to JSON +```powershell +$FakeEmailResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FilterBouncedRecipientsOptions.md b/docs/FilterBouncedRecipientsOptions.md new file mode 100644 index 00000000..a183951f --- /dev/null +++ b/docs/FilterBouncedRecipientsOptions.md @@ -0,0 +1,21 @@ +# FilterBouncedRecipientsOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailRecipients** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$FilterBouncedRecipientsOptions = Initialize-maislurp-client-powershellFilterBouncedRecipientsOptions -EmailRecipients null +``` + +- Convert the resource to JSON +```powershell +$FilterBouncedRecipientsOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FilterBouncedRecipientsResult.md b/docs/FilterBouncedRecipientsResult.md new file mode 100644 index 00000000..35c2728a --- /dev/null +++ b/docs/FilterBouncedRecipientsResult.md @@ -0,0 +1,21 @@ +# FilterBouncedRecipientsResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredRecipients** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$FilterBouncedRecipientsResult = Initialize-maislurp-client-powershellFilterBouncedRecipientsResult -FilteredRecipients null +``` + +- Convert the resource to JSON +```powershell +$FilterBouncedRecipientsResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FlushExpiredInboxesResult.md b/docs/FlushExpiredInboxesResult.md new file mode 100644 index 00000000..3862c929 --- /dev/null +++ b/docs/FlushExpiredInboxesResult.md @@ -0,0 +1,23 @@ +# FlushExpiredInboxesResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxIds** | **String[]** | Inbox IDs affected by expiration | +**ExpireBefore** | **System.DateTime** | DateTime to filter inboxes so that those expiring before this time are expired | + +## Examples + +- Prepare the resource +```powershell +$FlushExpiredInboxesResult = Initialize-maislurp-client-powershellFlushExpiredInboxesResult -InboxIds null ` + -ExpireBefore null +``` + +- Convert the resource to JSON +```powershell +$FlushExpiredInboxesResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/FormControllerApi.md b/docs/FormControllerApi.md new file mode 100644 index 00000000..c1b9e3a1 --- /dev/null +++ b/docs/FormControllerApi.md @@ -0,0 +1,77 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.FormControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Submit-Form**](FormControllerApi#Submit-Form) | **POST** /forms | Submit a form to be parsed and sent as an email to an address determined by the form fields + + + +# **Submit-Form** +> String Submit-Form
+>         [-To]
+>         [-Subject]
+>         [-RedirectTo]
+>         [-EmailAddress]
+>         [-SuccessMessage]
+>         [-SpamCheck]
+>         [-OtherParameters]
+ +Submit a form to be parsed and sent as an email to an address determined by the form fields + +This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a `_to` email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com` The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types. #### HTML Example ```html
``` #### URL Example ```html
``` The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the `enctype` attribute, for instance: `
`. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$To = "To_example" # String | The email address that submitted form should be sent to. (optional) +$Subject = "Subject_example" # String | Optional subject of the email that will be sent. (optional) +$RedirectTo = "RedirectTo_example" # String | Optional URL to redirect form submitter to after submission. If not present user will see a success message. (optional) +$EmailAddress = "EmailAddress_example" # String | Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. (optional) +$SuccessMessage = "SuccessMessage_example" # String | Optional success message to display if no _redirectTo present. (optional) +$SpamCheck = "SpamCheck_example" # String | Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored. (optional) +$OtherParameters = "OtherParameters_example" # String | All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent. (optional) + +# Submit a form to be parsed and sent as an email to an address determined by the form fields +try { + $Result = Submit-Form -To $To -Subject $Subject -RedirectTo $RedirectTo -EmailAddress $EmailAddress -SuccessMessage $SuccessMessage -SpamCheck $SpamCheck -OtherParameters $OtherParameters +} catch { + Write-Host ("Exception occured when calling Submit-Form: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **To** | **String**| The email address that submitted form should be sent to. | [optional] + **Subject** | **String**| Optional subject of the email that will be sent. | [optional] + **RedirectTo** | **String**| Optional URL to redirect form submitter to after submission. If not present user will see a success message. | [optional] + **EmailAddress** | **String**| Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. | [optional] + **SuccessMessage** | **String**| Optional success message to display if no _redirectTo present. | [optional] + **SpamCheck** | **String**| Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored. | [optional] + **OtherParameters** | **String**| All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent. | [optional] + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/ForwardEmailOptions.md b/docs/ForwardEmailOptions.md new file mode 100644 index 00000000..4e384cf0 --- /dev/null +++ b/docs/ForwardEmailOptions.md @@ -0,0 +1,33 @@ +# ForwardEmailOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**To** | **String[]** | To recipients for forwarded email | +**Subject** | **String** | Subject for forwarded email | [optional] +**Cc** | **String[]** | Optional cc recipients | [optional] +**Bcc** | **String[]** | Optional bcc recipients | [optional] +**VarFrom** | **String** | Optional from override | [optional] +**UseInboxName** | **Boolean** | Optionally use inbox name as display name for sender email address | [optional] +**FilterBouncedRecipients** | **Boolean** | Filter recipients to remove any bounced recipients from to, bcc, and cc before sending | [optional] + +## Examples + +- Prepare the resource +```powershell +$ForwardEmailOptions = Initialize-maislurp-client-powershellForwardEmailOptions -To null ` + -Subject null ` + -Cc null ` + -Bcc null ` + -VarFrom null ` + -UseInboxName null ` + -FilterBouncedRecipients null +``` + +- Convert the resource to JSON +```powershell +$ForwardEmailOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateBimiRecordOptions.md b/docs/GenerateBimiRecordOptions.md new file mode 100644 index 00000000..d170701d --- /dev/null +++ b/docs/GenerateBimiRecordOptions.md @@ -0,0 +1,27 @@ +# GenerateBimiRecordOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | **String** | | +**Version** | **String** | | +**LogoUrl** | **String** | | +**VmcUrl** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GenerateBimiRecordOptions = Initialize-maislurp-client-powershellGenerateBimiRecordOptions -Domain null ` + -Version null ` + -LogoUrl null ` + -VmcUrl null +``` + +- Convert the resource to JSON +```powershell +$GenerateBimiRecordOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateBimiRecordResults.md b/docs/GenerateBimiRecordResults.md new file mode 100644 index 00000000..612d6545 --- /dev/null +++ b/docs/GenerateBimiRecordResults.md @@ -0,0 +1,27 @@ +# GenerateBimiRecordResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | +**Type** | **String** | Domain Name Server Record Types | +**Ttl** | **Int32** | | +**Value** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$GenerateBimiRecordResults = Initialize-maislurp-client-powershellGenerateBimiRecordResults -Name null ` + -Type null ` + -Ttl null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$GenerateBimiRecordResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateDmarcRecordOptions.md b/docs/GenerateDmarcRecordOptions.md new file mode 100644 index 00000000..e4fd2d55 --- /dev/null +++ b/docs/GenerateDmarcRecordOptions.md @@ -0,0 +1,43 @@ +# GenerateDmarcRecordOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | **String** | | +**Version** | **String** | | +**Policy** | **String** | | +**SubdomainPolicy** | **String** | | [optional] +**ReportEmailAddress** | **String[]** | | [optional] +**ForensicEmailAddress** | **String[]** | | [optional] +**Percentage** | **Int32** | | [optional] +**ReportFormat** | **String** | | [optional] +**SecondsBetweenReports** | **Int32** | | [optional] +**Adkim** | **String** | | [optional] +**Aspf** | **String** | | [optional] +**Fo** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GenerateDmarcRecordOptions = Initialize-maislurp-client-powershellGenerateDmarcRecordOptions -Domain null ` + -Version null ` + -Policy null ` + -SubdomainPolicy null ` + -ReportEmailAddress null ` + -ForensicEmailAddress null ` + -Percentage null ` + -ReportFormat null ` + -SecondsBetweenReports null ` + -Adkim null ` + -Aspf null ` + -Fo null +``` + +- Convert the resource to JSON +```powershell +$GenerateDmarcRecordOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateDmarcRecordResults.md b/docs/GenerateDmarcRecordResults.md new file mode 100644 index 00000000..bff65052 --- /dev/null +++ b/docs/GenerateDmarcRecordResults.md @@ -0,0 +1,27 @@ +# GenerateDmarcRecordResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | +**Type** | **String** | Domain Name Server Record Types | +**Ttl** | **Int32** | | +**Value** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$GenerateDmarcRecordResults = Initialize-maislurp-client-powershellGenerateDmarcRecordResults -Name null ` + -Type null ` + -Ttl null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$GenerateDmarcRecordResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateMtaStsRecordOptions.md b/docs/GenerateMtaStsRecordOptions.md new file mode 100644 index 00000000..4249006f --- /dev/null +++ b/docs/GenerateMtaStsRecordOptions.md @@ -0,0 +1,31 @@ +# GenerateMtaStsRecordOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarHost** | **String** | | +**Version** | **String** | | +**Mode** | **String** | | +**Ttl** | **Int32** | | +**MaxAgeSeconds** | **Int32** | | +**MxRecords** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$GenerateMtaStsRecordOptions = Initialize-maislurp-client-powershellGenerateMtaStsRecordOptions -VarHost null ` + -Version null ` + -Mode null ` + -Ttl null ` + -MaxAgeSeconds null ` + -MxRecords null +``` + +- Convert the resource to JSON +```powershell +$GenerateMtaStsRecordOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateMtaStsRecordResults.md b/docs/GenerateMtaStsRecordResults.md new file mode 100644 index 00000000..4e578d33 --- /dev/null +++ b/docs/GenerateMtaStsRecordResults.md @@ -0,0 +1,31 @@ +# GenerateMtaStsRecordResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | +**Type** | **String** | Domain Name Server Record Types | +**Ttl** | **Int32** | | +**Value** | **String** | | +**WellKnownValue** | **String** | | +**WellKnownUrl** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$GenerateMtaStsRecordResults = Initialize-maislurp-client-powershellGenerateMtaStsRecordResults -Name null ` + -Type null ` + -Ttl null ` + -Value null ` + -WellKnownValue null ` + -WellKnownUrl null +``` + +- Convert the resource to JSON +```powershell +$GenerateMtaStsRecordResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateTlsReportingRecordOptions.md b/docs/GenerateTlsReportingRecordOptions.md new file mode 100644 index 00000000..05986e74 --- /dev/null +++ b/docs/GenerateTlsReportingRecordOptions.md @@ -0,0 +1,29 @@ +# GenerateTlsReportingRecordOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportingAddresses** | **String[]** | | +**ReportingUrl** | **String** | | [optional] +**VarHost** | **String** | | +**Version** | **String** | | +**Ttl** | **Int32** | | + +## Examples + +- Prepare the resource +```powershell +$GenerateTlsReportingRecordOptions = Initialize-maislurp-client-powershellGenerateTlsReportingRecordOptions -ReportingAddresses null ` + -ReportingUrl null ` + -VarHost null ` + -Version null ` + -Ttl null +``` + +- Convert the resource to JSON +```powershell +$GenerateTlsReportingRecordOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GenerateTlsReportingRecordResults.md b/docs/GenerateTlsReportingRecordResults.md new file mode 100644 index 00000000..8f6ff96d --- /dev/null +++ b/docs/GenerateTlsReportingRecordResults.md @@ -0,0 +1,27 @@ +# GenerateTlsReportingRecordResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | +**Type** | **String** | Domain Name Server Record Types | +**Ttl** | **Int32** | | +**Value** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$GenerateTlsReportingRecordResults = Initialize-maislurp-client-powershellGenerateTlsReportingRecordResults -Name null ` + -Type null ` + -Ttl null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$GenerateTlsReportingRecordResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GetEmailScreenshotOptions.md b/docs/GetEmailScreenshotOptions.md new file mode 100644 index 00000000..dc534e98 --- /dev/null +++ b/docs/GetEmailScreenshotOptions.md @@ -0,0 +1,23 @@ +# GetEmailScreenshotOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Height** | **Int32** | Window height in pixels | [optional] +**Width** | **Int32** | Window width in pixels | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetEmailScreenshotOptions = Initialize-maislurp-client-powershellGetEmailScreenshotOptions -Height null ` + -Width null +``` + +- Convert the resource to JSON +```powershell +$GetEmailScreenshotOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GravatarUrl.md b/docs/GravatarUrl.md new file mode 100644 index 00000000..d954a050 --- /dev/null +++ b/docs/GravatarUrl.md @@ -0,0 +1,23 @@ +# GravatarUrl +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | | +**Hash** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$GravatarUrl = Initialize-maislurp-client-powershellGravatarUrl -Url null ` + -Hash null +``` + +- Convert the resource to JSON +```powershell +$GravatarUrl | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GroupContactsDto.md b/docs/GroupContactsDto.md new file mode 100644 index 00000000..7d6bc663 --- /dev/null +++ b/docs/GroupContactsDto.md @@ -0,0 +1,23 @@ +# GroupContactsDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Group** | [**GroupDto**](GroupDto) | | +**Contacts** | [**ContactDto[]**](ContactDto) | | + +## Examples + +- Prepare the resource +```powershell +$GroupContactsDto = Initialize-maislurp-client-powershellGroupContactsDto -Group null ` + -Contacts null +``` + +- Convert the resource to JSON +```powershell +$GroupContactsDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GroupControllerApi.md b/docs/GroupControllerApi.md new file mode 100644 index 00000000..7552f2c6 --- /dev/null +++ b/docs/GroupControllerApi.md @@ -0,0 +1,478 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.GroupControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Add-ContactsToGroup**](GroupControllerApi#Add-ContactsToGroup) | **PUT** /groups/{groupId}/contacts | Add contacts to a group +[**New-Group**](GroupControllerApi#New-Group) | **POST** /groups | Create a group +[**Invoke-DeleteGroup**](GroupControllerApi#Invoke-DeleteGroup) | **DELETE** /groups/{groupId} | Delete group +[**Get-AllGroups**](GroupControllerApi#Get-AllGroups) | **GET** /groups/paginated | Get all Contact Groups in paginated format +[**Get-Group**](GroupControllerApi#Get-Group) | **GET** /groups/{groupId} | Get group +[**Get-GroupWithContacts**](GroupControllerApi#Get-GroupWithContacts) | **GET** /groups/{groupId}/contacts | Get group and contacts belonging to it +[**Get-GroupWithContactsPaginated**](GroupControllerApi#Get-GroupWithContactsPaginated) | **GET** /groups/{groupId}/contacts-paginated | +[**Get-Groups**](GroupControllerApi#Get-Groups) | **GET** /groups | Get all groups +[**Remove-ContactsFromGroup**](GroupControllerApi#Remove-ContactsFromGroup) | **DELETE** /groups/{groupId}/contacts | Remove contacts from a group + + + +# **Add-ContactsToGroup** +> GroupContactsDto Add-ContactsToGroup
+>         [-GroupId]
+>         [-UpdateGroupContacts]
+ +Add contacts to a group + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GroupId = "GroupId_example" # String | +$UpdateGroupContacts = (Initialize-UpdateGroupContacts -ContactIds @("ContactIds_example")) # UpdateGroupContacts | + +# Add contacts to a group +try { + $Result = Add-ContactsToGroup -GroupId $GroupId -UpdateGroupContacts $UpdateGroupContacts +} catch { + Write-Host ("Exception occured when calling Add-ContactsToGroup: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GroupId** | [**String**](String)| | + **UpdateGroupContacts** | [**UpdateGroupContacts**](UpdateGroupContacts)| | + +### Return type + +[**GroupContactsDto**](GroupContactsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-Group** +> GroupDto New-Group
+>         [-CreateGroupOptions]
+ +Create a group + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateGroupOptions = (Initialize-CreateGroupOptions -Name "Name_example" -Description "Description_example") # CreateGroupOptions | + +# Create a group +try { + $Result = New-Group -CreateGroupOptions $CreateGroupOptions +} catch { + Write-Host ("Exception occured when calling New-Group: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateGroupOptions** | [**CreateGroupOptions**](CreateGroupOptions)| | + +### Return type + +[**GroupDto**](GroupDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteGroup** +> void Invoke-DeleteGroup
+>         [-GroupId]
+ +Delete group + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GroupId = "GroupId_example" # String | + +# Delete group +try { + $Result = Invoke-DeleteGroup -GroupId $GroupId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteGroup: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GroupId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllGroups** +> PageGroupProjection Get-AllGroups
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get all Contact Groups in paginated format + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get all Contact Groups in paginated format +try { + $Result = Get-AllGroups -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllGroups: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageGroupProjection**](PageGroupProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Group** +> GroupDto Get-Group
+>         [-GroupId]
+ +Get group + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GroupId = "GroupId_example" # String | + +# Get group +try { + $Result = Get-Group -GroupId $GroupId +} catch { + Write-Host ("Exception occured when calling Get-Group: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GroupId** | [**String**](String)| | + +### Return type + +[**GroupDto**](GroupDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-GroupWithContacts** +> GroupContactsDto Get-GroupWithContacts
+>         [-GroupId]
+ +Get group and contacts belonging to it + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GroupId = "GroupId_example" # String | + +# Get group and contacts belonging to it +try { + $Result = Get-GroupWithContacts -GroupId $GroupId +} catch { + Write-Host ("Exception occured when calling Get-GroupWithContacts: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GroupId** | [**String**](String)| | + +### Return type + +[**GroupContactsDto**](GroupContactsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-GroupWithContactsPaginated** +> PageContactProjection Get-GroupWithContactsPaginated
+>         [-GroupId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ + + +Get group and paginated contacts belonging to it + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GroupId = "GroupId_example" # String | +$Page = 987 # Int32 | Optional page index in group contact pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in group contact pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-GroupWithContactsPaginated -GroupId $GroupId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-GroupWithContactsPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GroupId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in group contact pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in group contact pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageContactProjection**](PageContactProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Groups** +> GroupProjection[] Get-Groups
+ +Get all groups + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get all groups +try { + $Result = Get-Groups +} catch { + Write-Host ("Exception occured when calling Get-Groups: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**GroupProjection[]**](GroupProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Remove-ContactsFromGroup** +> GroupContactsDto Remove-ContactsFromGroup
+>         [-GroupId]
+>         [-UpdateGroupContacts]
+ +Remove contacts from a group + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GroupId = "GroupId_example" # String | +$UpdateGroupContacts = (Initialize-UpdateGroupContacts -ContactIds @("ContactIds_example")) # UpdateGroupContacts | + +# Remove contacts from a group +try { + $Result = Remove-ContactsFromGroup -GroupId $GroupId -UpdateGroupContacts $UpdateGroupContacts +} catch { + Write-Host ("Exception occured when calling Remove-ContactsFromGroup: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GroupId** | [**String**](String)| | + **UpdateGroupContacts** | [**UpdateGroupContacts**](UpdateGroupContacts)| | + +### Return type + +[**GroupContactsDto**](GroupContactsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/GroupDto.md b/docs/GroupDto.md new file mode 100644 index 00000000..65e8e882 --- /dev/null +++ b/docs/GroupDto.md @@ -0,0 +1,27 @@ +# GroupDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**Name** | **String** | | +**Description** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$GroupDto = Initialize-maislurp-client-powershellGroupDto -Id null ` + -Name null ` + -Description null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$GroupDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/GroupProjection.md b/docs/GroupProjection.md new file mode 100644 index 00000000..5e1763f0 --- /dev/null +++ b/docs/GroupProjection.md @@ -0,0 +1,27 @@ +# GroupProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **System.DateTime** | | +**Name** | **String** | | +**Id** | **String** | | +**Description** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GroupProjection = Initialize-maislurp-client-powershellGroupProjection -CreatedAt null ` + -Name null ` + -Id null ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$GroupProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/HTMLValidationResult.md b/docs/HTMLValidationResult.md new file mode 100644 index 00000000..a2f8b1bd --- /dev/null +++ b/docs/HTMLValidationResult.md @@ -0,0 +1,27 @@ +# HTMLValidationResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | **Boolean** | Is HTML validation result valid | +**Infos** | [**ValidationMessage[]**](ValidationMessage) | Optional infos resulting from HTML validation | +**Errors** | [**ValidationMessage[]**](ValidationMessage) | Optional errors resulting from HTML validation | +**Warnings** | [**ValidationMessage[]**](ValidationMessage) | Optional warnings resulting from HTML validation | + +## Examples + +- Prepare the resource +```powershell +$HTMLValidationResult = Initialize-maislurp-client-powershellHTMLValidationResult -IsValid null ` + -Infos null ` + -Errors null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$HTMLValidationResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/IPAddressResult.md b/docs/IPAddressResult.md new file mode 100644 index 00000000..efe7eae9 --- /dev/null +++ b/docs/IPAddressResult.md @@ -0,0 +1,23 @@ +# IPAddressResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Address** | **String** | | +**Hostname** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$IPAddressResult = Initialize-maislurp-client-powershellIPAddressResult -Address null ` + -Hostname null +``` + +- Convert the resource to JSON +```powershell +$IPAddressResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImageIssue.md b/docs/ImageIssue.md new file mode 100644 index 00000000..1c2ddd77 --- /dev/null +++ b/docs/ImageIssue.md @@ -0,0 +1,27 @@ +# ImageIssue +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | | +**ResponseStatus** | **Int32** | | [optional] +**Severity** | **String** | | +**Message** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ImageIssue = Initialize-maislurp-client-powershellImageIssue -Url null ` + -ResponseStatus null ` + -Severity null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$ImageIssue | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapAccessDetails.md b/docs/ImapAccessDetails.md new file mode 100644 index 00000000..3d22c6d0 --- /dev/null +++ b/docs/ImapAccessDetails.md @@ -0,0 +1,37 @@ +# ImapAccessDetails +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SecureImapServerHost** | **String** | Secure TLS IMAP server host domain | +**SecureImapServerPort** | **Int32** | Secure TLS IMAP server host port | +**SecureImapUsername** | **String** | Secure TLS IMAP username for login | +**SecureImapPassword** | **String** | Secure TLS IMAP password for login | +**ImapServerHost** | **String** | IMAP server host domain | +**ImapServerPort** | **Int32** | IMAP server host port | +**ImapUsername** | **String** | IMAP username for login | +**ImapPassword** | **String** | IMAP password for login | +**ImapMailbox** | **String** | IMAP mailbox to SELECT | + +## Examples + +- Prepare the resource +```powershell +$ImapAccessDetails = Initialize-maislurp-client-powershellImapAccessDetails -SecureImapServerHost null ` + -SecureImapServerPort null ` + -SecureImapUsername null ` + -SecureImapPassword null ` + -ImapServerHost null ` + -ImapServerPort null ` + -ImapUsername null ` + -ImapPassword null ` + -ImapMailbox null +``` + +- Convert the resource to JSON +```powershell +$ImapAccessDetails | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapControllerApi.md b/docs/ImapControllerApi.md new file mode 100644 index 00000000..7a4e4496 --- /dev/null +++ b/docs/ImapControllerApi.md @@ -0,0 +1,321 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.ImapControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-ImapServerFetch**](ImapControllerApi#Invoke-ImapServerFetch) | **POST** /imap/server/fetch | Fetch message in an inbox +[**Invoke-ImapServerGet**](ImapControllerApi#Invoke-ImapServerGet) | **POST** /imap/server/get | Get a message by email ID +[**Invoke-ImapServerList**](ImapControllerApi#Invoke-ImapServerList) | **POST** /imap/server/list | List messages in an inbox +[**Invoke-ImapServerSearch**](ImapControllerApi#Invoke-ImapServerSearch) | **POST** /imap/server/search | Search messages in an inbox +[**Invoke-ImapServerStatus**](ImapControllerApi#Invoke-ImapServerStatus) | **POST** /imap/server/status | Get status for mailbox +[**Invoke-ImapServerUpdateFlags**](ImapControllerApi#Invoke-ImapServerUpdateFlags) | **POST** /imap/server/update-flags | + + + +# **Invoke-ImapServerFetch** +> ImapServerFetchResult Invoke-ImapServerFetch
+>         [-SeqNum]
+>         [-InboxId]
+ +Fetch message in an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SeqNum = 987 # Int64 | +$InboxId = "InboxId_example" # String | Inbox ID to search (optional) + +# Fetch message in an inbox +try { + $Result = Invoke-ImapServerFetch -SeqNum $SeqNum -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-ImapServerFetch: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SeqNum** | **Int64**| | + **InboxId** | [**String**](String)| Inbox ID to search | [optional] + +### Return type + +[**ImapServerFetchResult**](ImapServerFetchResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ImapServerGet** +> ImapServerGetResult Invoke-ImapServerGet
+>         [-EmailId]
+>         [-InboxId]
+ +Get a message by email ID + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | Email ID to get +$InboxId = "InboxId_example" # String | Inbox ID to search (optional) + +# Get a message by email ID +try { + $Result = Invoke-ImapServerGet -EmailId $EmailId -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-ImapServerGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| Email ID to get | + **InboxId** | [**String**](String)| Inbox ID to search | [optional] + +### Return type + +[**ImapServerGetResult**](ImapServerGetResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ImapServerList** +> ImapServerListResult Invoke-ImapServerList
+>         [-ImapServerListOptions]
+>         [-InboxId]
+ +List messages in an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ImapServerListOptions = (Initialize-ImapServerListOptions -UidSet "UidSet_example" -SeqSet "SeqSet_example") # ImapServerListOptions | +$InboxId = "InboxId_example" # String | Inbox ID to list (optional) + +# List messages in an inbox +try { + $Result = Invoke-ImapServerList -ImapServerListOptions $ImapServerListOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-ImapServerList: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ImapServerListOptions** | [**ImapServerListOptions**](ImapServerListOptions)| | + **InboxId** | [**String**](String)| Inbox ID to list | [optional] + +### Return type + +[**ImapServerListResult**](ImapServerListResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ImapServerSearch** +> ImapServerSearchResult Invoke-ImapServerSearch
+>         [-ImapServerSearchOptions]
+>         [-InboxId]
+ +Search messages in an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ImapServerSearchOptions = (Initialize-ImapServerSearchOptions -SeqNum "SeqNum_example" -Uid "Uid_example" -Since Get-Date -Before Get-Date -SentSince Get-Date -SentBefore Get-Date -Header "TODO" -Body @("Body_example") -Text @("Text_example") -WithFlags @("WithFlags_example") -WithoutFlags @("WithoutFlags_example")) # ImapServerSearchOptions | +$InboxId = "InboxId_example" # String | Inbox ID to search (optional) + +# Search messages in an inbox +try { + $Result = Invoke-ImapServerSearch -ImapServerSearchOptions $ImapServerSearchOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-ImapServerSearch: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ImapServerSearchOptions** | [**ImapServerSearchOptions**](ImapServerSearchOptions)| | + **InboxId** | [**String**](String)| Inbox ID to search | [optional] + +### Return type + +[**ImapServerSearchResult**](ImapServerSearchResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ImapServerStatus** +> ImapServerStatusResult Invoke-ImapServerStatus
+>         [-ImapServerStatusOptions]
+>         [-InboxId]
+ +Get status for mailbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ImapServerStatusOptions = (Initialize-ImapServerStatusOptions -Name "Name_example" -StatusItems @("MESSAGES")) # ImapServerStatusOptions | +$InboxId = "InboxId_example" # String | Inbox ID to list (optional) + +# Get status for mailbox +try { + $Result = Invoke-ImapServerStatus -ImapServerStatusOptions $ImapServerStatusOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-ImapServerStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ImapServerStatusOptions** | [**ImapServerStatusOptions**](ImapServerStatusOptions)| | + **InboxId** | [**String**](String)| Inbox ID to list | [optional] + +### Return type + +[**ImapServerStatusResult**](ImapServerStatusResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ImapServerUpdateFlags** +> void Invoke-ImapServerUpdateFlags
+>         [-ImapUpdateFlagsOptions]
+>         [-InboxId]
+ + + +Update message flags + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$ImapUpdateFlagsOptions = (Initialize-ImapUpdateFlagsOptions -Operation "Operation_example" -Flags @("Flags_example") -UidSet "UidSet_example" -SeqSet "SeqSet_example") # ImapUpdateFlagsOptions | +$InboxId = "InboxId_example" # String | (optional) + +try { + $Result = Invoke-ImapServerUpdateFlags -ImapUpdateFlagsOptions $ImapUpdateFlagsOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-ImapServerUpdateFlags: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ImapUpdateFlagsOptions** | [**ImapUpdateFlagsOptions**](ImapUpdateFlagsOptions)| | + **InboxId** | [**String**](String)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/ImapEmailProjection.md b/docs/ImapEmailProjection.md new file mode 100644 index 00000000..16f2f1a3 --- /dev/null +++ b/docs/ImapEmailProjection.md @@ -0,0 +1,29 @@ +# ImapEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Read** | **Boolean** | | [optional] +**Uid** | **Int64** | | +**SeqNum** | **Int64** | | +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ImapEmailProjection = Initialize-maislurp-client-powershellImapEmailProjection -Read null ` + -Uid null ` + -SeqNum null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ImapEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapFlagOperationOptions.md b/docs/ImapFlagOperationOptions.md new file mode 100644 index 00000000..3540ad49 --- /dev/null +++ b/docs/ImapFlagOperationOptions.md @@ -0,0 +1,23 @@ +# ImapFlagOperationOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FlagOperation** | **String** | | +**Flags** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$ImapFlagOperationOptions = Initialize-maislurp-client-powershellImapFlagOperationOptions -FlagOperation null ` + -Flags null +``` + +- Convert the resource to JSON +```powershell +$ImapFlagOperationOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapMailboxStatus.md b/docs/ImapMailboxStatus.md new file mode 100644 index 00000000..3ef48113 --- /dev/null +++ b/docs/ImapMailboxStatus.md @@ -0,0 +1,43 @@ +# ImapMailboxStatus +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The mailbox name. | +**ReadOnly** | **Boolean** | True if the mailbox is open in read-only mode. | +**Items** | [**SystemCollectionsHashtable**]() | Results map | +**Flags** | **String[]** | The mailbox flags. | +**PermanentFlags** | **String[]** | The mailbox permanent flags. | +**UnseenSeqNum** | **Int64** | The sequence number of the first unseen message in the mailbox. | +**Messages** | **Int32** | The number of messages in this mailbox. | +**Recent** | **Int32** | The number of messages not seen since the last time the mailbox was opened. | +**Unseen** | **Int32** | The number of unread messages. | +**UidNext** | **Int64** | The next UID. | +**UidValidity** | **Int32** | Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1. | +**AppendLimit** | **Int32** | Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapMailboxStatus = Initialize-maislurp-client-powershellImapMailboxStatus -Name null ` + -ReadOnly null ` + -Items null ` + -Flags null ` + -PermanentFlags null ` + -UnseenSeqNum null ` + -Messages null ` + -Recent null ` + -Unseen null ` + -UidNext null ` + -UidValidity null ` + -AppendLimit null +``` + +- Convert the resource to JSON +```powershell +$ImapMailboxStatus | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerFetchItem.md b/docs/ImapServerFetchItem.md new file mode 100644 index 00000000..8527c040 --- /dev/null +++ b/docs/ImapServerFetchItem.md @@ -0,0 +1,29 @@ +# ImapServerFetchItem +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | **String** | Content of the email | +**Id** | **String** | ID of the email | +**Uid** | **Int64** | UID of the email | +**SeqNum** | **Int64** | Sequence number of the email | +**Read** | **Boolean** | Read status of the email | + +## Examples + +- Prepare the resource +```powershell +$ImapServerFetchItem = Initialize-maislurp-client-powershellImapServerFetchItem -Content null ` + -Id null ` + -Uid null ` + -SeqNum null ` + -Read null +``` + +- Convert the resource to JSON +```powershell +$ImapServerFetchItem | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerFetchResult.md b/docs/ImapServerFetchResult.md new file mode 100644 index 00000000..5a1ce493 --- /dev/null +++ b/docs/ImapServerFetchResult.md @@ -0,0 +1,21 @@ +# ImapServerFetchResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Result** | [**ImapServerFetchItem**](ImapServerFetchItem) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapServerFetchResult = Initialize-maislurp-client-powershellImapServerFetchResult -Result null +``` + +- Convert the resource to JSON +```powershell +$ImapServerFetchResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerGetResult.md b/docs/ImapServerGetResult.md new file mode 100644 index 00000000..258f52da --- /dev/null +++ b/docs/ImapServerGetResult.md @@ -0,0 +1,21 @@ +# ImapServerGetResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Result** | [**ImapEmailProjection**](ImapEmailProjection) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapServerGetResult = Initialize-maislurp-client-powershellImapServerGetResult -Result null +``` + +- Convert the resource to JSON +```powershell +$ImapServerGetResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerListOptions.md b/docs/ImapServerListOptions.md new file mode 100644 index 00000000..42c9e06a --- /dev/null +++ b/docs/ImapServerListOptions.md @@ -0,0 +1,23 @@ +# ImapServerListOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UidSet** | **String** | | [optional] +**SeqSet** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapServerListOptions = Initialize-maislurp-client-powershellImapServerListOptions -UidSet null ` + -SeqSet null +``` + +- Convert the resource to JSON +```powershell +$ImapServerListOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerListResult.md b/docs/ImapServerListResult.md new file mode 100644 index 00000000..57f5279f --- /dev/null +++ b/docs/ImapServerListResult.md @@ -0,0 +1,21 @@ +# ImapServerListResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**ImapEmailProjection[]**](ImapEmailProjection) | | + +## Examples + +- Prepare the resource +```powershell +$ImapServerListResult = Initialize-maislurp-client-powershellImapServerListResult -Results null +``` + +- Convert the resource to JSON +```powershell +$ImapServerListResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerSearchOptions.md b/docs/ImapServerSearchOptions.md new file mode 100644 index 00000000..3d89fa9c --- /dev/null +++ b/docs/ImapServerSearchOptions.md @@ -0,0 +1,41 @@ +# ImapServerSearchOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SeqNum** | **String** | | [optional] +**Uid** | **String** | | [optional] +**Since** | **System.DateTime** | | [optional] +**Before** | **System.DateTime** | | [optional] +**SentSince** | **System.DateTime** | | [optional] +**SentBefore** | **System.DateTime** | | [optional] +**Header** | [**System.Collections.Hashtable**](Array) | | [optional] +**Body** | **String[]** | | [optional] +**Text** | **String[]** | | [optional] +**WithFlags** | **String[]** | | [optional] +**WithoutFlags** | **String[]** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapServerSearchOptions = Initialize-maislurp-client-powershellImapServerSearchOptions -SeqNum null ` + -Uid null ` + -Since null ` + -Before null ` + -SentSince null ` + -SentBefore null ` + -Header null ` + -Body null ` + -Text null ` + -WithFlags null ` + -WithoutFlags null +``` + +- Convert the resource to JSON +```powershell +$ImapServerSearchOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerSearchResult.md b/docs/ImapServerSearchResult.md new file mode 100644 index 00000000..13fe98ef --- /dev/null +++ b/docs/ImapServerSearchResult.md @@ -0,0 +1,21 @@ +# ImapServerSearchResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**ImapEmailProjection[]**](ImapEmailProjection) | | + +## Examples + +- Prepare the resource +```powershell +$ImapServerSearchResult = Initialize-maislurp-client-powershellImapServerSearchResult -Results null +``` + +- Convert the resource to JSON +```powershell +$ImapServerSearchResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerStatusOptions.md b/docs/ImapServerStatusOptions.md new file mode 100644 index 00000000..e0315c1c --- /dev/null +++ b/docs/ImapServerStatusOptions.md @@ -0,0 +1,23 @@ +# ImapServerStatusOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | | [optional] +**StatusItems** | **String[]** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapServerStatusOptions = Initialize-maislurp-client-powershellImapServerStatusOptions -Name null ` + -StatusItems null +``` + +- Convert the resource to JSON +```powershell +$ImapServerStatusOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapServerStatusResult.md b/docs/ImapServerStatusResult.md new file mode 100644 index 00000000..2c99fac7 --- /dev/null +++ b/docs/ImapServerStatusResult.md @@ -0,0 +1,21 @@ +# ImapServerStatusResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Result** | [**ImapMailboxStatus**](ImapMailboxStatus) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapServerStatusResult = Initialize-maislurp-client-powershellImapServerStatusResult -Result null +``` + +- Convert the resource to JSON +```powershell +$ImapServerStatusResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapSmtpAccessDetails.md b/docs/ImapSmtpAccessDetails.md new file mode 100644 index 00000000..d47221fa --- /dev/null +++ b/docs/ImapSmtpAccessDetails.md @@ -0,0 +1,55 @@ +# ImapSmtpAccessDetails +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SecureSmtpServerHost** | **String** | Secure TLS SMTP server host domain | +**SecureSmtpServerPort** | **Int32** | Secure TLS SMTP server host port | +**SecureSmtpUsername** | **String** | Secure TLS SMTP username for login | +**SecureSmtpPassword** | **String** | Secure TLS SMTP password for login | +**SmtpServerHost** | **String** | SMTP server host domain | +**SmtpServerPort** | **Int32** | SMTP server host port | +**SmtpUsername** | **String** | SMTP username for login | +**SmtpPassword** | **String** | SMTP password for login | +**SecureImapServerHost** | **String** | Secure TLS IMAP server host domain | +**SecureImapServerPort** | **Int32** | Secure TLS IMAP server host port | +**SecureImapUsername** | **String** | Secure TLS IMAP username for login | +**SecureImapPassword** | **String** | Secure TLS IMAP password for login | +**ImapServerHost** | **String** | IMAP server host domain | +**ImapServerPort** | **Int32** | IMAP server host port | +**ImapUsername** | **String** | IMAP username for login | +**ImapPassword** | **String** | IMAP password for login | +**ImapMailbox** | **String** | IMAP mailbox to SELECT | +**MailFromDomain** | **String** | Mail from domain or SMTP HELO value | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapSmtpAccessDetails = Initialize-maislurp-client-powershellImapSmtpAccessDetails -SecureSmtpServerHost null ` + -SecureSmtpServerPort null ` + -SecureSmtpUsername null ` + -SecureSmtpPassword null ` + -SmtpServerHost null ` + -SmtpServerPort null ` + -SmtpUsername null ` + -SmtpPassword null ` + -SecureImapServerHost null ` + -SecureImapServerPort null ` + -SecureImapUsername null ` + -SecureImapPassword null ` + -ImapServerHost null ` + -ImapServerPort null ` + -ImapUsername null ` + -ImapPassword null ` + -ImapMailbox null ` + -MailFromDomain null +``` + +- Convert the resource to JSON +```powershell +$ImapSmtpAccessDetails | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapSmtpAccessServers.md b/docs/ImapSmtpAccessServers.md new file mode 100644 index 00000000..6bcc5c17 --- /dev/null +++ b/docs/ImapSmtpAccessServers.md @@ -0,0 +1,27 @@ +# ImapSmtpAccessServers +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ImapServer** | [**ServerEndpoints**](ServerEndpoints) | | +**SecureImapServer** | [**ServerEndpoints**](ServerEndpoints) | | +**SmtpServer** | [**ServerEndpoints**](ServerEndpoints) | | +**SecureSmtpServer** | [**ServerEndpoints**](ServerEndpoints) | | + +## Examples + +- Prepare the resource +```powershell +$ImapSmtpAccessServers = Initialize-maislurp-client-powershellImapSmtpAccessServers -ImapServer null ` + -SecureImapServer null ` + -SmtpServer null ` + -SecureSmtpServer null +``` + +- Convert the resource to JSON +```powershell +$ImapSmtpAccessServers | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ImapUpdateFlagsOptions.md b/docs/ImapUpdateFlagsOptions.md new file mode 100644 index 00000000..85326d69 --- /dev/null +++ b/docs/ImapUpdateFlagsOptions.md @@ -0,0 +1,27 @@ +# ImapUpdateFlagsOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | **String** | | +**Flags** | **String[]** | | [optional] +**UidSet** | **String** | | [optional] +**SeqSet** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImapUpdateFlagsOptions = Initialize-maislurp-client-powershellImapUpdateFlagsOptions -Operation null ` + -Flags null ` + -UidSet null ` + -SeqSet null +``` + +- Convert the resource to JSON +```powershell +$ImapUpdateFlagsOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxByEmailAddressResult.md b/docs/InboxByEmailAddressResult.md new file mode 100644 index 00000000..eb2443a7 --- /dev/null +++ b/docs/InboxByEmailAddressResult.md @@ -0,0 +1,23 @@ +# InboxByEmailAddressResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | | [optional] +**Exists** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$InboxByEmailAddressResult = Initialize-maislurp-client-powershellInboxByEmailAddressResult -InboxId null ` + -Exists null +``` + +- Convert the resource to JSON +```powershell +$InboxByEmailAddressResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxByNameResult.md b/docs/InboxByNameResult.md new file mode 100644 index 00000000..138b1b1c --- /dev/null +++ b/docs/InboxByNameResult.md @@ -0,0 +1,23 @@ +# InboxByNameResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | | [optional] +**Exists** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$InboxByNameResult = Initialize-maislurp-client-powershellInboxByNameResult -InboxId null ` + -Exists null +``` + +- Convert the resource to JSON +```powershell +$InboxByNameResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxControllerApi.md b/docs/InboxControllerApi.md new file mode 100644 index 00000000..cb23e483 --- /dev/null +++ b/docs/InboxControllerApi.md @@ -0,0 +1,2835 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.InboxControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Stop-ScheduledJob**](InboxControllerApi#Stop-ScheduledJob) | **DELETE** /inboxes/scheduled-jobs/{jobId} | Cancel a scheduled email job +[**New-Inbox**](InboxControllerApi#New-Inbox) | **POST** /inboxes | Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. +[**New-InboxRuleset**](InboxControllerApi#New-InboxRuleset) | **POST** /inboxes/{inboxId}/rulesets | Create an inbox ruleset +[**New-InboxWithDefaults**](InboxControllerApi#New-InboxWithDefaults) | **POST** /inboxes/withDefaults | Create an inbox with default options. Uses MailSlurp domain pool address and is private. +[**New-InboxWithOptions**](InboxControllerApi#New-InboxWithOptions) | **POST** /inboxes/withOptions | Create an inbox with options. Extended options for inbox creation. +[**Invoke-DeleteAllInboxEmails**](InboxControllerApi#Invoke-DeleteAllInboxEmails) | **DELETE** /inboxes/{inboxId}/deleteAllInboxEmails | Delete all emails in a given inboxes. +[**Invoke-DeleteAllInboxes**](InboxControllerApi#Invoke-DeleteAllInboxes) | **DELETE** /inboxes | Delete all inboxes +[**Invoke-DeleteAllInboxesByDescription**](InboxControllerApi#Invoke-DeleteAllInboxesByDescription) | **DELETE** /inboxes/by-description | Delete inboxes by description +[**Invoke-DeleteAllInboxesByName**](InboxControllerApi#Invoke-DeleteAllInboxesByName) | **DELETE** /inboxes/by-name | Delete inboxes by name +[**Invoke-DeleteAllInboxesByTag**](InboxControllerApi#Invoke-DeleteAllInboxesByTag) | **DELETE** /inboxes/by-tag | Delete inboxes by tag +[**Invoke-DeleteInbox**](InboxControllerApi#Invoke-DeleteInbox) | **DELETE** /inboxes/{inboxId} | Delete inbox +[**Invoke-DoesInboxExist**](InboxControllerApi#Invoke-DoesInboxExist) | **GET** /inboxes/exists | Does inbox exist +[**Clear-Expired**](InboxControllerApi#Clear-Expired) | **DELETE** /inboxes/expired | Remove expired inboxes +[**Get-AllInboxes**](InboxControllerApi#Get-AllInboxes) | **GET** /inboxes/paginated | List All Inboxes Paginated +[**Get-AllInboxesOffsetPaginated**](InboxControllerApi#Get-AllInboxesOffsetPaginated) | **GET** /inboxes/offset-paginated | List All Inboxes Offset Paginated +[**Get-AllScheduledJobs**](InboxControllerApi#Get-AllScheduledJobs) | **GET** /inboxes/scheduled-jobs | Get all scheduled email sending jobs for account +[**Get-DeliveryStatusesByInboxId**](InboxControllerApi#Get-DeliveryStatusesByInboxId) | **GET** /inboxes/{inboxId}/delivery-status | +[**Get-Emails**](InboxControllerApi#Get-Emails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. +[**Get-ImapAccess**](InboxControllerApi#Get-ImapAccess) | **GET** /inboxes/imap-access | +[**Get-ImapSmtpAccess**](InboxControllerApi#Get-ImapSmtpAccess) | **GET** /inboxes/imap-smtp-access | +[**Get-ImapSmtpAccessEnv**](InboxControllerApi#Get-ImapSmtpAccessEnv) | **GET** /inboxes/imap-smtp-access/env | +[**Get-ImapSmtpAccessServers**](InboxControllerApi#Get-ImapSmtpAccessServers) | **GET** /inboxes/imap-smtp-access/servers | +[**Get-Inbox**](InboxControllerApi#Get-Inbox) | **GET** /inboxes/{inboxId} | Get Inbox. Returns properties of an inbox. +[**Get-InboxByEmailAddress**](InboxControllerApi#Get-InboxByEmailAddress) | **GET** /inboxes/byEmailAddress | Search for an inbox with the provided email address +[**Get-InboxByName**](InboxControllerApi#Get-InboxByName) | **GET** /inboxes/byName | Search for an inbox with the given name +[**Get-InboxCount**](InboxControllerApi#Get-InboxCount) | **GET** /inboxes/count | Get total inbox count +[**Get-InboxEmailCount**](InboxControllerApi#Get-InboxEmailCount) | **GET** /inboxes/{inboxId}/emails/count | Get email count in inbox +[**Get-InboxEmailsPaginated**](InboxControllerApi#Get-InboxEmailsPaginated) | **GET** /inboxes/{inboxId}/emails/paginated | Get inbox emails paginated +[**Get-InboxIds**](InboxControllerApi#Get-InboxIds) | **GET** /inboxes/ids | Get all inbox IDs +[**Get-InboxSentEmails**](InboxControllerApi#Get-InboxSentEmails) | **GET** /inboxes/{inboxId}/sent | Get Inbox Sent Emails +[**Get-InboxTags**](InboxControllerApi#Get-InboxTags) | **GET** /inboxes/tags | Get inbox tags +[**Get-Inboxes**](InboxControllerApi#Get-Inboxes) | **GET** /inboxes | List Inboxes and email addresses +[**Get-LatestEmailInInbox**](InboxControllerApi#Get-LatestEmailInInbox) | **GET** /inboxes/getLatestEmail | Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. +[**Get-OrganizationInboxes**](InboxControllerApi#Get-OrganizationInboxes) | **GET** /inboxes/organization | List Organization Inboxes Paginated +[**Get-ScheduledJob**](InboxControllerApi#Get-ScheduledJob) | **GET** /inboxes/scheduled-jobs/{jobId} | Get a scheduled email job +[**Get-ScheduledJobsByInboxId**](InboxControllerApi#Get-ScheduledJobsByInboxId) | **GET** /inboxes/{inboxId}/scheduled-jobs | Get all scheduled email sending jobs for the inbox +[**Get-SmtpAccess**](InboxControllerApi#Get-SmtpAccess) | **GET** /inboxes/smtp-access | +[**Invoke-ListInboxRulesets**](InboxControllerApi#Invoke-ListInboxRulesets) | **GET** /inboxes/{inboxId}/rulesets | List inbox rulesets +[**Invoke-ListInboxTrackingPixels**](InboxControllerApi#Invoke-ListInboxTrackingPixels) | **GET** /inboxes/{inboxId}/tracking-pixels | List inbox tracking pixels +[**Search-Inboxes**](InboxControllerApi#Search-Inboxes) | **POST** /inboxes/search | Search all inboxes and return matching inboxes +[**Send-Email**](InboxControllerApi#Send-Email) | **POST** /inboxes/{inboxId} | Send Email +[**Send-EmailAndConfirm**](InboxControllerApi#Send-EmailAndConfirm) | **POST** /inboxes/{inboxId}/confirm | Send email and return sent confirmation +[**Send-EmailWithQueue**](InboxControllerApi#Send-EmailWithQueue) | **POST** /inboxes/{inboxId}/with-queue | Send email with queue +[**Send-SmtpEnvelope**](InboxControllerApi#Send-SmtpEnvelope) | **POST** /inboxes/{inboxId}/smtp-envelope | Send email using an SMTP mail envelope and message body and return sent confirmation +[**Send-TestEmail**](InboxControllerApi#Send-TestEmail) | **POST** /inboxes/{inboxId}/send-test-email | Send a test email to inbox +[**Send-WithSchedule**](InboxControllerApi#Send-WithSchedule) | **POST** /inboxes/{inboxId}/with-schedule | Send email with with delay or schedule +[**Set-InboxFavourited**](InboxControllerApi#Set-InboxFavourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state +[**Update-ImapAccess**](InboxControllerApi#Update-ImapAccess) | **PATCH** /inboxes/imap-access | +[**Update-Inbox**](InboxControllerApi#Update-Inbox) | **PATCH** /inboxes/{inboxId} | Update Inbox. Change name and description. Email address is not editable. +[**Update-SmtpAccess**](InboxControllerApi#Update-SmtpAccess) | **PATCH** /inboxes/smtp-access | + + + +# **Stop-ScheduledJob** +> ScheduledJobDto Stop-ScheduledJob
+>         [-JobId]
+ +Cancel a scheduled email job + +Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$JobId = "JobId_example" # String | + +# Cancel a scheduled email job +try { + $Result = Stop-ScheduledJob -JobId $JobId +} catch { + Write-Host ("Exception occured when calling Stop-ScheduledJob: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **JobId** | [**String**](String)| | + +### Return type + +[**ScheduledJobDto**](ScheduledJobDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-Inbox** +> InboxDto New-Inbox
+>         [-EmailAddress]
+>         [-Tags]
+>         [-Name]
+>         [-Description]
+>         [-UseDomainPool]
+>         [-Favourite]
+>         [-ExpiresAt]
+>         [-ExpiresIn]
+>         [-AllowTeamAccess]
+>         [-InboxType]
+>         [-VirtualInbox]
+>         [-UseShortAddress]
+>         [-DomainId]
+>         [-DomainName]
+>         [-Prefix]
+ +Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. + +Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailAddress = "EmailAddress_example" # String | A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional) +$Tags = @("Inner_example") # String[] | Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional) +$Name = "Name_example" # String | Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional) +$Description = "Description_example" # String | Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional) +$UseDomainPool = true # Boolean | Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional) +$Favourite = true # Boolean | Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional) +$ExpiresAt = Get-Date # System.DateTime | Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional) +$ExpiresIn = 987 # Int64 | Number of milliseconds that inbox should exist for (optional) +$AllowTeamAccess = true # Boolean | DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional) +$InboxType = "HTTP_INBOX" # String | HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional) +$VirtualInbox = true # Boolean | Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional) +$UseShortAddress = true # Boolean | Use a shorter email address under 31 characters (optional) +$DomainId = "DomainId_example" # String | ID of custom domain to use for email address. (optional) +$DomainName = "DomainName_example" # String | FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional) +$Prefix = "Prefix_example" # String | Prefix to add before the email address for easier labelling or identification. (optional) + +# Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. +try { + $Result = New-Inbox -EmailAddress $EmailAddress -Tags $Tags -Name $Name -Description $Description -UseDomainPool $UseDomainPool -Favourite $Favourite -ExpiresAt $ExpiresAt -ExpiresIn $ExpiresIn -AllowTeamAccess $AllowTeamAccess -InboxType $InboxType -VirtualInbox $VirtualInbox -UseShortAddress $UseShortAddress -DomainId $DomainId -DomainName $DomainName -Prefix $Prefix +} catch { + Write-Host ("Exception occured when calling New-Inbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailAddress** | **String**| A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. | [optional] + **Tags** | [**String[]**](String)| Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. | [optional] + **Name** | **String**| Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. | [optional] + **Description** | **String**| Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with | [optional] + **UseDomainPool** | **Boolean**| Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. | [optional] + **Favourite** | **Boolean**| Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering | [optional] + **ExpiresAt** | **System.DateTime**| Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. | [optional] + **ExpiresIn** | **Int64**| Number of milliseconds that inbox should exist for | [optional] + **AllowTeamAccess** | **Boolean**| DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. | [optional] + **InboxType** | **String**| HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. | [optional] + **VirtualInbox** | **Boolean**| Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. | [optional] + **UseShortAddress** | **Boolean**| Use a shorter email address under 31 characters | [optional] + **DomainId** | [**String**](String)| ID of custom domain to use for email address. | [optional] + **DomainName** | **String**| FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. | [optional] + **Prefix** | **String**| Prefix to add before the email address for easier labelling or identification. | [optional] + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-InboxRuleset** +> InboxRulesetDto New-InboxRuleset
+>         [-InboxId]
+>         [-CreateInboxRulesetOptions]
+ +Create an inbox ruleset + +Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | inboxId +$CreateInboxRulesetOptions = (Initialize-CreateInboxRulesetOptions -Scope "RECEIVING_EMAILS" -Action "BLOCK" -Target "Target_example") # CreateInboxRulesetOptions | + +# Create an inbox ruleset +try { + $Result = New-InboxRuleset -InboxId $InboxId -CreateInboxRulesetOptions $CreateInboxRulesetOptions +} catch { + Write-Host ("Exception occured when calling New-InboxRuleset: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| inboxId | + **CreateInboxRulesetOptions** | [**CreateInboxRulesetOptions**](CreateInboxRulesetOptions)| | + +### Return type + +[**InboxRulesetDto**](InboxRulesetDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-InboxWithDefaults** +> InboxDto New-InboxWithDefaults
+ +Create an inbox with default options. Uses MailSlurp domain pool address and is private. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Create an inbox with default options. Uses MailSlurp domain pool address and is private. +try { + $Result = New-InboxWithDefaults +} catch { + Write-Host ("Exception occured when calling New-InboxWithDefaults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-InboxWithOptions** +> InboxDto New-InboxWithOptions
+>         [-CreateInboxDto]
+ +Create an inbox with options. Extended options for inbox creation. + +Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateInboxDto = (Initialize-CreateInboxDto -EmailAddress "EmailAddress_example" -DomainName "DomainName_example" -DomainId "DomainId_example" -Name "Name_example" -Description "Description_example" -UseDomainPool $false -Tags @("Tags_example") -ExpiresAt Get-Date -Favourite $false -ExpiresIn 123 -AllowTeamAccess $false -InboxType "HTTP_INBOX" -VirtualInbox $false -UseShortAddress $false -Prefix "Prefix_example") # CreateInboxDto | + +# Create an inbox with options. Extended options for inbox creation. +try { + $Result = New-InboxWithOptions -CreateInboxDto $CreateInboxDto +} catch { + Write-Host ("Exception occured when calling New-InboxWithOptions: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateInboxDto** | [**CreateInboxDto**](CreateInboxDto)| | + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllInboxEmails** +> void Invoke-DeleteAllInboxEmails
+>         [-InboxId]
+ +Delete all emails in a given inboxes. + +Deletes all emails in an inbox. Be careful as emails cannot be recovered + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Delete all emails in a given inboxes. +try { + $Result = Invoke-DeleteAllInboxEmails -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllInboxEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllInboxes** +> void Invoke-DeleteAllInboxes
+ +Delete all inboxes + +Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Delete all inboxes +try { + $Result = Invoke-DeleteAllInboxes +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllInboxesByDescription** +> void Invoke-DeleteAllInboxesByDescription
+>         [-Description]
+ +Delete inboxes by description + +Permanently delete all inboxes by description + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Description = "Description_example" # String | + +# Delete inboxes by description +try { + $Result = Invoke-DeleteAllInboxesByDescription -Description $Description +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllInboxesByDescription: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Description** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllInboxesByName** +> void Invoke-DeleteAllInboxesByName
+>         [-Name]
+ +Delete inboxes by name + +Permanently delete all inboxes by name + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Name = "Name_example" # String | + +# Delete inboxes by name +try { + $Result = Invoke-DeleteAllInboxesByName -Name $Name +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllInboxesByName: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Name** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllInboxesByTag** +> void Invoke-DeleteAllInboxesByTag
+>         [-Tag]
+ +Delete inboxes by tag + +Permanently delete all inboxes by tag + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Tag = "Tag_example" # String | + +# Delete inboxes by tag +try { + $Result = Invoke-DeleteAllInboxesByTag -Tag $Tag +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllInboxesByTag: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Tag** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInbox** +> void Invoke-DeleteInbox
+>         [-InboxId]
+ +Delete inbox + +Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Delete inbox +try { + $Result = Invoke-DeleteInbox -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DoesInboxExist** +> InboxExistsDto Invoke-DoesInboxExist
+>         [-EmailAddress]
+>         [-AllowCatchAll]
+ +Does inbox exist + +Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailAddress = "EmailAddress_example" # String | Email address +$AllowCatchAll = true # Boolean | (optional) + +# Does inbox exist +try { + $Result = Invoke-DoesInboxExist -EmailAddress $EmailAddress -AllowCatchAll $AllowCatchAll +} catch { + Write-Host ("Exception occured when calling Invoke-DoesInboxExist: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailAddress** | **String**| Email address | + **AllowCatchAll** | **Boolean**| | [optional] + +### Return type + +[**InboxExistsDto**](InboxExistsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Clear-Expired** +> FlushExpiredInboxesResult Clear-Expired
+>         [-Before]
+ +Remove expired inboxes + +Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Before = Get-Date # System.DateTime | Optional expired at before flag to flush expired inboxes that have expired before the given time (optional) + +# Remove expired inboxes +try { + $Result = Clear-Expired -Before $Before +} catch { + Write-Host ("Exception occured when calling Clear-Expired: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Before** | **System.DateTime**| Optional expired at before flag to flush expired inboxes that have expired before the given time | [optional] + +### Return type + +[**FlushExpiredInboxesResult**](FlushExpiredInboxesResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllInboxes** +> PageInboxProjection Get-AllInboxes
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Favourite]
+>         [-Search]
+>         [-Tag]
+>         [-TeamAccess]
+>         [-Since]
+>         [-Before]
+>         [-InboxType]
+>         [-InboxFunction]
+>         [-DomainId]
+ +List All Inboxes Paginated + +List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Favourite = true # Boolean | Optionally filter results for favourites only (optional) (default to $false) +$Search = "Search_example" # String | Optionally filter by search words partial matching ID, tags, name, and email address (optional) +$Tag = "Tag_example" # String | Optionally filter by tags. Will return inboxes that include given tags (optional) +$TeamAccess = true # Boolean | DEPRECATED. Optionally filter by team access. (optional) +$Since = Get-Date # System.DateTime | Optional filter by created after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by created before given date time (optional) +$InboxType = "HTTP_INBOX" # String | Optional filter by inbox type (optional) +$InboxFunction = "ALIAS" # String | Optional filter by inbox function (optional) +$DomainId = "DomainId_example" # String | Optional domain ID filter (optional) + +# List All Inboxes Paginated +try { + $Result = Get-AllInboxes -Page $Page -Size $Size -Sort $Sort -Favourite $Favourite -Search $Search -Tag $Tag -TeamAccess $TeamAccess -Since $Since -Before $Before -InboxType $InboxType -InboxFunction $InboxFunction -DomainId $DomainId +} catch { + Write-Host ("Exception occured when calling Get-AllInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Favourite** | **Boolean**| Optionally filter results for favourites only | [optional] [default to $false] + **Search** | **String**| Optionally filter by search words partial matching ID, tags, name, and email address | [optional] + **Tag** | **String**| Optionally filter by tags. Will return inboxes that include given tags | [optional] + **TeamAccess** | **Boolean**| DEPRECATED. Optionally filter by team access. | [optional] + **Since** | **System.DateTime**| Optional filter by created after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by created before given date time | [optional] + **InboxType** | **String**| Optional filter by inbox type | [optional] + **InboxFunction** | **String**| Optional filter by inbox function | [optional] + **DomainId** | [**String**](String)| Optional domain ID filter | [optional] + +### Return type + +[**PageInboxProjection**](PageInboxProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllInboxesOffsetPaginated** +> PageInboxProjection Get-AllInboxesOffsetPaginated
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Favourite]
+>         [-Search]
+>         [-Tag]
+>         [-TeamAccess]
+>         [-Since]
+>         [-Before]
+>         [-InboxType]
+>         [-InboxFunction]
+>         [-DomainId]
+ +List All Inboxes Offset Paginated + +List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Favourite = true # Boolean | Optionally filter results for favourites only (optional) (default to $false) +$Search = "Search_example" # String | Optionally filter by search words partial matching ID, tags, name, and email address (optional) +$Tag = "Tag_example" # String | Optionally filter by tags. Will return inboxes that include given tags (optional) +$TeamAccess = true # Boolean | DEPRECATED. Optionally filter by team access. (optional) +$Since = Get-Date # System.DateTime | Optional filter by created after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by created before given date time (optional) +$InboxType = "HTTP_INBOX" # String | Optional filter by inbox type (optional) +$InboxFunction = "ALIAS" # String | Optional filter by inbox function (optional) +$DomainId = "DomainId_example" # String | Optional domain ID filter (optional) + +# List All Inboxes Offset Paginated +try { + $Result = Get-AllInboxesOffsetPaginated -Page $Page -Size $Size -Sort $Sort -Favourite $Favourite -Search $Search -Tag $Tag -TeamAccess $TeamAccess -Since $Since -Before $Before -InboxType $InboxType -InboxFunction $InboxFunction -DomainId $DomainId +} catch { + Write-Host ("Exception occured when calling Get-AllInboxesOffsetPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Favourite** | **Boolean**| Optionally filter results for favourites only | [optional] [default to $false] + **Search** | **String**| Optionally filter by search words partial matching ID, tags, name, and email address | [optional] + **Tag** | **String**| Optionally filter by tags. Will return inboxes that include given tags | [optional] + **TeamAccess** | **Boolean**| DEPRECATED. Optionally filter by team access. | [optional] + **Since** | **System.DateTime**| Optional filter by created after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by created before given date time | [optional] + **InboxType** | **String**| Optional filter by inbox type | [optional] + **InboxFunction** | **String**| Optional filter by inbox function | [optional] + **DomainId** | [**String**](String)| Optional domain ID filter | [optional] + +### Return type + +[**PageInboxProjection**](PageInboxProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllScheduledJobs** +> PageScheduledJobs Get-AllScheduledJobs
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get all scheduled email sending jobs for account + +Schedule sending of emails using scheduled jobs. These can be inbox or account level. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in scheduled job list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in scheduled job list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get all scheduled email sending jobs for account +try { + $Result = Get-AllScheduledJobs -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllScheduledJobs: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in scheduled job list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in scheduled job list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageScheduledJobs**](PageScheduledJobs) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-DeliveryStatusesByInboxId** +> PageDeliveryStatus Get-DeliveryStatusesByInboxId
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ + + +Get all email delivery statuses for an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$Page = 987 # Int32 | Optional page index in delivery status list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in delivery status list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-DeliveryStatusesByInboxId -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-DeliveryStatusesByInboxId: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in delivery status list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in delivery status list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageDeliveryStatus**](PageDeliveryStatus) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Emails** +> EmailPreview[] Get-Emails
+>         [-InboxId]
+>         [-Size]
+>         [-Limit]
+>         [-Sort]
+>         [-RetryTimeout]
+>         [-DelayTimeout]
+>         [-MinCount]
+>         [-UnreadOnly]
+>         [-Before]
+>         [-Since]
+ +Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. + +List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of inbox that emails belongs to +$Size = 987 # Int32 | Alias for limit. Assessed first before assessing any passed limit. (optional) +$Limit = 987 # Int32 | Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional) +$Sort = "ASC" # String | Sort the results by received date and direction ASC or DESC (optional) +$RetryTimeout = 987 # Int64 | Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional) +$DelayTimeout = 987 # Int64 | (optional) +$MinCount = 987 # Int64 | Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional) +$UnreadOnly = true # Boolean | (optional) +$Before = Get-Date # System.DateTime | Exclude emails received after this ISO 8601 date time (optional) +$Since = Get-Date # System.DateTime | Exclude emails received before this ISO 8601 date time (optional) + +# Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. +try { + $Result = Get-Emails -InboxId $InboxId -Size $Size -Limit $Limit -Sort $Sort -RetryTimeout $RetryTimeout -DelayTimeout $DelayTimeout -MinCount $MinCount -UnreadOnly $UnreadOnly -Before $Before -Since $Since +} catch { + Write-Host ("Exception occured when calling Get-Emails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of inbox that emails belongs to | + **Size** | **Int32**| Alias for limit. Assessed first before assessing any passed limit. | [optional] + **Limit** | **Int32**| Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller | [optional] + **Sort** | **String**| Sort the results by received date and direction ASC or DESC | [optional] + **RetryTimeout** | **Int64**| Maximum milliseconds to spend retrying inbox database until minCount emails are returned | [optional] + **DelayTimeout** | **Int64**| | [optional] + **MinCount** | **Int64**| Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. | [optional] + **UnreadOnly** | **Boolean**| | [optional] + **Before** | **System.DateTime**| Exclude emails received after this ISO 8601 date time | [optional] + **Since** | **System.DateTime**| Exclude emails received before this ISO 8601 date time | [optional] + +### Return type + +[**EmailPreview[]**](EmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ImapAccess** +> ImapAccessDetails Get-ImapAccess
+>         [-InboxId]
+ + + +Get IMAP access usernames and passwords + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Inbox ID (optional) + +try { + $Result = Get-ImapAccess -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-ImapAccess: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Inbox ID | [optional] + +### Return type + +[**ImapAccessDetails**](ImapAccessDetails) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ImapSmtpAccess** +> ImapSmtpAccessDetails Get-ImapSmtpAccess
+>         [-InboxId]
+ + + +Get IMAP and SMTP access usernames and passwords + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Inbox ID (optional) + +try { + $Result = Get-ImapSmtpAccess -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-ImapSmtpAccess: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Inbox ID | [optional] + +### Return type + +[**ImapSmtpAccessDetails**](ImapSmtpAccessDetails) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ImapSmtpAccessEnv** +> String Get-ImapSmtpAccessEnv
+>         [-InboxId]
+ + + +Get IMAP and SMTP access details in .env format + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Inbox ID (optional) + +try { + $Result = Get-ImapSmtpAccessEnv -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-ImapSmtpAccessEnv: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Inbox ID | [optional] + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ImapSmtpAccessServers** +> ImapSmtpAccessServers Get-ImapSmtpAccessServers
+ + + +Get IMAP and SMTP server hosts + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-ImapSmtpAccessServers +} catch { + Write-Host ("Exception occured when calling Get-ImapSmtpAccessServers: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ImapSmtpAccessServers**](ImapSmtpAccessServers) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Inbox** +> InboxDto Get-Inbox
+>         [-InboxId]
+ +Get Inbox. Returns properties of an inbox. + +Returns an inbox's properties, including its email address and ID. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Get Inbox. Returns properties of an inbox. +try { + $Result = Get-Inbox -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-Inbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxByEmailAddress** +> InboxByEmailAddressResult Get-InboxByEmailAddress
+>         [-EmailAddress]
+ +Search for an inbox with the provided email address + +Get a inbox result by email address + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailAddress = "EmailAddress_example" # String | + +# Search for an inbox with the provided email address +try { + $Result = Get-InboxByEmailAddress -EmailAddress $EmailAddress +} catch { + Write-Host ("Exception occured when calling Get-InboxByEmailAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailAddress** | **String**| | + +### Return type + +[**InboxByEmailAddressResult**](InboxByEmailAddressResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxByName** +> InboxByNameResult Get-InboxByName
+>         [-Name]
+ +Search for an inbox with the given name + +Get a inbox result by name + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Name = "Name_example" # String | + +# Search for an inbox with the given name +try { + $Result = Get-InboxByName -Name $Name +} catch { + Write-Host ("Exception occured when calling Get-InboxByName: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Name** | **String**| | + +### Return type + +[**InboxByNameResult**](InboxByNameResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxCount** +> CountDto Get-InboxCount
+ +Get total inbox count + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get total inbox count +try { + $Result = Get-InboxCount +} catch { + Write-Host ("Exception occured when calling Get-InboxCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**CountDto**](CountDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxEmailCount** +> CountDto Get-InboxEmailCount
+>         [-InboxId]
+ +Get email count in inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of inbox that emails belongs to + +# Get email count in inbox +try { + $Result = Get-InboxEmailCount -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-InboxEmailCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of inbox that emails belongs to | + +### Return type + +[**CountDto**](CountDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxEmailsPaginated** +> PageEmailPreview Get-InboxEmailsPaginated
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get inbox emails paginated + +Get a paginated list of emails in an inbox. Does not hold connections open. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of inbox that emails belongs to +$Page = 987 # Int32 | Optional page index in inbox emails list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox emails list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Optional filter by received after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by received before given date time (optional) + +# Get inbox emails paginated +try { + $Result = Get-InboxEmailsPaginated -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-InboxEmailsPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of inbox that emails belongs to | + **Page** | **Int32**| Optional page index in inbox emails list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox emails list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Optional filter by received after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by received before given date time | [optional] + +### Return type + +[**PageEmailPreview**](PageEmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxIds** +> InboxIdsResult Get-InboxIds
+ +Get all inbox IDs + +Get list of inbox IDs + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get all inbox IDs +try { + $Result = Get-InboxIds +} catch { + Write-Host ("Exception occured when calling Get-InboxIds: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**InboxIdsResult**](InboxIdsResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxSentEmails** +> PageSentEmailProjection Get-InboxSentEmails
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get Inbox Sent Emails + +Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$Page = 987 # Int32 | Optional page index in inbox sent email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox sent email list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional sent email search (optional) +$Since = Get-Date # System.DateTime | Optional filter by sent after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by sent before given date time (optional) + +# Get Inbox Sent Emails +try { + $Result = Get-InboxSentEmails -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-InboxSentEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in inbox sent email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox sent email list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional sent email search | [optional] + **Since** | **System.DateTime**| Optional filter by sent after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by sent before given date time | [optional] + +### Return type + +[**PageSentEmailProjection**](PageSentEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxTags** +> String[] Get-InboxTags
+ +Get inbox tags + +Get all inbox tags + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get inbox tags +try { + $Result = Get-InboxTags +} catch { + Write-Host ("Exception occured when calling Get-InboxTags: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**String[]** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Inboxes** +> InboxDto[] Get-Inboxes
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-ExcludeCatchAllInboxes]
+>         [-Before]
+ +List Inboxes and email addresses + +List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Size = 987 # Int32 | Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional) (default to 100) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Optional filter by created after given date time (optional) +$ExcludeCatchAllInboxes = true # Boolean | Optional exclude catch all inboxes (optional) +$Before = Get-Date # System.DateTime | Optional filter by created before given date time (optional) + +# List Inboxes and email addresses +try { + $Result = Get-Inboxes -Size $Size -Sort $Sort -Since $Since -ExcludeCatchAllInboxes $ExcludeCatchAllInboxes -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-Inboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Size** | **Int32**| Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. | [optional] [default to 100] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Optional filter by created after given date time | [optional] + **ExcludeCatchAllInboxes** | **Boolean**| Optional exclude catch all inboxes | [optional] + **Before** | **System.DateTime**| Optional filter by created before given date time | [optional] + +### Return type + +[**InboxDto[]**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-LatestEmailInInbox** +> Email Get-LatestEmailInInbox
+>         [-InboxId]
+>         [-TimeoutMillis]
+ +Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. + +Get the newest email in an inbox or wait for one to arrive + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to get the latest email from +$TimeoutMillis = 987 # Int64 | Timeout milliseconds to wait for latest email + +# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. +try { + $Result = Get-LatestEmailInInbox -InboxId $InboxId -TimeoutMillis $TimeoutMillis +} catch { + Write-Host ("Exception occured when calling Get-LatestEmailInInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to get the latest email from | + **TimeoutMillis** | **Int64**| Timeout milliseconds to wait for latest email | + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-OrganizationInboxes** +> PageOrganizationInboxProjection Get-OrganizationInboxes
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +List Organization Inboxes Paginated + +List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Optional filter by created after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by created before given date time (optional) + +# List Organization Inboxes Paginated +try { + $Result = Get-OrganizationInboxes -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-OrganizationInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Optional filter by created after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by created before given date time | [optional] + +### Return type + +[**PageOrganizationInboxProjection**](PageOrganizationInboxProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ScheduledJob** +> ScheduledJobDto Get-ScheduledJob
+>         [-JobId]
+ +Get a scheduled email job + +Get a scheduled email job details. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$JobId = "JobId_example" # String | + +# Get a scheduled email job +try { + $Result = Get-ScheduledJob -JobId $JobId +} catch { + Write-Host ("Exception occured when calling Get-ScheduledJob: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **JobId** | [**String**](String)| | + +### Return type + +[**ScheduledJobDto**](ScheduledJobDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ScheduledJobsByInboxId** +> PageScheduledJobs Get-ScheduledJobsByInboxId
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get all scheduled email sending jobs for the inbox + +Schedule sending of emails using scheduled jobs. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$Page = 987 # Int32 | Optional page index in scheduled job list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in scheduled job list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get all scheduled email sending jobs for the inbox +try { + $Result = Get-ScheduledJobsByInboxId -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-ScheduledJobsByInboxId: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in scheduled job list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in scheduled job list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageScheduledJobs**](PageScheduledJobs) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SmtpAccess** +> SmtpAccessDetails Get-SmtpAccess
+>         [-InboxId]
+ + + +Get SMTP access usernames and passwords + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Inbox ID (optional) + +try { + $Result = Get-SmtpAccess -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-SmtpAccess: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Inbox ID | [optional] + +### Return type + +[**SmtpAccessDetails**](SmtpAccessDetails) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ListInboxRulesets** +> PageInboxRulesetDto Invoke-ListInboxRulesets
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +List inbox rulesets + +List all rulesets attached to an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$Page = 987 # Int32 | Optional page index in inbox ruleset list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox ruleset list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Optional filter by created after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by created before given date time (optional) + +# List inbox rulesets +try { + $Result = Invoke-ListInboxRulesets -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Invoke-ListInboxRulesets: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in inbox ruleset list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox ruleset list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Optional filter by created after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by created before given date time | [optional] + +### Return type + +[**PageInboxRulesetDto**](PageInboxRulesetDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ListInboxTrackingPixels** +> PageTrackingPixelProjection Invoke-ListInboxTrackingPixels
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +List inbox tracking pixels + +List all tracking pixels sent from an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$Page = 987 # Int32 | Optional page index in inbox tracking pixel list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox tracking pixel list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Optional filter by created after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter by created before given date time (optional) + +# List inbox tracking pixels +try { + $Result = Invoke-ListInboxTrackingPixels -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Invoke-ListInboxTrackingPixels: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in inbox tracking pixel list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox tracking pixel list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Optional filter by created after given date time | [optional] + **Before** | **System.DateTime**| Optional filter by created before given date time | [optional] + +### Return type + +[**PageTrackingPixelProjection**](PageTrackingPixelProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Search-Inboxes** +> PageInboxProjection Search-Inboxes
+>         [-SearchInboxesOptions]
+ +Search all inboxes and return matching inboxes + +Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SearchInboxesOptions = (Initialize-SearchInboxesOptions -PageIndex 123 -PageSize 123 -SortDirection "ASC" -Favourite $false -Search "Search_example" -Tag "Tag_example" -Since Get-Date -Before Get-Date -InboxType "HTTP_INBOX" -InboxFunction "ALIAS" -DomainId "DomainId_example") # SearchInboxesOptions | + +# Search all inboxes and return matching inboxes +try { + $Result = Search-Inboxes -SearchInboxesOptions $SearchInboxesOptions +} catch { + Write-Host ("Exception occured when calling Search-Inboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SearchInboxesOptions** | [**SearchInboxesOptions**](SearchInboxesOptions)| | + +### Return type + +[**PageInboxProjection**](PageInboxProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-Email** +> void Send-Email
+>         [-InboxId]
+>         [-SendEmailOptions]
+ +Send Email + +Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from +$SendEmailOptions = (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID" -IgnoreEmptyRecipients $false -IsXAmpHtml $false -BodyParts @((Initialize-SendEmailBodyPart -ContentType "ContentType_example" -ContentBody "ContentBody_example"))) # SendEmailOptions | + +# Send Email +try { + $Result = Send-Email -InboxId $InboxId -SendEmailOptions $SendEmailOptions +} catch { + Write-Host ("Exception occured when calling Send-Email: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-EmailAndConfirm** +> SentEmailDto Send-EmailAndConfirm
+>         [-InboxId]
+>         [-SendEmailOptions]
+ +Send email and return sent confirmation + +Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from +$SendEmailOptions = (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -CustomHeaders "TODO" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID" -IgnoreEmptyRecipients $false -IsXAmpHtml $false -BodyParts @((Initialize-SendEmailBodyPart -ContentType "ContentType_example" -ContentBody "ContentBody_example"))) # SendEmailOptions | + +# Send email and return sent confirmation +try { + $Result = Send-EmailAndConfirm -InboxId $InboxId -SendEmailOptions $SendEmailOptions +} catch { + Write-Host ("Exception occured when calling Send-EmailAndConfirm: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-EmailWithQueue** +> void Send-EmailWithQueue
+>         [-InboxId]
+>         [-ValidateBeforeEnqueue]
+>         [-SendEmailOptions]
+ +Send email with queue + +Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from +$ValidateBeforeEnqueue = true # Boolean | Validate before adding to queue +$SendEmailOptions = # SendEmailOptions | + +# Send email with queue +try { + $Result = Send-EmailWithQueue -InboxId $InboxId -ValidateBeforeEnqueue $ValidateBeforeEnqueue -SendEmailOptions $SendEmailOptions +} catch { + Write-Host ("Exception occured when calling Send-EmailWithQueue: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | + **ValidateBeforeEnqueue** | **Boolean**| Validate before adding to queue | + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-SmtpEnvelope** +> SentEmailDto Send-SmtpEnvelope
+>         [-InboxId]
+>         [-SendSMTPEnvelopeOptions]
+ +Send email using an SMTP mail envelope and message body and return sent confirmation + +Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from +$SendSMTPEnvelopeOptions = (Initialize-SendSMTPEnvelopeOptions -RcptTo @("RcptTo_example") -MailFrom "MailFrom_example" -VarData "VarData_example") # SendSMTPEnvelopeOptions | + +# Send email using an SMTP mail envelope and message body and return sent confirmation +try { + $Result = Send-SmtpEnvelope -InboxId $InboxId -SendSMTPEnvelopeOptions $SendSMTPEnvelopeOptions +} catch { + Write-Host ("Exception occured when calling Send-SmtpEnvelope: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | + **SendSMTPEnvelopeOptions** | [**SendSMTPEnvelopeOptions**](SendSMTPEnvelopeOptions)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-TestEmail** +> void Send-TestEmail
+>         [-InboxId]
+ +Send a test email to inbox + +Send an inbox a test email to test email receiving is working + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Send a test email to inbox +try { + $Result = Send-TestEmail -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Send-TestEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-WithSchedule** +> ScheduledJobDto Send-WithSchedule
+>         [-InboxId]
+>         [-SendEmailOptions]
+>         [-SendAtTimestamp]
+>         [-SendAtNowPlusSeconds]
+>         [-ValidateBeforeEnqueue]
+ +Send email with with delay or schedule + +Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of the inbox you want to send the email from +$SendEmailOptions = # SendEmailOptions | +$SendAtTimestamp = Get-Date # System.DateTime | Sending timestamp (optional) +$SendAtNowPlusSeconds = 987 # Int64 | Send after n seconds (optional) +$ValidateBeforeEnqueue = true # Boolean | Validate before adding to queue (optional) + +# Send email with with delay or schedule +try { + $Result = Send-WithSchedule -InboxId $InboxId -SendEmailOptions $SendEmailOptions -SendAtTimestamp $SendAtTimestamp -SendAtNowPlusSeconds $SendAtNowPlusSeconds -ValidateBeforeEnqueue $ValidateBeforeEnqueue +} catch { + Write-Host ("Exception occured when calling Send-WithSchedule: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of the inbox you want to send the email from | + **SendEmailOptions** | [**SendEmailOptions**](SendEmailOptions)| | + **SendAtTimestamp** | **System.DateTime**| Sending timestamp | [optional] + **SendAtNowPlusSeconds** | **Int64**| Send after n seconds | [optional] + **ValidateBeforeEnqueue** | **Boolean**| Validate before adding to queue | [optional] + +### Return type + +[**ScheduledJobDto**](ScheduledJobDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Set-InboxFavourited** +> InboxDto Set-InboxFavourited
+>         [-InboxId]
+>         [-SetInboxFavouritedOptions]
+ +Set inbox favourited state + +Set and return new favourite state for an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of inbox to set favourite state +$SetInboxFavouritedOptions = (Initialize-SetInboxFavouritedOptions -State $false) # SetInboxFavouritedOptions | + +# Set inbox favourited state +try { + $Result = Set-InboxFavourited -InboxId $InboxId -SetInboxFavouritedOptions $SetInboxFavouritedOptions +} catch { + Write-Host ("Exception occured when calling Set-InboxFavourited: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of inbox to set favourite state | + **SetInboxFavouritedOptions** | [**SetInboxFavouritedOptions**](SetInboxFavouritedOptions)| | + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-ImapAccess** +> void Update-ImapAccess
+>         [-UpdateImapAccessOptions]
+>         [-InboxId]
+ + + +Update IMAP access usernames and passwords + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$UpdateImapAccessOptions = (Initialize-UpdateImapAccessOptions -ImapUsername "ImapUsername_example" -ImapPassword "ImapPassword_example") # UpdateImapAccessOptions | +$InboxId = "InboxId_example" # String | Inbox ID (optional) + +try { + $Result = Update-ImapAccess -UpdateImapAccessOptions $UpdateImapAccessOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Update-ImapAccess: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **UpdateImapAccessOptions** | [**UpdateImapAccessOptions**](UpdateImapAccessOptions)| | + **InboxId** | [**String**](String)| Inbox ID | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-Inbox** +> InboxDto Update-Inbox
+>         [-InboxId]
+>         [-UpdateInboxOptions]
+ +Update Inbox. Change name and description. Email address is not editable. + +Update editable fields on an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$UpdateInboxOptions = (Initialize-UpdateInboxOptions -Name "Name_example" -Description "Description_example" -Tags @("Tags_example") -ExpiresAt Get-Date -Favourite $false) # UpdateInboxOptions | + +# Update Inbox. Change name and description. Email address is not editable. +try { + $Result = Update-Inbox -InboxId $InboxId -UpdateInboxOptions $UpdateInboxOptions +} catch { + Write-Host ("Exception occured when calling Update-Inbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **UpdateInboxOptions** | [**UpdateInboxOptions**](UpdateInboxOptions)| | + +### Return type + +[**InboxDto**](InboxDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-SmtpAccess** +> void Update-SmtpAccess
+>         [-UpdateSmtpAccessOptions]
+>         [-InboxId]
+ + + +Update SMTP access usernames and passwords + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$UpdateSmtpAccessOptions = (Initialize-UpdateSmtpAccessOptions -SmtpUsername "SmtpUsername_example" -SmtpPassword "SmtpPassword_example") # UpdateSmtpAccessOptions | +$InboxId = "InboxId_example" # String | Inbox ID (optional) + +try { + $Result = Update-SmtpAccess -UpdateSmtpAccessOptions $UpdateSmtpAccessOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Update-SmtpAccess: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **UpdateSmtpAccessOptions** | [**UpdateSmtpAccessOptions**](UpdateSmtpAccessOptions)| | + **InboxId** | [**String**](String)| Inbox ID | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/InboxDto.md b/docs/InboxDto.md new file mode 100644 index 00000000..efea5601 --- /dev/null +++ b/docs/InboxDto.md @@ -0,0 +1,47 @@ +# InboxDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. | +**UserId** | **String** | ID of user that inbox belongs to | [optional] +**CreatedAt** | **System.DateTime** | When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. | +**Name** | **String** | Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search | [optional] +**DomainId** | **String** | ID of custom domain used by the inbox if any | [optional] +**Description** | **String** | Description of an inbox for labelling and searching purposes | [optional] +**EmailAddress** | **String** | The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. | +**ExpiresAt** | **String** | Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. | [optional] +**Favourite** | **Boolean** | Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering | +**Tags** | **String[]** | Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. | [optional] +**InboxType** | **String** | Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). | [optional] +**ReadOnly** | **Boolean** | Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes. | +**VirtualInbox** | **Boolean** | Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. | +**FunctionsAs** | **String** | Inbox function if used as a primitive for another system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$InboxDto = Initialize-maislurp-client-powershellInboxDto -Id null ` + -UserId null ` + -CreatedAt null ` + -Name null ` + -DomainId null ` + -Description null ` + -EmailAddress null ` + -ExpiresAt null ` + -Favourite null ` + -Tags null ` + -InboxType null ` + -ReadOnly null ` + -VirtualInbox null ` + -FunctionsAs null +``` + +- Convert the resource to JSON +```powershell +$InboxDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxExistsDto.md b/docs/InboxExistsDto.md new file mode 100644 index 00000000..acfb1417 --- /dev/null +++ b/docs/InboxExistsDto.md @@ -0,0 +1,21 @@ +# InboxExistsDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Exists** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$InboxExistsDto = Initialize-maislurp-client-powershellInboxExistsDto -Exists null +``` + +- Convert the resource to JSON +```powershell +$InboxExistsDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxForwarderControllerApi.md b/docs/InboxForwarderControllerApi.md new file mode 100644 index 00000000..6b146b3d --- /dev/null +++ b/docs/InboxForwarderControllerApi.md @@ -0,0 +1,722 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.InboxForwarderControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-NewInboxForwarder**](InboxForwarderControllerApi#New-NewInboxForwarder) | **POST** /forwarders | Create an inbox forwarder +[**Invoke-DeleteInboxForwarder**](InboxForwarderControllerApi#Invoke-DeleteInboxForwarder) | **DELETE** /forwarders/{id} | Delete an inbox forwarder +[**Invoke-DeleteInboxForwarders**](InboxForwarderControllerApi#Invoke-DeleteInboxForwarders) | **DELETE** /forwarders | Delete inbox forwarders +[**Get-AllInboxForwarderEvents**](InboxForwarderControllerApi#Get-AllInboxForwarderEvents) | **GET** /forwarders/events | Get all inbox forwarder events +[**Get-ForwarderEvent**](InboxForwarderControllerApi#Get-ForwarderEvent) | **GET** /forwarders/events/{eventId} | Get a forwarder event +[**Get-InboxForwarder**](InboxForwarderControllerApi#Get-InboxForwarder) | **GET** /forwarders/{id} | Get an inbox forwarder +[**Get-InboxForwarderEvent**](InboxForwarderControllerApi#Get-InboxForwarderEvent) | **GET** /forwarders/{id}/events/{eventId} | Get an inbox forwarder event +[**Get-InboxForwarderEvents**](InboxForwarderControllerApi#Get-InboxForwarderEvents) | **GET** /forwarders/{id}/events | Get an inbox forwarder event list +[**Get-InboxForwarders**](InboxForwarderControllerApi#Get-InboxForwarders) | **GET** /forwarders | List inbox forwarders +[**Test-InboxForwarder**](InboxForwarderControllerApi#Test-InboxForwarder) | **POST** /forwarders/{id}/test | Test an inbox forwarder +[**Test-InboxForwardersForInbox**](InboxForwarderControllerApi#Test-InboxForwardersForInbox) | **PUT** /forwarders | Test inbox forwarders for inbox +[**Test-NewInboxForwarder**](InboxForwarderControllerApi#Test-NewInboxForwarder) | **PATCH** /forwarders | Test new inbox forwarder +[**Update-InboxForwarder**](InboxForwarderControllerApi#Update-InboxForwarder) | **PUT** /forwarders/{id} | Update an inbox forwarder + + + +# **New-NewInboxForwarder** +> InboxForwarderDto New-NewInboxForwarder
+>         [-InboxId]
+>         [-CreateInboxForwarderOptions]
+ +Create an inbox forwarder + +Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Inbox id to attach forwarder to +$CreateInboxForwarderOptions = (Initialize-CreateInboxForwarderOptions -Field "RECIPIENTS" -Match "Match_example" -ForwardToRecipients @("ForwardToRecipients_example")) # CreateInboxForwarderOptions | + +# Create an inbox forwarder +try { + $Result = New-NewInboxForwarder -InboxId $InboxId -CreateInboxForwarderOptions $CreateInboxForwarderOptions +} catch { + Write-Host ("Exception occured when calling New-NewInboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Inbox id to attach forwarder to | + **CreateInboxForwarderOptions** | [**CreateInboxForwarderOptions**](CreateInboxForwarderOptions)| | + +### Return type + +[**InboxForwarderDto**](InboxForwarderDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInboxForwarder** +> void Invoke-DeleteInboxForwarder
+>         [-Id]
+ +Delete an inbox forwarder + +Delete inbox forwarder + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox forwarder + +# Delete an inbox forwarder +try { + $Result = Invoke-DeleteInboxForwarder -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox forwarder | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInboxForwarders** +> void Invoke-DeleteInboxForwarders
+>         [-InboxId]
+ +Delete inbox forwarders + +Delete inbox forwarders. Accepts optional inboxId filter. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox id to attach forwarder to (optional) + +# Delete inbox forwarders +try { + $Result = Invoke-DeleteInboxForwarders -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInboxForwarders: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox id to attach forwarder to | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllInboxForwarderEvents** +> PageInboxForwarderEvents Get-AllInboxForwarderEvents
+>         [-Page]
+>         [-Size]
+>         [-InboxId]
+>         [-Sort]
+ +Get all inbox forwarder events + +Get all inbox forwarder events + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in inbox forwarder event list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox forwarder event list pagination (optional) (default to 20) +$InboxId = "InboxId_example" # String | Optional inbox ID to filter for (optional) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") + +# Get all inbox forwarder events +try { + $Result = Get-AllInboxForwarderEvents -Page $Page -Size $Size -InboxId $InboxId -Sort $Sort +} catch { + Write-Host ("Exception occured when calling Get-AllInboxForwarderEvents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in inbox forwarder event list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox forwarder event list pagination | [optional] [default to 20] + **InboxId** | [**String**](String)| Optional inbox ID to filter for | [optional] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + +### Return type + +[**PageInboxForwarderEvents**](PageInboxForwarderEvents) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ForwarderEvent** +> InboxForwarderEventDto Get-ForwarderEvent
+>         [-EventId]
+ +Get a forwarder event + +Get forwarder event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EventId = "EventId_example" # String | ID of inbox forwarder event + +# Get a forwarder event +try { + $Result = Get-ForwarderEvent -EventId $EventId +} catch { + Write-Host ("Exception occured when calling Get-ForwarderEvent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EventId** | [**String**](String)| ID of inbox forwarder event | + +### Return type + +[**InboxForwarderEventDto**](InboxForwarderEventDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxForwarder** +> InboxForwarderDto Get-InboxForwarder
+>         [-Id]
+ +Get an inbox forwarder + +Get inbox forwarder + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox forwarder + +# Get an inbox forwarder +try { + $Result = Get-InboxForwarder -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-InboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox forwarder | + +### Return type + +[**InboxForwarderDto**](InboxForwarderDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxForwarderEvent** +> InboxForwarderEventDto Get-InboxForwarderEvent
+>         [-Id]
+>         [-EventId]
+ +Get an inbox forwarder event + +Get inbox forwarder event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox forwarder +$EventId = "EventId_example" # String | ID of inbox forwarder event + +# Get an inbox forwarder event +try { + $Result = Get-InboxForwarderEvent -Id $Id -EventId $EventId +} catch { + Write-Host ("Exception occured when calling Get-InboxForwarderEvent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox forwarder | + **EventId** | [**String**](String)| ID of inbox forwarder event | + +### Return type + +[**InboxForwarderEventDto**](InboxForwarderEventDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxForwarderEvents** +> PageInboxForwarderEvents Get-InboxForwarderEvents
+>         [-Id]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+ +Get an inbox forwarder event list + +Get inbox forwarder events + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox forwarder +$Page = 987 # Int32 | Optional page index in inbox forwarder event list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox forwarder event list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") + +# Get an inbox forwarder event list +try { + $Result = Get-InboxForwarderEvents -Id $Id -Page $Page -Size $Size -Sort $Sort +} catch { + Write-Host ("Exception occured when calling Get-InboxForwarderEvents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox forwarder | + **Page** | **Int32**| Optional page index in inbox forwarder event list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox forwarder event list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + +### Return type + +[**PageInboxForwarderEvents**](PageInboxForwarderEvents) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxForwarders** +> PageInboxForwarderDto Get-InboxForwarders
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +List inbox forwarders + +List all forwarders attached to an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox id to get forwarders from (optional) +$Page = 987 # Int32 | Optional page index in inbox forwarder list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox forwarder list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List inbox forwarders +try { + $Result = Get-InboxForwarders -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-InboxForwarders: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox id to get forwarders from | [optional] + **Page** | **Int32**| Optional page index in inbox forwarder list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox forwarder list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageInboxForwarderDto**](PageInboxForwarderDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-InboxForwarder** +> InboxForwarderTestResult Test-InboxForwarder
+>         [-Id]
+>         [-InboxForwarderTestOptions]
+ +Test an inbox forwarder + +Test an inbox forwarder + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox forwarder +$InboxForwarderTestOptions = (Initialize-InboxForwarderTestOptions -TestValue "TestValue_example") # InboxForwarderTestOptions | + +# Test an inbox forwarder +try { + $Result = Test-InboxForwarder -Id $Id -InboxForwarderTestOptions $InboxForwarderTestOptions +} catch { + Write-Host ("Exception occured when calling Test-InboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox forwarder | + **InboxForwarderTestOptions** | [**InboxForwarderTestOptions**](InboxForwarderTestOptions)| | + +### Return type + +[**InboxForwarderTestResult**](InboxForwarderTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-InboxForwardersForInbox** +> InboxForwarderTestResult Test-InboxForwardersForInbox
+>         [-InboxId]
+>         [-InboxForwarderTestOptions]
+ +Test inbox forwarders for inbox + +Test inbox forwarders for inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of inbox +$InboxForwarderTestOptions = (Initialize-InboxForwarderTestOptions -TestValue "TestValue_example") # InboxForwarderTestOptions | + +# Test inbox forwarders for inbox +try { + $Result = Test-InboxForwardersForInbox -InboxId $InboxId -InboxForwarderTestOptions $InboxForwarderTestOptions +} catch { + Write-Host ("Exception occured when calling Test-InboxForwardersForInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of inbox | + **InboxForwarderTestOptions** | [**InboxForwarderTestOptions**](InboxForwarderTestOptions)| | + +### Return type + +[**InboxForwarderTestResult**](InboxForwarderTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-NewInboxForwarder** +> InboxForwarderTestResult Test-NewInboxForwarder
+>         [-TestNewInboxForwarderOptions]
+ +Test new inbox forwarder + +Test new inbox forwarder + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TestNewInboxForwarderOptions = (Initialize-TestNewInboxForwarderOptions -InboxForwarderTestOptions -CreateInboxForwarderOptions (Initialize-CreateInboxForwarderOptions -Field "RECIPIENTS" -Match "Match_example" -ForwardToRecipients @("ForwardToRecipients_example"))) # TestNewInboxForwarderOptions | + +# Test new inbox forwarder +try { + $Result = Test-NewInboxForwarder -TestNewInboxForwarderOptions $TestNewInboxForwarderOptions +} catch { + Write-Host ("Exception occured when calling Test-NewInboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TestNewInboxForwarderOptions** | [**TestNewInboxForwarderOptions**](TestNewInboxForwarderOptions)| | + +### Return type + +[**InboxForwarderTestResult**](InboxForwarderTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-InboxForwarder** +> InboxForwarderDto Update-InboxForwarder
+>         [-Id]
+>         [-CreateInboxForwarderOptions]
+ +Update an inbox forwarder + +Update inbox forwarder + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox forwarder +$CreateInboxForwarderOptions = # CreateInboxForwarderOptions | + +# Update an inbox forwarder +try { + $Result = Update-InboxForwarder -Id $Id -CreateInboxForwarderOptions $CreateInboxForwarderOptions +} catch { + Write-Host ("Exception occured when calling Update-InboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox forwarder | + **CreateInboxForwarderOptions** | [**CreateInboxForwarderOptions**](CreateInboxForwarderOptions)| | + +### Return type + +[**InboxForwarderDto**](InboxForwarderDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/InboxForwarderDto.md b/docs/InboxForwarderDto.md new file mode 100644 index 00000000..ed56b5b1 --- /dev/null +++ b/docs/InboxForwarderDto.md @@ -0,0 +1,33 @@ +# InboxForwarderDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**InboxId** | **String** | | +**Name** | **String** | Name of inbox forwarder | [optional] +**Field** | **String** | Which field to match against | +**Match** | **String** | Wild-card type pattern to apply to field | +**ForwardToRecipients** | **String[]** | Who to send forwarded email to | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$InboxForwarderDto = Initialize-maislurp-client-powershellInboxForwarderDto -Id null ` + -InboxId null ` + -Name null ` + -Field null ` + -Match null ` + -ForwardToRecipients null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$InboxForwarderDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxForwarderEventDto.md b/docs/InboxForwarderEventDto.md new file mode 100644 index 00000000..44224143 --- /dev/null +++ b/docs/InboxForwarderEventDto.md @@ -0,0 +1,35 @@ +# InboxForwarderEventDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [optional] +**InboxId** | **String** | | [optional] +**EmailId** | **String** | | [optional] +**UserId** | **String** | | [optional] +**ForwarderId** | **String** | | [optional] +**Message** | **String** | | [optional] +**Status** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$InboxForwarderEventDto = Initialize-maislurp-client-powershellInboxForwarderEventDto -Id null ` + -InboxId null ` + -EmailId null ` + -UserId null ` + -ForwarderId null ` + -Message null ` + -Status null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$InboxForwarderEventDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxForwarderEventProjection.md b/docs/InboxForwarderEventProjection.md new file mode 100644 index 00000000..8abeb74d --- /dev/null +++ b/docs/InboxForwarderEventProjection.md @@ -0,0 +1,35 @@ +# InboxForwarderEventProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailId** | **String** | | [optional] +**InboxId** | **String** | | [optional] +**UserId** | **String** | | [optional] +**ForwarderId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Message** | **String** | | [optional] +**Id** | **String** | | [optional] +**Status** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$InboxForwarderEventProjection = Initialize-maislurp-client-powershellInboxForwarderEventProjection -EmailId null ` + -InboxId null ` + -UserId null ` + -ForwarderId null ` + -CreatedAt null ` + -Message null ` + -Id null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$InboxForwarderEventProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxForwarderTestOptions.md b/docs/InboxForwarderTestOptions.md new file mode 100644 index 00000000..7038f933 --- /dev/null +++ b/docs/InboxForwarderTestOptions.md @@ -0,0 +1,21 @@ +# InboxForwarderTestOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TestValue** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$InboxForwarderTestOptions = Initialize-maislurp-client-powershellInboxForwarderTestOptions -TestValue null +``` + +- Convert the resource to JSON +```powershell +$InboxForwarderTestOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxForwarderTestResult.md b/docs/InboxForwarderTestResult.md new file mode 100644 index 00000000..ab3ff284 --- /dev/null +++ b/docs/InboxForwarderTestResult.md @@ -0,0 +1,23 @@ +# InboxForwarderTestResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarMatches** | **System.Collections.Hashtable** | | +**DoesMatch** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$InboxForwarderTestResult = Initialize-maislurp-client-powershellInboxForwarderTestResult -VarMatches null ` + -DoesMatch null +``` + +- Convert the resource to JSON +```powershell +$InboxForwarderTestResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxIdItem.md b/docs/InboxIdItem.md new file mode 100644 index 00000000..4991907a --- /dev/null +++ b/docs/InboxIdItem.md @@ -0,0 +1,23 @@ +# InboxIdItem +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**EmailAddress** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$InboxIdItem = Initialize-maislurp-client-powershellInboxIdItem -Id null ` + -EmailAddress null +``` + +- Convert the resource to JSON +```powershell +$InboxIdItem | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxIdsResult.md b/docs/InboxIdsResult.md new file mode 100644 index 00000000..26753683 --- /dev/null +++ b/docs/InboxIdsResult.md @@ -0,0 +1,21 @@ +# InboxIdsResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxIds** | [**InboxIdItem[]**](InboxIdItem) | | + +## Examples + +- Prepare the resource +```powershell +$InboxIdsResult = Initialize-maislurp-client-powershellInboxIdsResult -InboxIds null +``` + +- Convert the resource to JSON +```powershell +$InboxIdsResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxPreview.md b/docs/InboxPreview.md new file mode 100644 index 00000000..80b91c0d --- /dev/null +++ b/docs/InboxPreview.md @@ -0,0 +1,43 @@ +# InboxPreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. | +**DomainId** | **String** | ID of custom domain used by the inbox if any | [optional] +**EmailAddress** | **String** | The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. | [optional] +**CreatedAt** | **System.DateTime** | When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. | +**Favourite** | **Boolean** | Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering | +**Name** | **String** | Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search | [optional] +**Tags** | **String[]** | Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. | [optional] +**TeamAccess** | **Boolean** | Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/ | +**InboxType** | **String** | Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). | [optional] +**VirtualInbox** | **Boolean** | Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. | +**ExpiresAt** | **String** | Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. | [optional] +**FunctionsAs** | **String** | Inbox function if used as a primitive for another system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$InboxPreview = Initialize-maislurp-client-powershellInboxPreview -Id null ` + -DomainId null ` + -EmailAddress null ` + -CreatedAt null ` + -Favourite null ` + -Name null ` + -Tags null ` + -TeamAccess null ` + -InboxType null ` + -VirtualInbox null ` + -ExpiresAt null ` + -FunctionsAs null +``` + +- Convert the resource to JSON +```powershell +$InboxPreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxReplierControllerApi.md b/docs/InboxReplierControllerApi.md new file mode 100644 index 00000000..17e606c6 --- /dev/null +++ b/docs/InboxReplierControllerApi.md @@ -0,0 +1,392 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.InboxReplierControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-NewInboxReplier**](InboxReplierControllerApi#New-NewInboxReplier) | **POST** /repliers | Create an inbox replier +[**Invoke-DeleteInboxReplier**](InboxReplierControllerApi#Invoke-DeleteInboxReplier) | **DELETE** /repliers/{id} | Delete an inbox replier +[**Invoke-DeleteInboxRepliers**](InboxReplierControllerApi#Invoke-DeleteInboxRepliers) | **DELETE** /repliers | Delete inbox repliers +[**Get-InboxReplier**](InboxReplierControllerApi#Get-InboxReplier) | **GET** /repliers/{id} | Get an inbox replier +[**Get-InboxReplierEvents**](InboxReplierControllerApi#Get-InboxReplierEvents) | **GET** /repliers/{id}/events | Get an inbox replier event list +[**Get-InboxRepliers**](InboxReplierControllerApi#Get-InboxRepliers) | **GET** /repliers | List inbox repliers +[**Update-InboxReplier**](InboxReplierControllerApi#Update-InboxReplier) | **PUT** /repliers/{id} | Update an inbox replier + + + +# **New-NewInboxReplier** +> InboxReplierDto New-NewInboxReplier
+>         [-CreateInboxReplierOptions]
+ +Create an inbox replier + +Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateInboxReplierOptions = (Initialize-CreateInboxReplierOptions -InboxId "InboxId_example" -Name "Name_example" -Field "RECIPIENTS" -Match "Match_example" -ReplyTo "ReplyTo_example" -Subject "Subject_example" -VarFrom "VarFrom_example" -Charset "Charset_example" -IgnoreReplyTo $false -IsHTML $false -Body "Body_example" -TemplateId "TemplateId_example" -TemplateVariables "TODO") # CreateInboxReplierOptions | + +# Create an inbox replier +try { + $Result = New-NewInboxReplier -CreateInboxReplierOptions $CreateInboxReplierOptions +} catch { + Write-Host ("Exception occured when calling New-NewInboxReplier: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateInboxReplierOptions** | [**CreateInboxReplierOptions**](CreateInboxReplierOptions)| | + +### Return type + +[**InboxReplierDto**](InboxReplierDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInboxReplier** +> void Invoke-DeleteInboxReplier
+>         [-Id]
+ +Delete an inbox replier + +Delete inbox replier + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox replier + +# Delete an inbox replier +try { + $Result = Invoke-DeleteInboxReplier -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInboxReplier: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox replier | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInboxRepliers** +> void Invoke-DeleteInboxRepliers
+>         [-InboxId]
+ +Delete inbox repliers + +Delete inbox repliers. Accepts optional inboxId filter. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox id to attach replier to (optional) + +# Delete inbox repliers +try { + $Result = Invoke-DeleteInboxRepliers -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInboxRepliers: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox id to attach replier to | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxReplier** +> InboxReplierDto Get-InboxReplier
+>         [-Id]
+ +Get an inbox replier + +Get inbox ruleset + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox replier + +# Get an inbox replier +try { + $Result = Get-InboxReplier -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-InboxReplier: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox replier | + +### Return type + +[**InboxReplierDto**](InboxReplierDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxReplierEvents** +> PageInboxReplierEvents Get-InboxReplierEvents
+>         [-Id]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+ +Get an inbox replier event list + +Get inbox ruleset events + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox replier +$Page = 987 # Int32 | Optional page index in inbox replier event list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox replier event list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") + +# Get an inbox replier event list +try { + $Result = Get-InboxReplierEvents -Id $Id -Page $Page -Size $Size -Sort $Sort +} catch { + Write-Host ("Exception occured when calling Get-InboxReplierEvents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox replier | + **Page** | **Int32**| Optional page index in inbox replier event list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox replier event list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + +### Return type + +[**PageInboxReplierEvents**](PageInboxReplierEvents) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxRepliers** +> PageInboxReplierDto Get-InboxRepliers
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +List inbox repliers + +List all repliers attached to an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox id to get repliers from (optional) +$Page = 987 # Int32 | Optional page index in inbox replier list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox replier list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List inbox repliers +try { + $Result = Get-InboxRepliers -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-InboxRepliers: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox id to get repliers from | [optional] + **Page** | **Int32**| Optional page index in inbox replier list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox replier list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageInboxReplierDto**](PageInboxReplierDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-InboxReplier** +> InboxReplierDto Update-InboxReplier
+>         [-Id]
+>         [-UpdateInboxReplierOptions]
+ +Update an inbox replier + +Update inbox ruleset + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox replier +$UpdateInboxReplierOptions = (Initialize-UpdateInboxReplierOptions -InboxId "InboxId_example" -Name "Name_example" -Field "RECIPIENTS" -Match "Match_example" -ReplyTo "ReplyTo_example" -Subject "Subject_example" -VarFrom "VarFrom_example" -Charset "Charset_example" -IsHTML $false -IgnoreReplyTo $false -Body "Body_example" -TemplateId "TemplateId_example" -TemplateVariables "TODO") # UpdateInboxReplierOptions | + +# Update an inbox replier +try { + $Result = Update-InboxReplier -Id $Id -UpdateInboxReplierOptions $UpdateInboxReplierOptions +} catch { + Write-Host ("Exception occured when calling Update-InboxReplier: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox replier | + **UpdateInboxReplierOptions** | [**UpdateInboxReplierOptions**](UpdateInboxReplierOptions)| | + +### Return type + +[**InboxReplierDto**](InboxReplierDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/InboxReplierDto.md b/docs/InboxReplierDto.md new file mode 100644 index 00000000..974215f8 --- /dev/null +++ b/docs/InboxReplierDto.md @@ -0,0 +1,47 @@ +# InboxReplierDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**InboxId** | **String** | | +**Name** | **String** | | [optional] +**Field** | **String** | | +**Match** | **String** | | +**ReplyTo** | **String** | | [optional] +**Subject** | **String** | | [optional] +**VarFrom** | **String** | | [optional] +**Charset** | **String** | | [optional] +**IsHTML** | **Boolean** | | +**TemplateId** | **String** | | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | | [optional] +**IgnoreReplyTo** | **Boolean** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$InboxReplierDto = Initialize-maislurp-client-powershellInboxReplierDto -Id null ` + -InboxId null ` + -Name null ` + -Field null ` + -Match null ` + -ReplyTo null ` + -Subject null ` + -VarFrom null ` + -Charset null ` + -IsHTML null ` + -TemplateId null ` + -TemplateVariables null ` + -IgnoreReplyTo null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$InboxReplierDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxReplierEventProjection.md b/docs/InboxReplierEventProjection.md new file mode 100644 index 00000000..7873b8be --- /dev/null +++ b/docs/InboxReplierEventProjection.md @@ -0,0 +1,39 @@ +# InboxReplierEventProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recipients** | **String[]** | | [optional] +**EmailId** | **String** | | [optional] +**InboxId** | **String** | | [optional] +**UserId** | **String** | | [optional] +**SentId** | **String** | | [optional] +**ReplierId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Message** | **String** | | [optional] +**Id** | **String** | | [optional] +**Status** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$InboxReplierEventProjection = Initialize-maislurp-client-powershellInboxReplierEventProjection -Recipients null ` + -EmailId null ` + -InboxId null ` + -UserId null ` + -SentId null ` + -ReplierId null ` + -CreatedAt null ` + -Message null ` + -Id null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$InboxReplierEventProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxRulesetControllerApi.md b/docs/InboxRulesetControllerApi.md new file mode 100644 index 00000000..12ab3a1e --- /dev/null +++ b/docs/InboxRulesetControllerApi.md @@ -0,0 +1,545 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.InboxRulesetControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-NewInboxRuleset**](InboxRulesetControllerApi#New-NewInboxRuleset) | **POST** /rulesets | Create an inbox ruleset +[**Invoke-DeleteInboxRuleset**](InboxRulesetControllerApi#Invoke-DeleteInboxRuleset) | **DELETE** /rulesets/{id} | Delete an inbox ruleset +[**Invoke-DeleteInboxRulesets**](InboxRulesetControllerApi#Invoke-DeleteInboxRulesets) | **DELETE** /rulesets | Delete inbox rulesets +[**Get-InboxRuleset**](InboxRulesetControllerApi#Get-InboxRuleset) | **GET** /rulesets/{id} | Get an inbox ruleset +[**Get-InboxRulesets**](InboxRulesetControllerApi#Get-InboxRulesets) | **GET** /rulesets | List inbox rulesets +[**Test-InboxRuleset**](InboxRulesetControllerApi#Test-InboxRuleset) | **POST** /rulesets/{id}/test | Test an inbox ruleset +[**Test-InboxRulesetReceiving**](InboxRulesetControllerApi#Test-InboxRulesetReceiving) | **POST** /rulesets/test-receiving | Test receiving with inbox rulesets +[**Test-InboxRulesetSending**](InboxRulesetControllerApi#Test-InboxRulesetSending) | **POST** /rulesets/test-sending | Test sending with inbox rulesets +[**Test-InboxRulesetsForInbox**](InboxRulesetControllerApi#Test-InboxRulesetsForInbox) | **PUT** /rulesets | Test inbox rulesets for inbox +[**Test-NewInboxRuleset**](InboxRulesetControllerApi#Test-NewInboxRuleset) | **PATCH** /rulesets | Test new inbox ruleset + + + +# **New-NewInboxRuleset** +> InboxRulesetDto New-NewInboxRuleset
+>         [-CreateInboxRulesetOptions]
+>         [-InboxId]
+ +Create an inbox ruleset + +Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateInboxRulesetOptions = (Initialize-CreateInboxRulesetOptions -Scope "RECEIVING_EMAILS" -Action "BLOCK" -Target "Target_example") # CreateInboxRulesetOptions | +$InboxId = "InboxId_example" # String | Inbox id to attach ruleset to (optional) + +# Create an inbox ruleset +try { + $Result = New-NewInboxRuleset -CreateInboxRulesetOptions $CreateInboxRulesetOptions -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling New-NewInboxRuleset: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateInboxRulesetOptions** | [**CreateInboxRulesetOptions**](CreateInboxRulesetOptions)| | + **InboxId** | [**String**](String)| Inbox id to attach ruleset to | [optional] + +### Return type + +[**InboxRulesetDto**](InboxRulesetDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInboxRuleset** +> void Invoke-DeleteInboxRuleset
+>         [-Id]
+ +Delete an inbox ruleset + +Delete inbox ruleset + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox ruleset + +# Delete an inbox ruleset +try { + $Result = Invoke-DeleteInboxRuleset -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInboxRuleset: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox ruleset | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteInboxRulesets** +> void Invoke-DeleteInboxRulesets
+>         [-InboxId]
+ +Delete inbox rulesets + +Delete inbox rulesets. Accepts optional inboxId filter. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox id to attach ruleset to (optional) + +# Delete inbox rulesets +try { + $Result = Invoke-DeleteInboxRulesets -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteInboxRulesets: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox id to attach ruleset to | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxRuleset** +> InboxRulesetDto Get-InboxRuleset
+>         [-Id]
+ +Get an inbox ruleset + +Get inbox ruleset + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox ruleset + +# Get an inbox ruleset +try { + $Result = Get-InboxRuleset -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-InboxRuleset: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox ruleset | + +### Return type + +[**InboxRulesetDto**](InboxRulesetDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxRulesets** +> PageInboxRulesetDto Get-InboxRulesets
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +List inbox rulesets + +List all rulesets attached to an inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inbox id to get rulesets from (optional) +$Page = 987 # Int32 | Optional page index in inbox ruleset list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox ruleset list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List inbox rulesets +try { + $Result = Get-InboxRulesets -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-InboxRulesets: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inbox id to get rulesets from | [optional] + **Page** | **Int32**| Optional page index in inbox ruleset list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox ruleset list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageInboxRulesetDto**](PageInboxRulesetDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-InboxRuleset** +> InboxRulesetTestResult Test-InboxRuleset
+>         [-Id]
+>         [-InboxRulesetTestOptions]
+ +Test an inbox ruleset + +Test an inbox ruleset + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | ID of inbox ruleset +$InboxRulesetTestOptions = (Initialize-InboxRulesetTestOptions -TestTarget "TestTarget_example") # InboxRulesetTestOptions | + +# Test an inbox ruleset +try { + $Result = Test-InboxRuleset -Id $Id -InboxRulesetTestOptions $InboxRulesetTestOptions +} catch { + Write-Host ("Exception occured when calling Test-InboxRuleset: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| ID of inbox ruleset | + **InboxRulesetTestOptions** | [**InboxRulesetTestOptions**](InboxRulesetTestOptions)| | + +### Return type + +[**InboxRulesetTestResult**](InboxRulesetTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-InboxRulesetReceiving** +> TestInboxRulesetReceivingResult Test-InboxRulesetReceiving
+>         [-TestInboxRulesetReceivingOptions]
+ +Test receiving with inbox rulesets + +Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TestInboxRulesetReceivingOptions = (Initialize-TestInboxRulesetReceivingOptions -InboxId "InboxId_example" -FromSender "FromSender_example") # TestInboxRulesetReceivingOptions | + +# Test receiving with inbox rulesets +try { + $Result = Test-InboxRulesetReceiving -TestInboxRulesetReceivingOptions $TestInboxRulesetReceivingOptions +} catch { + Write-Host ("Exception occured when calling Test-InboxRulesetReceiving: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TestInboxRulesetReceivingOptions** | [**TestInboxRulesetReceivingOptions**](TestInboxRulesetReceivingOptions)| | + +### Return type + +[**TestInboxRulesetReceivingResult**](TestInboxRulesetReceivingResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-InboxRulesetSending** +> TestInboxRulesetSendingResult Test-InboxRulesetSending
+>         [-TestInboxRulesetSendingOptions]
+ +Test sending with inbox rulesets + +Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TestInboxRulesetSendingOptions = (Initialize-TestInboxRulesetSendingOptions -InboxId "InboxId_example" -Recipient "Recipient_example") # TestInboxRulesetSendingOptions | + +# Test sending with inbox rulesets +try { + $Result = Test-InboxRulesetSending -TestInboxRulesetSendingOptions $TestInboxRulesetSendingOptions +} catch { + Write-Host ("Exception occured when calling Test-InboxRulesetSending: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TestInboxRulesetSendingOptions** | [**TestInboxRulesetSendingOptions**](TestInboxRulesetSendingOptions)| | + +### Return type + +[**TestInboxRulesetSendingResult**](TestInboxRulesetSendingResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-InboxRulesetsForInbox** +> InboxRulesetTestResult Test-InboxRulesetsForInbox
+>         [-InboxId]
+>         [-InboxRulesetTestOptions]
+ +Test inbox rulesets for inbox + +Test inbox rulesets for inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | ID of inbox +$InboxRulesetTestOptions = (Initialize-InboxRulesetTestOptions -TestTarget "TestTarget_example") # InboxRulesetTestOptions | + +# Test inbox rulesets for inbox +try { + $Result = Test-InboxRulesetsForInbox -InboxId $InboxId -InboxRulesetTestOptions $InboxRulesetTestOptions +} catch { + Write-Host ("Exception occured when calling Test-InboxRulesetsForInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| ID of inbox | + **InboxRulesetTestOptions** | [**InboxRulesetTestOptions**](InboxRulesetTestOptions)| | + +### Return type + +[**InboxRulesetTestResult**](InboxRulesetTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-NewInboxRuleset** +> InboxRulesetTestResult Test-NewInboxRuleset
+>         [-TestNewInboxRulesetOptions]
+ +Test new inbox ruleset + +Test new inbox ruleset + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TestNewInboxRulesetOptions = (Initialize-TestNewInboxRulesetOptions -InboxRulesetTestOptions -CreateInboxRulesetOptions (Initialize-CreateInboxRulesetOptions -Scope "RECEIVING_EMAILS" -Action "BLOCK" -Target "Target_example")) # TestNewInboxRulesetOptions | + +# Test new inbox ruleset +try { + $Result = Test-NewInboxRuleset -TestNewInboxRulesetOptions $TestNewInboxRulesetOptions +} catch { + Write-Host ("Exception occured when calling Test-NewInboxRuleset: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TestNewInboxRulesetOptions** | [**TestNewInboxRulesetOptions**](TestNewInboxRulesetOptions)| | + +### Return type + +[**InboxRulesetTestResult**](InboxRulesetTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/InboxRulesetDto.md b/docs/InboxRulesetDto.md new file mode 100644 index 00000000..d9ecbfc1 --- /dev/null +++ b/docs/InboxRulesetDto.md @@ -0,0 +1,33 @@ +# InboxRulesetDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**InboxId** | **String** | | [optional] +**Scope** | **String** | | +**Action** | **String** | | +**Target** | **String** | | +**Handler** | **String** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$InboxRulesetDto = Initialize-maislurp-client-powershellInboxRulesetDto -Id null ` + -InboxId null ` + -Scope null ` + -Action null ` + -Target null ` + -Handler null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$InboxRulesetDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxRulesetTestOptions.md b/docs/InboxRulesetTestOptions.md new file mode 100644 index 00000000..ad93e533 --- /dev/null +++ b/docs/InboxRulesetTestOptions.md @@ -0,0 +1,21 @@ +# InboxRulesetTestOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TestTarget** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$InboxRulesetTestOptions = Initialize-maislurp-client-powershellInboxRulesetTestOptions -TestTarget null +``` + +- Convert the resource to JSON +```powershell +$InboxRulesetTestOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InboxRulesetTestResult.md b/docs/InboxRulesetTestResult.md new file mode 100644 index 00000000..4bf4cc03 --- /dev/null +++ b/docs/InboxRulesetTestResult.md @@ -0,0 +1,23 @@ +# InboxRulesetTestResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RulesetMatches** | **System.Collections.Hashtable** | Map of inbox ruleset ID to boolean of if target matches | +**VarMatches** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$InboxRulesetTestResult = Initialize-maislurp-client-powershellInboxRulesetTestResult -RulesetMatches null ` + -VarMatches null +``` + +- Convert the resource to JSON +```powershell +$InboxRulesetTestResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/InlineObject.md b/docs/InlineObject.md new file mode 100644 index 00000000..b35e67b1 --- /dev/null +++ b/docs/InlineObject.md @@ -0,0 +1,23 @@ +# InlineObject +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContentTypeHeader** | **String** | Optional content type header of attachment | [optional] +**File** | **System.IO.FileInfo** | | + +## Examples + +- Prepare the resource +```powershell +$InlineObject = Initialize-maislurp-client-powershellInlineObject -ContentTypeHeader null ` + -File null +``` + +- Convert the resource to JSON +```powershell +$InlineObject | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/JSONSchemaDto.md b/docs/JSONSchemaDto.md new file mode 100644 index 00000000..bc769fe1 --- /dev/null +++ b/docs/JSONSchemaDto.md @@ -0,0 +1,21 @@ +# JSONSchemaDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$JSONSchemaDto = Initialize-maislurp-client-powershellJSONSchemaDto -Value null +``` + +- Convert the resource to JSON +```powershell +$JSONSchemaDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LinkIssue.md b/docs/LinkIssue.md new file mode 100644 index 00000000..1541538f --- /dev/null +++ b/docs/LinkIssue.md @@ -0,0 +1,27 @@ +# LinkIssue +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | | +**ResponseStatus** | **Int32** | | [optional] +**Severity** | **String** | | +**Message** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$LinkIssue = Initialize-maislurp-client-powershellLinkIssue -Url null ` + -ResponseStatus null ` + -Severity null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$LinkIssue | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ListUnsubscribeRecipientProjection.md b/docs/ListUnsubscribeRecipientProjection.md new file mode 100644 index 00000000..a4d1fcdc --- /dev/null +++ b/docs/ListUnsubscribeRecipientProjection.md @@ -0,0 +1,27 @@ +# ListUnsubscribeRecipientProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | | +**DomainId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$ListUnsubscribeRecipientProjection = Initialize-maislurp-client-powershellListUnsubscribeRecipientProjection -EmailAddress null ` + -DomainId null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ListUnsubscribeRecipientProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupBimiDomainOptions.md b/docs/LookupBimiDomainOptions.md new file mode 100644 index 00000000..c5c71e4a --- /dev/null +++ b/docs/LookupBimiDomainOptions.md @@ -0,0 +1,21 @@ +# LookupBimiDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarHost** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$LookupBimiDomainOptions = Initialize-maislurp-client-powershellLookupBimiDomainOptions -VarHost null +``` + +- Convert the resource to JSON +```powershell +$LookupBimiDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupBimiDomainResults.md b/docs/LookupBimiDomainResults.md new file mode 100644 index 00000000..7bba103b --- /dev/null +++ b/docs/LookupBimiDomainResults.md @@ -0,0 +1,29 @@ +# LookupBimiDomainResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Valid** | **Boolean** | | +**Query** | [**DNSLookupOptions**](DNSLookupOptions) | | +**Records** | [**DNSLookupResult[]**](DNSLookupResult) | | +**Errors** | **String[]** | | +**Warnings** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$LookupBimiDomainResults = Initialize-maislurp-client-powershellLookupBimiDomainResults -Valid null ` + -Query null ` + -Records null ` + -Errors null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$LookupBimiDomainResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupDmarcDomainOptions.md b/docs/LookupDmarcDomainOptions.md new file mode 100644 index 00000000..d90a75d9 --- /dev/null +++ b/docs/LookupDmarcDomainOptions.md @@ -0,0 +1,21 @@ +# LookupDmarcDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarHost** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$LookupDmarcDomainOptions = Initialize-maislurp-client-powershellLookupDmarcDomainOptions -VarHost null +``` + +- Convert the resource to JSON +```powershell +$LookupDmarcDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupDmarcDomainResults.md b/docs/LookupDmarcDomainResults.md new file mode 100644 index 00000000..f215a363 --- /dev/null +++ b/docs/LookupDmarcDomainResults.md @@ -0,0 +1,29 @@ +# LookupDmarcDomainResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Valid** | **Boolean** | | +**Query** | [**DNSLookupOptions**](DNSLookupOptions) | | +**Records** | [**DNSLookupResult[]**](DNSLookupResult) | | +**Errors** | **String[]** | | +**Warnings** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$LookupDmarcDomainResults = Initialize-maislurp-client-powershellLookupDmarcDomainResults -Valid null ` + -Query null ` + -Records null ` + -Errors null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$LookupDmarcDomainResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupMtaStsDomainOptions.md b/docs/LookupMtaStsDomainOptions.md new file mode 100644 index 00000000..40448b42 --- /dev/null +++ b/docs/LookupMtaStsDomainOptions.md @@ -0,0 +1,21 @@ +# LookupMtaStsDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarHost** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$LookupMtaStsDomainOptions = Initialize-maislurp-client-powershellLookupMtaStsDomainOptions -VarHost null +``` + +- Convert the resource to JSON +```powershell +$LookupMtaStsDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupMtaStsDomainResults.md b/docs/LookupMtaStsDomainResults.md new file mode 100644 index 00000000..eea85166 --- /dev/null +++ b/docs/LookupMtaStsDomainResults.md @@ -0,0 +1,35 @@ +# LookupMtaStsDomainResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Valid** | **Boolean** | | +**Query** | [**DNSLookupOptions**](DNSLookupOptions) | | +**Records** | [**DNSLookupResult[]**](DNSLookupResult) | | +**WellKnownQuery** | **String** | | +**WellKnownPresent** | **Boolean** | | +**WellKnownValue** | **String** | | +**Errors** | **String[]** | | +**Warnings** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$LookupMtaStsDomainResults = Initialize-maislurp-client-powershellLookupMtaStsDomainResults -Valid null ` + -Query null ` + -Records null ` + -WellKnownQuery null ` + -WellKnownPresent null ` + -WellKnownValue null ` + -Errors null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$LookupMtaStsDomainResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupTlsReportingDomainOptions.md b/docs/LookupTlsReportingDomainOptions.md new file mode 100644 index 00000000..ee17d940 --- /dev/null +++ b/docs/LookupTlsReportingDomainOptions.md @@ -0,0 +1,21 @@ +# LookupTlsReportingDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarHost** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$LookupTlsReportingDomainOptions = Initialize-maislurp-client-powershellLookupTlsReportingDomainOptions -VarHost null +``` + +- Convert the resource to JSON +```powershell +$LookupTlsReportingDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/LookupTlsReportingDomainResults.md b/docs/LookupTlsReportingDomainResults.md new file mode 100644 index 00000000..21af11b5 --- /dev/null +++ b/docs/LookupTlsReportingDomainResults.md @@ -0,0 +1,29 @@ +# LookupTlsReportingDomainResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Valid** | **Boolean** | | +**Query** | [**DNSLookupOptions**](DNSLookupOptions) | | +**Records** | [**DNSLookupResult[]**](DNSLookupResult) | | +**Errors** | **String[]** | | +**Warnings** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$LookupTlsReportingDomainResults = Initialize-maislurp-client-powershellLookupTlsReportingDomainResults -Valid null ` + -Query null ` + -Records null ` + -Errors null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$LookupTlsReportingDomainResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/MailServerControllerApi.md b/docs/MailServerControllerApi.md new file mode 100644 index 00000000..e59470be --- /dev/null +++ b/docs/MailServerControllerApi.md @@ -0,0 +1,253 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.MailServerControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-DescribeMailServerDomain**](MailServerControllerApi#Invoke-DescribeMailServerDomain) | **POST** /mail-server/describe/domain | Get DNS Mail Server records for a domain +[**Get-DnsLookup**](MailServerControllerApi#Get-DnsLookup) | **POST** /mail-server/describe/dns-lookup | Lookup DNS records for a domain +[**Get-DnsLookups**](MailServerControllerApi#Get-DnsLookups) | **POST** /mail-server/describe/dns-lookups | Lookup DNS records for multiple domains +[**Get-IpAddress**](MailServerControllerApi#Get-IpAddress) | **POST** /mail-server/describe/ip-address | Get IP address for a domain +[**Test-EmailAddress**](MailServerControllerApi#Test-EmailAddress) | **POST** /mail-server/verify/email-address | Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server. + + + +# **Invoke-DescribeMailServerDomain** +> DescribeMailServerDomainResult Invoke-DescribeMailServerDomain
+>         [-DescribeDomainOptions]
+ +Get DNS Mail Server records for a domain + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$DescribeDomainOptions = (Initialize-DescribeDomainOptions -Domain "Domain_example") # DescribeDomainOptions | + +# Get DNS Mail Server records for a domain +try { + $Result = Invoke-DescribeMailServerDomain -DescribeDomainOptions $DescribeDomainOptions +} catch { + Write-Host ("Exception occured when calling Invoke-DescribeMailServerDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **DescribeDomainOptions** | [**DescribeDomainOptions**](DescribeDomainOptions)| | + +### Return type + +[**DescribeMailServerDomainResult**](DescribeMailServerDomainResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-DnsLookup** +> DNSLookupResults Get-DnsLookup
+>         [-DNSLookupOptions]
+ +Lookup DNS records for a domain + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$DNSLookupOptions = (Initialize-DNSLookupOptions -Hostname "Hostname_example" -RecordTypes @("A") -OmitFinalDNSDot $false) # DNSLookupOptions | + +# Lookup DNS records for a domain +try { + $Result = Get-DnsLookup -DNSLookupOptions $DNSLookupOptions +} catch { + Write-Host ("Exception occured when calling Get-DnsLookup: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **DNSLookupOptions** | [**DNSLookupOptions**](DNSLookupOptions)| | + +### Return type + +[**DNSLookupResults**](DNSLookupResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-DnsLookups** +> DNSLookupResults Get-DnsLookups
+>         [-DNSLookupsOptions]
+ +Lookup DNS records for multiple domains + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$DNSLookupsOptions = (Initialize-DNSLookupsOptions -Lookups @((Initialize-DNSLookupOptions -Hostname "Hostname_example" -RecordTypes @("A") -OmitFinalDNSDot $false))) # DNSLookupsOptions | + +# Lookup DNS records for multiple domains +try { + $Result = Get-DnsLookups -DNSLookupsOptions $DNSLookupsOptions +} catch { + Write-Host ("Exception occured when calling Get-DnsLookups: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **DNSLookupsOptions** | [**DNSLookupsOptions**](DNSLookupsOptions)| | + +### Return type + +[**DNSLookupResults**](DNSLookupResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-IpAddress** +> IPAddressResult Get-IpAddress
+>         [-Name]
+ +Get IP address for a domain + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Name = "Name_example" # String | + +# Get IP address for a domain +try { + $Result = Get-IpAddress -Name $Name +} catch { + Write-Host ("Exception occured when calling Get-IpAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Name** | **String**| | + +### Return type + +[**IPAddressResult**](IPAddressResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-EmailAddress** +> EmailVerificationResult Test-EmailAddress
+>         [-VerifyEmailAddressOptions]
+ +Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$VerifyEmailAddressOptions = (Initialize-VerifyEmailAddressOptions -MailServerDomain "MailServerDomain_example" -EmailAddress "EmailAddress_example" -SenderEmailAddress "SenderEmailAddress_example" -Port 123) # VerifyEmailAddressOptions | + +# Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server. +try { + $Result = Test-EmailAddress -VerifyEmailAddressOptions $VerifyEmailAddressOptions +} catch { + Write-Host ("Exception occured when calling Test-EmailAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **VerifyEmailAddressOptions** | [**VerifyEmailAddressOptions**](VerifyEmailAddressOptions)| | + +### Return type + +[**EmailVerificationResult**](EmailVerificationResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/MatchOption.md b/docs/MatchOption.md new file mode 100644 index 00000000..2e41c9a8 --- /dev/null +++ b/docs/MatchOption.md @@ -0,0 +1,25 @@ +# MatchOption +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **String** | Fields of an email object that can be used to filter results | +**Should** | **String** | How the value of the email field specified should be compared to the value given in the match options. | +**Value** | **String** | The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed. | + +## Examples + +- Prepare the resource +```powershell +$MatchOption = Initialize-maislurp-client-powershellMatchOption -Field null ` + -Should null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$MatchOption | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/MatchOptions.md b/docs/MatchOptions.md new file mode 100644 index 00000000..d126fc53 --- /dev/null +++ b/docs/MatchOptions.md @@ -0,0 +1,23 @@ +# MatchOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarMatches** | [**MatchOption[]**](MatchOption) | Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results | [optional] +**Conditions** | [**ConditionOption[]**](ConditionOption) | Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`. Note the values are the strings `TRUE|FALSE` not booleans. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MatchOptions = Initialize-maislurp-client-powershellMatchOptions -VarMatches null ` + -Conditions null +``` + +- Convert the resource to JSON +```powershell +$MatchOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/MissedEmailControllerApi.md b/docs/MissedEmailControllerApi.md new file mode 100644 index 00000000..2b79e149 --- /dev/null +++ b/docs/MissedEmailControllerApi.md @@ -0,0 +1,304 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.MissedEmailControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-AllMissedEmails**](MissedEmailControllerApi#Get-AllMissedEmails) | **GET** /missed-emails | Get all MissedEmails in paginated format +[**Get-AllUnknownMissedEmails**](MissedEmailControllerApi#Get-AllUnknownMissedEmails) | **GET** /missed-emails/unknown | Get all unknown missed emails in paginated format +[**Get-MissedEmail**](MissedEmailControllerApi#Get-MissedEmail) | **GET** /missed-emails/{missedEmailId} | Get MissedEmail +[**Restore-MissedEmails**](MissedEmailControllerApi#Restore-MissedEmails) | **POST** /missed-emails/restore | Restore missed emails +[**Wait-ForNthMissedEmail**](MissedEmailControllerApi#Wait-ForNthMissedEmail) | **GET** /missed-emails/waitForNthMissedEmail | Wait for Nth missed email + + + +# **Get-AllMissedEmails** +> PageMissedEmailProjection Get-AllMissedEmails
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+>         [-InboxId]
+ +Get all MissedEmails in paginated format + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional) + +# Get all MissedEmails in paginated format +try { + $Result = Get-AllMissedEmails -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-AllMissedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **InboxId** | [**String**](String)| Optional inbox ID filter | [optional] + +### Return type + +[**PageMissedEmailProjection**](PageMissedEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllUnknownMissedEmails** +> PageUnknownMissedEmailProjection Get-AllUnknownMissedEmails
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+>         [-InboxId]
+ +Get all unknown missed emails in paginated format + +Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional) + +# Get all unknown missed emails in paginated format +try { + $Result = Get-AllUnknownMissedEmails -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-AllUnknownMissedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **InboxId** | [**String**](String)| Optional inbox ID filter | [optional] + +### Return type + +[**PageUnknownMissedEmailProjection**](PageUnknownMissedEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-MissedEmail** +> MissedEmailDto Get-MissedEmail
+>         [-MissedEmailId]
+ +Get MissedEmail + +List emails that were missed due to plan limits. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$MissedEmailId = "MissedEmailId_example" # String | + +# Get MissedEmail +try { + $Result = Get-MissedEmail -MissedEmailId $MissedEmailId +} catch { + Write-Host ("Exception occured when calling Get-MissedEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **MissedEmailId** | [**String**](String)| | + +### Return type + +[**MissedEmailDto**](MissedEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Restore-MissedEmails** +> void Restore-MissedEmails
+ +Restore missed emails + +If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Restore missed emails +try { + $Result = Restore-MissedEmails +} catch { + Write-Host ("Exception occured when calling Restore-MissedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForNthMissedEmail** +> MissedEmailDto Wait-ForNthMissedEmail
+>         [-Index]
+>         [-InboxId]
+>         [-Timeout]
+>         [-Since]
+>         [-Before]
+ +Wait for Nth missed email + +Wait for 0 based index missed email + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Index = 987 # Int32 | Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 +$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional) +$Timeout = 987 # Int64 | Optional timeout milliseconds (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Wait for Nth missed email +try { + $Result = Wait-ForNthMissedEmail -Index $Index -InboxId $InboxId -Timeout $Timeout -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Wait-ForNthMissedEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Index** | **Int32**| Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 | + **InboxId** | [**String**](String)| Optional inbox ID filter | [optional] + **Timeout** | **Int64**| Optional timeout milliseconds | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**MissedEmailDto**](MissedEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/MissedEmailDto.md b/docs/MissedEmailDto.md new file mode 100644 index 00000000..c7d8d01b --- /dev/null +++ b/docs/MissedEmailDto.md @@ -0,0 +1,51 @@ +# MissedEmailDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | [optional] +**Subject** | **String** | | [optional] +**BodyExcerpt** | **String** | | [optional] +**AttachmentCount** | **Int32** | | +**VarFrom** | **String** | | [optional] +**RawUrl** | **String** | | [optional] +**RawKey** | **String** | | [optional] +**RawBucket** | **String** | | [optional] +**CanRestore** | **Boolean** | | [optional] +**To** | **String[]** | | +**Cc** | **String[]** | | +**Bcc** | **String[]** | | +**InboxIds** | **String[]** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$MissedEmailDto = Initialize-maislurp-client-powershellMissedEmailDto -Id null ` + -UserId null ` + -Subject null ` + -BodyExcerpt null ` + -AttachmentCount null ` + -VarFrom null ` + -RawUrl null ` + -RawKey null ` + -RawBucket null ` + -CanRestore null ` + -To null ` + -Cc null ` + -Bcc null ` + -InboxIds null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$MissedEmailDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/MissedEmailProjection.md b/docs/MissedEmailProjection.md new file mode 100644 index 00000000..a4082c0a --- /dev/null +++ b/docs/MissedEmailProjection.md @@ -0,0 +1,29 @@ +# MissedEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Subject** | **String** | | [optional] +**Id** | **String** | | +**VarFrom** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$MissedEmailProjection = Initialize-maislurp-client-powershellMissedEmailProjection -UserId null ` + -CreatedAt null ` + -Subject null ` + -Id null ` + -VarFrom null +``` + +- Convert the resource to JSON +```powershell +$MissedEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/NameServerRecord.md b/docs/NameServerRecord.md new file mode 100644 index 00000000..49634e41 --- /dev/null +++ b/docs/NameServerRecord.md @@ -0,0 +1,27 @@ +# NameServerRecord +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Raw** | **String** | | +**RecordType** | **String** | | +**Priority** | **String** | | +**Value** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$NameServerRecord = Initialize-maislurp-client-powershellNameServerRecord -Raw null ` + -RecordType null ` + -Priority null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$NameServerRecord | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/NewFakeEmailAddressResult.md b/docs/NewFakeEmailAddressResult.md new file mode 100644 index 00000000..fa328f49 --- /dev/null +++ b/docs/NewFakeEmailAddressResult.md @@ -0,0 +1,21 @@ +# NewFakeEmailAddressResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$NewFakeEmailAddressResult = Initialize-maislurp-client-powershellNewFakeEmailAddressResult -EmailAddress null +``` + +- Convert the resource to JSON +```powershell +$NewFakeEmailAddressResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/OrganizationInboxProjection.md b/docs/OrganizationInboxProjection.md new file mode 100644 index 00000000..83c52c49 --- /dev/null +++ b/docs/OrganizationInboxProjection.md @@ -0,0 +1,43 @@ +# OrganizationInboxProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. | +**DomainId** | **String** | ID of custom domain used by the inbox if any | [optional] +**CreatedAt** | **System.DateTime** | When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. | +**Name** | **String** | Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search | [optional] +**EmailAddress** | **String** | The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. | [optional] +**Favourite** | **Boolean** | Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering | +**Tags** | **String[]** | Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. | [optional] +**TeamAccess** | **Boolean** | Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/ | +**InboxType** | **String** | Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). | [optional] +**ReadOnly** | **Boolean** | Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes. | +**VirtualInbox** | **Boolean** | Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. | +**FunctionsAs** | **String** | Inbox function if used as a primitive for another system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OrganizationInboxProjection = Initialize-maislurp-client-powershellOrganizationInboxProjection -Id null ` + -DomainId null ` + -CreatedAt null ` + -Name null ` + -EmailAddress null ` + -Favourite null ` + -Tags null ` + -TeamAccess null ` + -InboxType null ` + -ReadOnly null ` + -VirtualInbox null ` + -FunctionsAs null +``` + +- Convert the resource to JSON +```powershell +$OrganizationInboxProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageAlias.md b/docs/PageAlias.md new file mode 100644 index 00000000..1ab66d88 --- /dev/null +++ b/docs/PageAlias.md @@ -0,0 +1,41 @@ +# PageAlias +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**AliasProjection[]**](AliasProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageAlias = Initialize-maislurp-client-powershellPageAlias -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageAlias | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageAttachmentEntity.md b/docs/PageAttachmentEntity.md new file mode 100644 index 00000000..b277157d --- /dev/null +++ b/docs/PageAttachmentEntity.md @@ -0,0 +1,41 @@ +# PageAttachmentEntity +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**AttachmentProjection[]**](AttachmentProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageAttachmentEntity = Initialize-maislurp-client-powershellPageAttachmentEntity -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageAttachmentEntity | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageBouncedEmail.md b/docs/PageBouncedEmail.md new file mode 100644 index 00000000..7c25c38c --- /dev/null +++ b/docs/PageBouncedEmail.md @@ -0,0 +1,41 @@ +# PageBouncedEmail +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**BounceProjection[]**](BounceProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageBouncedEmail = Initialize-maislurp-client-powershellPageBouncedEmail -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageBouncedEmail | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageBouncedRecipients.md b/docs/PageBouncedRecipients.md new file mode 100644 index 00000000..2ca21e4a --- /dev/null +++ b/docs/PageBouncedRecipients.md @@ -0,0 +1,41 @@ +# PageBouncedRecipients +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**BounceRecipientProjection[]**](BounceRecipientProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageBouncedRecipients = Initialize-maislurp-client-powershellPageBouncedRecipients -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageBouncedRecipients | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageComplaint.md b/docs/PageComplaint.md new file mode 100644 index 00000000..10104fb6 --- /dev/null +++ b/docs/PageComplaint.md @@ -0,0 +1,41 @@ +# PageComplaint +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**Complaint[]**](Complaint) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageComplaint = Initialize-maislurp-client-powershellPageComplaint -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageComplaint | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageConnector.md b/docs/PageConnector.md new file mode 100644 index 00000000..d05093af --- /dev/null +++ b/docs/PageConnector.md @@ -0,0 +1,41 @@ +# PageConnector +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ConnectorProjection[]**](ConnectorProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageConnector = Initialize-maislurp-client-powershellPageConnector -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageConnector | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageConnectorSyncEvents.md b/docs/PageConnectorSyncEvents.md new file mode 100644 index 00000000..56c929a4 --- /dev/null +++ b/docs/PageConnectorSyncEvents.md @@ -0,0 +1,41 @@ +# PageConnectorSyncEvents +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ConnectorSyncEventProjection[]**](ConnectorSyncEventProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageConnectorSyncEvents = Initialize-maislurp-client-powershellPageConnectorSyncEvents -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageConnectorSyncEvents | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageContactProjection.md b/docs/PageContactProjection.md new file mode 100644 index 00000000..9432e046 --- /dev/null +++ b/docs/PageContactProjection.md @@ -0,0 +1,41 @@ +# PageContactProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ContactProjection[]**](ContactProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageContactProjection = Initialize-maislurp-client-powershellPageContactProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageContactProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageDeliveryStatus.md b/docs/PageDeliveryStatus.md new file mode 100644 index 00000000..1031964a --- /dev/null +++ b/docs/PageDeliveryStatus.md @@ -0,0 +1,41 @@ +# PageDeliveryStatus +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**DeliveryStatusDto[]**](DeliveryStatusDto) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageDeliveryStatus = Initialize-maislurp-client-powershellPageDeliveryStatus -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageDeliveryStatus | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageEmailPreview.md b/docs/PageEmailPreview.md new file mode 100644 index 00000000..59b9374d --- /dev/null +++ b/docs/PageEmailPreview.md @@ -0,0 +1,41 @@ +# PageEmailPreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**EmailPreview[]**](EmailPreview) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageEmailPreview = Initialize-maislurp-client-powershellPageEmailPreview -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageEmailPreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageEmailProjection.md b/docs/PageEmailProjection.md new file mode 100644 index 00000000..7419cd7f --- /dev/null +++ b/docs/PageEmailProjection.md @@ -0,0 +1,41 @@ +# PageEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**EmailProjection[]**](EmailProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageEmailProjection = Initialize-maislurp-client-powershellPageEmailProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageEmailValidationRequest.md b/docs/PageEmailValidationRequest.md new file mode 100644 index 00000000..e1dc25f1 --- /dev/null +++ b/docs/PageEmailValidationRequest.md @@ -0,0 +1,41 @@ +# PageEmailValidationRequest +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**EmailValidationRequestDto[]**](EmailValidationRequestDto) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageEmailValidationRequest = Initialize-maislurp-client-powershellPageEmailValidationRequest -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageEmailValidationRequest | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageExpiredInboxRecordProjection.md b/docs/PageExpiredInboxRecordProjection.md new file mode 100644 index 00000000..2ad0dd57 --- /dev/null +++ b/docs/PageExpiredInboxRecordProjection.md @@ -0,0 +1,41 @@ +# PageExpiredInboxRecordProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ExpiredInboxRecordProjection[]**](ExpiredInboxRecordProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageExpiredInboxRecordProjection = Initialize-maislurp-client-powershellPageExpiredInboxRecordProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageExpiredInboxRecordProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageGroupProjection.md b/docs/PageGroupProjection.md new file mode 100644 index 00000000..0579c089 --- /dev/null +++ b/docs/PageGroupProjection.md @@ -0,0 +1,41 @@ +# PageGroupProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**GroupProjection[]**](GroupProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageGroupProjection = Initialize-maislurp-client-powershellPageGroupProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageGroupProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageInboxForwarderDto.md b/docs/PageInboxForwarderDto.md new file mode 100644 index 00000000..3e015c96 --- /dev/null +++ b/docs/PageInboxForwarderDto.md @@ -0,0 +1,41 @@ +# PageInboxForwarderDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**InboxForwarderDto[]**](InboxForwarderDto) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageInboxForwarderDto = Initialize-maislurp-client-powershellPageInboxForwarderDto -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageInboxForwarderDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageInboxForwarderEvents.md b/docs/PageInboxForwarderEvents.md new file mode 100644 index 00000000..3dabd0de --- /dev/null +++ b/docs/PageInboxForwarderEvents.md @@ -0,0 +1,41 @@ +# PageInboxForwarderEvents +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**InboxForwarderEventProjection[]**](InboxForwarderEventProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageInboxForwarderEvents = Initialize-maislurp-client-powershellPageInboxForwarderEvents -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageInboxForwarderEvents | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageInboxProjection.md b/docs/PageInboxProjection.md new file mode 100644 index 00000000..16983176 --- /dev/null +++ b/docs/PageInboxProjection.md @@ -0,0 +1,41 @@ +# PageInboxProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**InboxPreview[]**](InboxPreview) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageInboxProjection = Initialize-maislurp-client-powershellPageInboxProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageInboxProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageInboxReplierDto.md b/docs/PageInboxReplierDto.md new file mode 100644 index 00000000..83314cdd --- /dev/null +++ b/docs/PageInboxReplierDto.md @@ -0,0 +1,41 @@ +# PageInboxReplierDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**InboxReplierDto[]**](InboxReplierDto) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageInboxReplierDto = Initialize-maislurp-client-powershellPageInboxReplierDto -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageInboxReplierDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageInboxReplierEvents.md b/docs/PageInboxReplierEvents.md new file mode 100644 index 00000000..5b8a163a --- /dev/null +++ b/docs/PageInboxReplierEvents.md @@ -0,0 +1,41 @@ +# PageInboxReplierEvents +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**InboxReplierEventProjection[]**](InboxReplierEventProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageInboxReplierEvents = Initialize-maislurp-client-powershellPageInboxReplierEvents -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageInboxReplierEvents | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageInboxRulesetDto.md b/docs/PageInboxRulesetDto.md new file mode 100644 index 00000000..60b03b44 --- /dev/null +++ b/docs/PageInboxRulesetDto.md @@ -0,0 +1,41 @@ +# PageInboxRulesetDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**InboxRulesetDto[]**](InboxRulesetDto) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageInboxRulesetDto = Initialize-maislurp-client-powershellPageInboxRulesetDto -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageInboxRulesetDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageListUnsubscribeRecipients.md b/docs/PageListUnsubscribeRecipients.md new file mode 100644 index 00000000..3df0385c --- /dev/null +++ b/docs/PageListUnsubscribeRecipients.md @@ -0,0 +1,41 @@ +# PageListUnsubscribeRecipients +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ListUnsubscribeRecipientProjection[]**](ListUnsubscribeRecipientProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageListUnsubscribeRecipients = Initialize-maislurp-client-powershellPageListUnsubscribeRecipients -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageListUnsubscribeRecipients | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageMissedEmailProjection.md b/docs/PageMissedEmailProjection.md new file mode 100644 index 00000000..6208bc54 --- /dev/null +++ b/docs/PageMissedEmailProjection.md @@ -0,0 +1,41 @@ +# PageMissedEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**MissedEmailProjection[]**](MissedEmailProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageMissedEmailProjection = Initialize-maislurp-client-powershellPageMissedEmailProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageMissedEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageOrganizationInboxProjection.md b/docs/PageOrganizationInboxProjection.md new file mode 100644 index 00000000..df5d0d5c --- /dev/null +++ b/docs/PageOrganizationInboxProjection.md @@ -0,0 +1,41 @@ +# PageOrganizationInboxProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**OrganizationInboxProjection[]**](OrganizationInboxProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageOrganizationInboxProjection = Initialize-maislurp-client-powershellPageOrganizationInboxProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageOrganizationInboxProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PagePhoneNumberProjection.md b/docs/PagePhoneNumberProjection.md new file mode 100644 index 00000000..108cf940 --- /dev/null +++ b/docs/PagePhoneNumberProjection.md @@ -0,0 +1,41 @@ +# PagePhoneNumberProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**PhoneNumberProjection[]**](PhoneNumberProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PagePhoneNumberProjection = Initialize-maislurp-client-powershellPagePhoneNumberProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PagePhoneNumberProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageScheduledJobs.md b/docs/PageScheduledJobs.md new file mode 100644 index 00000000..4b0cf46a --- /dev/null +++ b/docs/PageScheduledJobs.md @@ -0,0 +1,41 @@ +# PageScheduledJobs +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ScheduledJob[]**](ScheduledJob) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageScheduledJobs = Initialize-maislurp-client-powershellPageScheduledJobs -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageScheduledJobs | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageSentEmailProjection.md b/docs/PageSentEmailProjection.md new file mode 100644 index 00000000..a443c0e6 --- /dev/null +++ b/docs/PageSentEmailProjection.md @@ -0,0 +1,41 @@ +# PageSentEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**SentEmailProjection[]**](SentEmailProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageSentEmailProjection = Initialize-maislurp-client-powershellPageSentEmailProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageSentEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageSentEmailWithQueueProjection.md b/docs/PageSentEmailWithQueueProjection.md new file mode 100644 index 00000000..c0114974 --- /dev/null +++ b/docs/PageSentEmailWithQueueProjection.md @@ -0,0 +1,41 @@ +# PageSentEmailWithQueueProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**SendWithQueueResult[]**](SendWithQueueResult) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageSentEmailWithQueueProjection = Initialize-maislurp-client-powershellPageSentEmailWithQueueProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageSentEmailWithQueueProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageSmsProjection.md b/docs/PageSmsProjection.md new file mode 100644 index 00000000..4c81b498 --- /dev/null +++ b/docs/PageSmsProjection.md @@ -0,0 +1,41 @@ +# PageSmsProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**SmsProjection[]**](SmsProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageSmsProjection = Initialize-maislurp-client-powershellPageSmsProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageSmsProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageTemplateProjection.md b/docs/PageTemplateProjection.md new file mode 100644 index 00000000..c77dd77b --- /dev/null +++ b/docs/PageTemplateProjection.md @@ -0,0 +1,41 @@ +# PageTemplateProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**TemplateProjection[]**](TemplateProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageTemplateProjection = Initialize-maislurp-client-powershellPageTemplateProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageTemplateProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageThreadProjection.md b/docs/PageThreadProjection.md new file mode 100644 index 00000000..a51b823d --- /dev/null +++ b/docs/PageThreadProjection.md @@ -0,0 +1,41 @@ +# PageThreadProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**ThreadProjection[]**](ThreadProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageThreadProjection = Initialize-maislurp-client-powershellPageThreadProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageThreadProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageTrackingPixelProjection.md b/docs/PageTrackingPixelProjection.md new file mode 100644 index 00000000..2164a7dc --- /dev/null +++ b/docs/PageTrackingPixelProjection.md @@ -0,0 +1,41 @@ +# PageTrackingPixelProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**TrackingPixelProjection[]**](TrackingPixelProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageTrackingPixelProjection = Initialize-maislurp-client-powershellPageTrackingPixelProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageTrackingPixelProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageUnknownMissedEmailProjection.md b/docs/PageUnknownMissedEmailProjection.md new file mode 100644 index 00000000..d4c167bf --- /dev/null +++ b/docs/PageUnknownMissedEmailProjection.md @@ -0,0 +1,41 @@ +# PageUnknownMissedEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**UnknownMissedEmailProjection[]**](UnknownMissedEmailProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageUnknownMissedEmailProjection = Initialize-maislurp-client-powershellPageUnknownMissedEmailProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageUnknownMissedEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageWebhookProjection.md b/docs/PageWebhookProjection.md new file mode 100644 index 00000000..40a96faf --- /dev/null +++ b/docs/PageWebhookProjection.md @@ -0,0 +1,41 @@ +# PageWebhookProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**WebhookProjection[]**](WebhookProjection) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageWebhookProjection = Initialize-maislurp-client-powershellPageWebhookProjection -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageWebhookProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageWebhookResult.md b/docs/PageWebhookResult.md new file mode 100644 index 00000000..c6e0a35c --- /dev/null +++ b/docs/PageWebhookResult.md @@ -0,0 +1,41 @@ +# PageWebhookResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | [**WebhookResultDto[]**](WebhookResultDto) | | [optional] +**Pageable** | [**PageableObject**](PageableObject) | | [optional] +**TotalPages** | **Int32** | | +**TotalElements** | **Int64** | | +**Last** | **Boolean** | | [optional] +**NumberOfElements** | **Int32** | | [optional] +**Size** | **Int32** | | [optional] +**Number** | **Int32** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] +**First** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageWebhookResult = Initialize-maislurp-client-powershellPageWebhookResult -Content null ` + -Pageable null ` + -TotalPages null ` + -TotalElements null ` + -Last null ` + -NumberOfElements null ` + -Size null ` + -Number null ` + -Sort null ` + -First null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$PageWebhookResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PageableObject.md b/docs/PageableObject.md new file mode 100644 index 00000000..f683ae6d --- /dev/null +++ b/docs/PageableObject.md @@ -0,0 +1,31 @@ +# PageableObject +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageNumber** | **Int32** | | [optional] +**PageSize** | **Int32** | | [optional] +**Paged** | **Boolean** | | [optional] +**Unpaged** | **Boolean** | | [optional] +**Offset** | **Int64** | | [optional] +**Sort** | [**SortObject**](SortObject) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PageableObject = Initialize-maislurp-client-powershellPageableObject -PageNumber null ` + -PageSize null ` + -Paged null ` + -Unpaged null ` + -Offset null ` + -Sort null +``` + +- Convert the resource to JSON +```powershell +$PageableObject | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PhoneControllerApi.md b/docs/PhoneControllerApi.md new file mode 100644 index 00000000..d7d13468 --- /dev/null +++ b/docs/PhoneControllerApi.md @@ -0,0 +1,451 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.PhoneControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-EmergencyAddress**](PhoneControllerApi#New-EmergencyAddress) | **POST** /phone/emergency-addresses | +[**Invoke-DeleteEmergencyAddress**](PhoneControllerApi#Invoke-DeleteEmergencyAddress) | **DELETE** /phone/emergency-addresses/{addressId} | +[**Invoke-DeletePhoneNumber**](PhoneControllerApi#Invoke-DeletePhoneNumber) | **DELETE** /phone/numbers/{phoneNumberId} | +[**Get-EmergencyAddress**](PhoneControllerApi#Get-EmergencyAddress) | **GET** /phone/emergency-addresses/{addressId} | +[**Get-EmergencyAddresses**](PhoneControllerApi#Get-EmergencyAddresses) | **GET** /phone/emergency-addresses | +[**Get-PhoneNumber**](PhoneControllerApi#Get-PhoneNumber) | **GET** /phone/numbers/{phoneNumberId} | +[**Get-PhoneNumbers**](PhoneControllerApi#Get-PhoneNumbers) | **GET** /phone/numbers | +[**Get-PhonePlans**](PhoneControllerApi#Get-PhonePlans) | **GET** /phone/plans | +[**Test-PhoneNumberSendSms**](PhoneControllerApi#Test-PhoneNumberSendSms) | **POST** /phone/numbers/{phoneNumberId}/test | + + + +# **New-EmergencyAddress** +> EmergencyAddress New-EmergencyAddress
+>         [-CreateEmergencyAddressOptions]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateEmergencyAddressOptions = (Initialize-CreateEmergencyAddressOptions -CustomerName "CustomerName_example" -Address1 "Address1_example" -City "City_example" -Region "Region_example" -PostalCode "PostalCode_example" -IsoCountryCode "US" -DisplayName "DisplayName_example") # CreateEmergencyAddressOptions | + +try { + $Result = New-EmergencyAddress -CreateEmergencyAddressOptions $CreateEmergencyAddressOptions +} catch { + Write-Host ("Exception occured when calling New-EmergencyAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateEmergencyAddressOptions** | [**CreateEmergencyAddressOptions**](CreateEmergencyAddressOptions)| | + +### Return type + +[**EmergencyAddress**](EmergencyAddress) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteEmergencyAddress** +> EmptyResponseDto Invoke-DeleteEmergencyAddress
+>         [-AddressId]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AddressId = "AddressId_example" # String | + +try { + $Result = Invoke-DeleteEmergencyAddress -AddressId $AddressId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteEmergencyAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AddressId** | [**String**](String)| | + +### Return type + +[**EmptyResponseDto**](EmptyResponseDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeletePhoneNumber** +> void Invoke-DeletePhoneNumber
+>         [-PhoneNumberId]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneNumberId = "PhoneNumberId_example" # String | + +try { + $Result = Invoke-DeletePhoneNumber -PhoneNumberId $PhoneNumberId +} catch { + Write-Host ("Exception occured when calling Invoke-DeletePhoneNumber: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneNumberId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmergencyAddress** +> EmergencyAddress Get-EmergencyAddress
+>         [-AddressId]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$AddressId = "AddressId_example" # String | + +try { + $Result = Get-EmergencyAddress -AddressId $AddressId +} catch { + Write-Host ("Exception occured when calling Get-EmergencyAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **AddressId** | [**String**](String)| | + +### Return type + +[**EmergencyAddress**](EmergencyAddress) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-EmergencyAddresses** +> EmergencyAddressDto[] Get-EmergencyAddresses
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-EmergencyAddresses +} catch { + Write-Host ("Exception occured when calling Get-EmergencyAddresses: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**EmergencyAddressDto[]**](EmergencyAddressDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-PhoneNumber** +> PhoneNumberDto Get-PhoneNumber
+>         [-PhoneNumberId]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneNumberId = "PhoneNumberId_example" # String | + +try { + $Result = Get-PhoneNumber -PhoneNumberId $PhoneNumberId +} catch { + Write-Host ("Exception occured when calling Get-PhoneNumber: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneNumberId** | [**String**](String)| | + +### Return type + +[**PhoneNumberDto**](PhoneNumberDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-PhoneNumbers** +> PagePhoneNumberProjection Get-PhoneNumbers
+>         [-PhoneCountry]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneCountry = "US" # String | Optional phone country (optional) +$Page = 987 # Int32 | Optional page index for list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size for list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-PhoneNumbers -PhoneCountry $PhoneCountry -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-PhoneNumbers: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneCountry** | **String**| Optional phone country | [optional] + **Page** | **Int32**| Optional page index for list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size for list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PagePhoneNumberProjection**](PagePhoneNumberProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-PhonePlans** +> PhonePlanDto[] Get-PhonePlans
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-PhonePlans +} catch { + Write-Host ("Exception occured when calling Get-PhonePlans: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**PhonePlanDto[]**](PhonePlanDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-PhoneNumberSendSms** +> void Test-PhoneNumberSendSms
+>         [-PhoneNumberId]
+>         [-TestPhoneNumberOptions]
+>         [-XTestId]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneNumberId = "PhoneNumberId_example" # String | +$TestPhoneNumberOptions = (Initialize-TestPhoneNumberOptions -Message "Message_example") # TestPhoneNumberOptions | +$XTestId = "XTestId_example" # String | (optional) + +try { + $Result = Test-PhoneNumberSendSms -PhoneNumberId $PhoneNumberId -TestPhoneNumberOptions $TestPhoneNumberOptions -XTestId $XTestId +} catch { + Write-Host ("Exception occured when calling Test-PhoneNumberSendSms: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneNumberId** | [**String**](String)| | + **TestPhoneNumberOptions** | [**TestPhoneNumberOptions**](TestPhoneNumberOptions)| | + **XTestId** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/PhoneNumberDto.md b/docs/PhoneNumberDto.md new file mode 100644 index 00000000..7ec95672 --- /dev/null +++ b/docs/PhoneNumberDto.md @@ -0,0 +1,37 @@ +# PhoneNumberDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**ComplianceAddress** | **String** | | [optional] +**EmergencyAddress** | **String** | | [optional] +**PhoneNumber** | **String** | | +**PhoneCountry** | **String** | | +**PhonePlan** | **String** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$PhoneNumberDto = Initialize-maislurp-client-powershellPhoneNumberDto -Id null ` + -UserId null ` + -ComplianceAddress null ` + -EmergencyAddress null ` + -PhoneNumber null ` + -PhoneCountry null ` + -PhonePlan null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$PhoneNumberDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PhoneNumberProjection.md b/docs/PhoneNumberProjection.md new file mode 100644 index 00000000..ce330c1e --- /dev/null +++ b/docs/PhoneNumberProjection.md @@ -0,0 +1,29 @@ +# PhoneNumberProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | | +**PhoneNumber** | **String** | | +**PhoneCountry** | **String** | | +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$PhoneNumberProjection = Initialize-maislurp-client-powershellPhoneNumberProjection -UserId null ` + -PhoneNumber null ` + -PhoneCountry null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$PhoneNumberProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/PhonePlanDto.md b/docs/PhonePlanDto.md new file mode 100644 index 00000000..51e99ed4 --- /dev/null +++ b/docs/PhonePlanDto.md @@ -0,0 +1,27 @@ +# PhonePlanDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**PhoneCountry** | **String** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$PhonePlanDto = Initialize-maislurp-client-powershellPhonePlanDto -Id null ` + -UserId null ` + -PhoneCountry null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$PhonePlanDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/RawEmailJson.md b/docs/RawEmailJson.md new file mode 100644 index 00000000..cf4e1a9d --- /dev/null +++ b/docs/RawEmailJson.md @@ -0,0 +1,21 @@ +# RawEmailJson +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$RawEmailJson = Initialize-maislurp-client-powershellRawEmailJson -Content null +``` + +- Convert the resource to JSON +```powershell +$RawEmailJson | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/Recipient.md b/docs/Recipient.md new file mode 100644 index 00000000..600a38e1 --- /dev/null +++ b/docs/Recipient.md @@ -0,0 +1,25 @@ +# Recipient +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RawValue** | **String** | | +**EmailAddress** | **String** | | +**Name** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Recipient = Initialize-maislurp-client-powershellRecipient -RawValue null ` + -EmailAddress null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$Recipient | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ReplyForSms.md b/docs/ReplyForSms.md new file mode 100644 index 00000000..dce6b76d --- /dev/null +++ b/docs/ReplyForSms.md @@ -0,0 +1,21 @@ +# ReplyForSms +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reply** | [**SentSmsDto**](SentSmsDto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReplyForSms = Initialize-maislurp-client-powershellReplyForSms -Reply null +``` + +- Convert the resource to JSON +```powershell +$ReplyForSms | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ReplyToAliasEmailOptions.md b/docs/ReplyToAliasEmailOptions.md new file mode 100644 index 00000000..c44f151f --- /dev/null +++ b/docs/ReplyToAliasEmailOptions.md @@ -0,0 +1,39 @@ +# ReplyToAliasEmailOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **String** | Body of the reply email you want to send | +**IsHTML** | **Boolean** | Is the reply HTML | +**Charset** | **String** | The charset that your message should be sent with. Optional. Default is UTF-8 | [optional] +**Attachments** | **String[]** | List of uploaded attachments to send with the reply. Optional. | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | Template variables if using a template | [optional] +**Template** | **String** | Template ID to use instead of body. Will use template variable map to fill defined variable slots. | [optional] +**SendStrategy** | **String** | How an email should be sent based on its recipients | [optional] +**CustomHeaders** | **System.Collections.Hashtable** | Optional custom headers | [optional] +**UseInboxName** | **Boolean** | Optionally use inbox name as display name for sender email address | [optional] +**Html** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReplyToAliasEmailOptions = Initialize-maislurp-client-powershellReplyToAliasEmailOptions -Body null ` + -IsHTML null ` + -Charset null ` + -Attachments null ` + -TemplateVariables null ` + -Template null ` + -SendStrategy null ` + -CustomHeaders null ` + -UseInboxName null ` + -Html null +``` + +- Convert the resource to JSON +```powershell +$ReplyToAliasEmailOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ReplyToEmailOptions.md b/docs/ReplyToEmailOptions.md new file mode 100644 index 00000000..63afb57f --- /dev/null +++ b/docs/ReplyToEmailOptions.md @@ -0,0 +1,43 @@ +# ReplyToEmailOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **String** | Body of the reply email you want to send | +**IsHTML** | **Boolean** | Is the reply HTML | +**VarFrom** | **String** | The from header that should be used. Optional | [optional] +**ReplyTo** | **String** | The replyTo header that should be used. Optional | [optional] +**CustomHeaders** | **System.Collections.Hashtable** | Optional custom headers | [optional] +**Charset** | **String** | The charset that your message should be sent with. Optional. Default is UTF-8 | [optional] +**Attachments** | **String[]** | List of uploaded attachments to send with the reply. Optional. | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | Template variables if using a template | [optional] +**Template** | **String** | Template ID to use instead of body. Will use template variable map to fill defined variable slots. | [optional] +**SendStrategy** | **String** | How an email should be sent based on its recipients | [optional] +**UseInboxName** | **Boolean** | Optionally use inbox name as display name for sender email address | [optional] +**Html** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReplyToEmailOptions = Initialize-maislurp-client-powershellReplyToEmailOptions -Body null ` + -IsHTML null ` + -VarFrom null ` + -ReplyTo null ` + -CustomHeaders null ` + -Charset null ` + -Attachments null ` + -TemplateVariables null ` + -Template null ` + -SendStrategy null ` + -UseInboxName null ` + -Html null +``` + +- Convert the resource to JSON +```powershell +$ReplyToEmailOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ScheduledJob.md b/docs/ScheduledJob.md new file mode 100644 index 00000000..db87f0d1 --- /dev/null +++ b/docs/ScheduledJob.md @@ -0,0 +1,39 @@ +# ScheduledJob +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**InboxId** | **String** | | +**JobId** | **String** | | +**GroupId** | **String** | | +**TriggerId** | **String** | | +**Status** | **String** | | +**SendAtTimestamp** | **System.DateTime** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$ScheduledJob = Initialize-maislurp-client-powershellScheduledJob -Id null ` + -UserId null ` + -InboxId null ` + -JobId null ` + -GroupId null ` + -TriggerId null ` + -Status null ` + -SendAtTimestamp null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$ScheduledJob | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ScheduledJobDto.md b/docs/ScheduledJobDto.md new file mode 100644 index 00000000..617d4a49 --- /dev/null +++ b/docs/ScheduledJobDto.md @@ -0,0 +1,39 @@ +# ScheduledJobDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**InboxId** | **String** | | +**JobId** | **String** | | +**GroupId** | **String** | | +**TriggerId** | **String** | | +**Status** | **String** | | +**SendAtTimestamp** | **System.DateTime** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$ScheduledJobDto = Initialize-maislurp-client-powershellScheduledJobDto -Id null ` + -UserId null ` + -InboxId null ` + -JobId null ` + -GroupId null ` + -TriggerId null ` + -Status null ` + -SendAtTimestamp null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$ScheduledJobDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SearchEmailsOptions.md b/docs/SearchEmailsOptions.md new file mode 100644 index 00000000..dc65ed9e --- /dev/null +++ b/docs/SearchEmailsOptions.md @@ -0,0 +1,35 @@ +# SearchEmailsOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxIds** | **String[]** | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] +**PageIndex** | **Int32** | Optional page index in email list pagination | [optional] +**PageSize** | **Int32** | Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results | [optional] +**SortDirection** | **String** | Optional createdAt sort direction ASC or DESC | [optional] +**UnreadOnly** | **Boolean** | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] +**SearchFilter** | **String** | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body | [optional] +**Since** | **System.DateTime** | Optional filter emails received after given date time | [optional] +**Before** | **System.DateTime** | Optional filter emails received before given date time | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchEmailsOptions = Initialize-maislurp-client-powershellSearchEmailsOptions -InboxIds null ` + -PageIndex null ` + -PageSize null ` + -SortDirection null ` + -UnreadOnly null ` + -SearchFilter null ` + -Since null ` + -Before null +``` + +- Convert the resource to JSON +```powershell +$SearchEmailsOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SearchInboxesOptions.md b/docs/SearchInboxesOptions.md new file mode 100644 index 00000000..44bbd607 --- /dev/null +++ b/docs/SearchInboxesOptions.md @@ -0,0 +1,41 @@ +# SearchInboxesOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageIndex** | **Int32** | Optional page index in list pagination | [optional] +**PageSize** | **Int32** | Optional page size in list pagination | [optional] +**SortDirection** | **String** | Optional createdAt sort direction ASC or DESC | [optional] +**Favourite** | **Boolean** | Optionally filter results for favourites only | [optional] +**Search** | **String** | Optionally filter by search words partial matching ID, tags, name, and email address | [optional] +**Tag** | **String** | Optionally filter by tags. Will return inboxes that include given tags | [optional] +**Since** | **System.DateTime** | Optional filter by created after given date time | [optional] +**Before** | **System.DateTime** | Optional filter by created before given date time | [optional] +**InboxType** | **String** | Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). | [optional] +**InboxFunction** | **String** | Optional filter by inbox function | [optional] +**DomainId** | **String** | Optional domain ID filter | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchInboxesOptions = Initialize-maislurp-client-powershellSearchInboxesOptions -PageIndex null ` + -PageSize null ` + -SortDirection null ` + -Favourite null ` + -Search null ` + -Tag null ` + -Since null ` + -Before null ` + -InboxType null ` + -InboxFunction null ` + -DomainId null +``` + +- Convert the resource to JSON +```powershell +$SearchInboxesOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SendEmailBodyPart.md b/docs/SendEmailBodyPart.md new file mode 100644 index 00000000..45e8d591 --- /dev/null +++ b/docs/SendEmailBodyPart.md @@ -0,0 +1,23 @@ +# SendEmailBodyPart +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContentType** | **String** | | +**ContentBody** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$SendEmailBodyPart = Initialize-maislurp-client-powershellSendEmailBodyPart -ContentType null ` + -ContentBody null +``` + +- Convert the resource to JSON +```powershell +$SendEmailBodyPart | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SendEmailOptions.md b/docs/SendEmailOptions.md new file mode 100644 index 00000000..ad57227b --- /dev/null +++ b/docs/SendEmailOptions.md @@ -0,0 +1,67 @@ +# SendEmailOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ToContacts** | **String[]** | Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. | [optional] +**ToGroup** | **String** | Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients | [optional] +**To** | **String[]** | List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. | [optional] +**VarFrom** | **String** | Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used. | [optional] +**Cc** | **String[]** | Optional list of cc destination email addresses | [optional] +**Bcc** | **String[]** | Optional list of bcc destination email addresses | [optional] +**Subject** | **String** | Optional email subject line | [optional] +**ReplyTo** | **String** | Optional replyTo header | [optional] +**CustomHeaders** | **System.Collections.Hashtable** | Optional custom headers | [optional] +**Body** | **String** | Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. | [optional] +**Html** | **Boolean** | Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) | [optional] +**IsHTML** | **Boolean** | Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients | [optional] +**Charset** | **String** | Optional charset | [optional] +**Attachments** | **String[]** | Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. | [optional] +**Template** | **String** | Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. | [optional] +**SendStrategy** | **String** | How an email should be sent based on its recipients | [optional] +**UseInboxName** | **Boolean** | Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name. | [optional] +**AddTrackingPixel** | **Boolean** | Add tracking pixel to email | [optional] +**FilterBouncedRecipients** | **Boolean** | Filter recipients to remove any bounced recipients from to, bcc, and cc before sending | [optional] +**ValidateEmailAddresses** | **String** | Validate recipient email addresses before sending | [optional] +**IgnoreEmptyRecipients** | **Boolean** | Ignore empty recipients after validation removes all recipients as invalid and fail silently | [optional] +**IsXAmpHtml** | **Boolean** | Is content AMP4EMAIL compatible. If set will send as x-amp-html part. | [optional] +**BodyParts** | [**SendEmailBodyPart[]**](SendEmailBodyPart) | Email body content parts for multipart mime message. Will override body. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SendEmailOptions = Initialize-maislurp-client-powershellSendEmailOptions -ToContacts null ` + -ToGroup null ` + -To null ` + -VarFrom null ` + -Cc null ` + -Bcc null ` + -Subject null ` + -ReplyTo null ` + -CustomHeaders null ` + -Body null ` + -Html null ` + -IsHTML null ` + -Charset null ` + -Attachments null ` + -TemplateVariables null ` + -Template null ` + -SendStrategy null ` + -UseInboxName null ` + -AddTrackingPixel null ` + -FilterBouncedRecipients null ` + -ValidateEmailAddresses null ` + -IgnoreEmptyRecipients null ` + -IsXAmpHtml null ` + -BodyParts null +``` + +- Convert the resource to JSON +```powershell +$SendEmailOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SendSMTPEnvelopeOptions.md b/docs/SendSMTPEnvelopeOptions.md new file mode 100644 index 00000000..7a26f30e --- /dev/null +++ b/docs/SendSMTPEnvelopeOptions.md @@ -0,0 +1,25 @@ +# SendSMTPEnvelopeOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RcptTo** | **String[]** | | +**MailFrom** | **String** | | +**VarData** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$SendSMTPEnvelopeOptions = Initialize-maislurp-client-powershellSendSMTPEnvelopeOptions -RcptTo null ` + -MailFrom null ` + -VarData null +``` + +- Convert the resource to JSON +```powershell +$SendSMTPEnvelopeOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SendWithQueueResult.md b/docs/SendWithQueueResult.md new file mode 100644 index 00000000..5c6f9603 --- /dev/null +++ b/docs/SendWithQueueResult.md @@ -0,0 +1,39 @@ +# SendWithQueueResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**Subject** | **String** | | [optional] +**InboxId** | **String** | | [optional] +**HeaderId** | **String** | | +**Delivered** | **Boolean** | | +**ExceptionName** | **String** | | [optional] +**Message** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$SendWithQueueResult = Initialize-maislurp-client-powershellSendWithQueueResult -Id null ` + -UserId null ` + -Subject null ` + -InboxId null ` + -HeaderId null ` + -Delivered null ` + -ExceptionName null ` + -Message null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$SendWithQueueResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/Sender.md b/docs/Sender.md new file mode 100644 index 00000000..effbe22c --- /dev/null +++ b/docs/Sender.md @@ -0,0 +1,25 @@ +# ModelSender +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RawValue** | **String** | | +**EmailAddress** | **String** | | +**Name** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ModelSender = Initialize-maislurp-client-powershellModelSender -RawValue null ` + -EmailAddress null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$ModelSender | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SentEmailDto.md b/docs/SentEmailDto.md new file mode 100644 index 00000000..31612941 --- /dev/null +++ b/docs/SentEmailDto.md @@ -0,0 +1,71 @@ +# SentEmailDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of sent email | +**UserId** | **String** | User ID | +**InboxId** | **String** | Inbox ID email was sent from | +**DomainId** | **String** | Domain ID | [optional] +**To** | **String[]** | Recipients email was sent to | [optional] +**VarFrom** | **String** | Sent from address | [optional] +**ReplyTo** | **String** | | [optional] +**Cc** | **String[]** | | [optional] +**Bcc** | **String[]** | | [optional] +**Attachments** | **String[]** | Array of IDs of attachments that were sent with this email | [optional] +**Subject** | **String** | | [optional] +**BodyMD5Hash** | **String** | MD5 Hash | [optional] +**Body** | **String** | Sent email body | [optional] +**ToContacts** | **String[]** | | [optional] +**ToGroup** | **String** | | [optional] +**Charset** | **String** | | [optional] +**IsHTML** | **Boolean** | | [optional] +**SentAt** | **System.DateTime** | | +**PixelIds** | **String[]** | | [optional] +**MessageId** | **String** | | [optional] +**MessageIds** | **String[]** | | [optional] +**VirtualSend** | **Boolean** | | [optional] +**TemplateId** | **String** | | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | | [optional] +**Headers** | **System.Collections.Hashtable** | | [optional] +**Html** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SentEmailDto = Initialize-maislurp-client-powershellSentEmailDto -Id null ` + -UserId null ` + -InboxId null ` + -DomainId null ` + -To null ` + -VarFrom null ` + -ReplyTo null ` + -Cc null ` + -Bcc null ` + -Attachments null ` + -Subject null ` + -BodyMD5Hash null ` + -Body null ` + -ToContacts null ` + -ToGroup null ` + -Charset null ` + -IsHTML null ` + -SentAt null ` + -PixelIds null ` + -MessageId null ` + -MessageIds null ` + -VirtualSend null ` + -TemplateId null ` + -TemplateVariables null ` + -Headers null ` + -Html null +``` + +- Convert the resource to JSON +```powershell +$SentEmailDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SentEmailProjection.md b/docs/SentEmailProjection.md new file mode 100644 index 00000000..5a14a8d1 --- /dev/null +++ b/docs/SentEmailProjection.md @@ -0,0 +1,43 @@ +# SentEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**VarFrom** | **String** | | [optional] +**Subject** | **String** | | [optional] +**Attachments** | **String[]** | | +**InboxId** | **String** | | +**UserId** | **String** | | +**To** | **String[]** | | +**Bcc** | **String[]** | | +**Cc** | **String[]** | | +**CreatedAt** | **System.DateTime** | | +**BodyMD5Hash** | **String** | | [optional] +**VirtualSend** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$SentEmailProjection = Initialize-maislurp-client-powershellSentEmailProjection -Id null ` + -VarFrom null ` + -Subject null ` + -Attachments null ` + -InboxId null ` + -UserId null ` + -To null ` + -Bcc null ` + -Cc null ` + -CreatedAt null ` + -BodyMD5Hash null ` + -VirtualSend null +``` + +- Convert the resource to JSON +```powershell +$SentEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SentEmailsControllerApi.md b/docs/SentEmailsControllerApi.md new file mode 100644 index 00000000..09de5e6c --- /dev/null +++ b/docs/SentEmailsControllerApi.md @@ -0,0 +1,923 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.SentEmailsControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-DeleteAllSentEmails**](SentEmailsControllerApi#Invoke-DeleteAllSentEmails) | **DELETE** /sent | Delete all sent email receipts +[**Invoke-DeleteSentEmail**](SentEmailsControllerApi#Invoke-DeleteSentEmail) | **DELETE** /sent/{id} | Delete sent email receipt +[**Get-AllSentTrackingPixels**](SentEmailsControllerApi#Get-AllSentTrackingPixels) | **GET** /sent/tracking-pixels | +[**Get-RawSentEmailContents**](SentEmailsControllerApi#Get-RawSentEmailContents) | **GET** /sent/{emailId}/raw | Get raw sent email string. Returns unparsed raw SMTP message with headers and body. +[**Get-RawSentEmailJson**](SentEmailsControllerApi#Get-RawSentEmailJson) | **GET** /sent/{emailId}/raw/json | Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. +[**Get-SentDeliveryStatus**](SentEmailsControllerApi#Get-SentDeliveryStatus) | **GET** /sent/delivery-status/{deliveryId} | +[**Get-SentDeliveryStatuses**](SentEmailsControllerApi#Get-SentDeliveryStatuses) | **GET** /sent/delivery-status | +[**Get-SentDeliveryStatusesBySentId**](SentEmailsControllerApi#Get-SentDeliveryStatusesBySentId) | **GET** /sent/{sentId}/delivery-status | +[**Get-SentEmail**](SentEmailsControllerApi#Get-SentEmail) | **GET** /sent/{id} | Get sent email receipt +[**Get-SentEmailHTMLContent**](SentEmailsControllerApi#Get-SentEmailHTMLContent) | **GET** /sent/{id}/html | Get sent email HTML content +[**Get-SentEmailPreviewURLs**](SentEmailsControllerApi#Get-SentEmailPreviewURLs) | **GET** /sent/{id}/urls | Get sent email URL for viewing in browser or downloading +[**Get-SentEmailTrackingPixels**](SentEmailsControllerApi#Get-SentEmailTrackingPixels) | **GET** /sent/{id}/tracking-pixels | +[**Get-SentEmails**](SentEmailsControllerApi#Get-SentEmails) | **GET** /sent | Get all sent emails in paginated form +[**Get-SentEmailsWithQueueResults**](SentEmailsControllerApi#Get-SentEmailsWithQueueResults) | **GET** /sent/queue-results | Get results of email sent with queues in paginated form +[**Get-SentOrganizationEmails**](SentEmailsControllerApi#Get-SentOrganizationEmails) | **GET** /sent/organization | +[**Wait-ForDeliveryStatuses**](SentEmailsControllerApi#Wait-ForDeliveryStatuses) | **GET** /sent/delivery-status/wait-for | + + + +# **Invoke-DeleteAllSentEmails** +> void Invoke-DeleteAllSentEmails
+ +Delete all sent email receipts + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Delete all sent email receipts +try { + $Result = Invoke-DeleteAllSentEmails +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllSentEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteSentEmail** +> void Invoke-DeleteSentEmail
+>         [-Id]
+ +Delete sent email receipt + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Delete sent email receipt +try { + $Result = Invoke-DeleteSentEmail -Id $Id +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteSentEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllSentTrackingPixels** +> PageTrackingPixelProjection Get-AllSentTrackingPixels
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ + + +Get all sent email tracking pixels in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in sent email tracking pixel list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in sent email tracking pixel list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-AllSentTrackingPixels -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllSentTrackingPixels: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in sent email tracking pixel list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in sent email tracking pixel list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageTrackingPixelProjection**](PageTrackingPixelProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-RawSentEmailContents** +> void Get-RawSentEmailContents
+>         [-EmailId]
+ +Get raw sent email string. Returns unparsed raw SMTP message with headers and body. + +Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get raw sent email string. Returns unparsed raw SMTP message with headers and body. +try { + $Result = Get-RawSentEmailContents -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-RawSentEmailContents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-RawSentEmailJson** +> RawEmailJson Get-RawSentEmailJson
+>         [-EmailId]
+ +Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. + +Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailId = "EmailId_example" # String | ID of email + +# Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. +try { + $Result = Get-RawSentEmailJson -EmailId $EmailId +} catch { + Write-Host ("Exception occured when calling Get-RawSentEmailJson: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailId** | [**String**](String)| ID of email | + +### Return type + +[**RawEmailJson**](RawEmailJson) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentDeliveryStatus** +> DeliveryStatusDto Get-SentDeliveryStatus
+>         [-DeliveryId]
+ + + +Get a sent email delivery status + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$DeliveryId = "DeliveryId_example" # String | + +try { + $Result = Get-SentDeliveryStatus -DeliveryId $DeliveryId +} catch { + Write-Host ("Exception occured when calling Get-SentDeliveryStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **DeliveryId** | [**String**](String)| | + +### Return type + +[**DeliveryStatusDto**](DeliveryStatusDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentDeliveryStatuses** +> PageDeliveryStatus Get-SentDeliveryStatuses
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ + + +Get all sent email delivery statuses + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in delivery status list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in delivery status list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-SentDeliveryStatuses -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SentDeliveryStatuses: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in delivery status list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in delivery status list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageDeliveryStatus**](PageDeliveryStatus) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentDeliveryStatusesBySentId** +> PageDeliveryStatus Get-SentDeliveryStatusesBySentId
+>         [-SentId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ + + +Get all sent email delivery statuses + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SentId = "SentId_example" # String | ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email +$Page = 987 # Int32 | Optional page index in delivery status list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in delivery status list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-SentDeliveryStatusesBySentId -SentId $SentId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SentDeliveryStatusesBySentId: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SentId** | [**String**](String)| ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email | + **Page** | **Int32**| Optional page index in delivery status list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in delivery status list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageDeliveryStatus**](PageDeliveryStatus) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentEmail** +> SentEmailDto Get-SentEmail
+>         [-Id]
+ +Get sent email receipt + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get sent email receipt +try { + $Result = Get-SentEmail -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-SentEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**SentEmailDto**](SentEmailDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentEmailHTMLContent** +> String Get-SentEmailHTMLContent
+>         [-Id]
+ +Get sent email HTML content + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get sent email HTML content +try { + $Result = Get-SentEmailHTMLContent -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-SentEmailHTMLContent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentEmailPreviewURLs** +> EmailPreviewUrls Get-SentEmailPreviewURLs
+>         [-Id]
+ +Get sent email URL for viewing in browser or downloading + +Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get sent email URL for viewing in browser or downloading +try { + $Result = Get-SentEmailPreviewURLs -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-SentEmailPreviewURLs: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**EmailPreviewUrls**](EmailPreviewUrls) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentEmailTrackingPixels** +> PageTrackingPixelProjection Get-SentEmailTrackingPixels
+>         [-Id]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ + + +Get all tracking pixels for a sent email in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | +$Page = 987 # Int32 | Optional page index in sent email tracking pixel list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in sent email tracking pixel list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-SentEmailTrackingPixels -Id $Id -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SentEmailTrackingPixels: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + **Page** | **Int32**| Optional page index in sent email tracking pixel list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in sent email tracking pixel list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageTrackingPixelProjection**](PageTrackingPixelProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentEmails** +> PageSentEmailProjection Get-SentEmails
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get all sent emails in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inboxId to filter sender of sent emails by (optional) +$Page = 987 # Int32 | Optional page index in inbox sent email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox sent email list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get all sent emails in paginated form +try { + $Result = Get-SentEmails -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SentEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inboxId to filter sender of sent emails by | [optional] + **Page** | **Int32**| Optional page index in inbox sent email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox sent email list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageSentEmailProjection**](PageSentEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentEmailsWithQueueResults** +> PageSentEmailWithQueueProjection Get-SentEmailsWithQueueResults
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get results of email sent with queues in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in inbox sent email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in inbox sent email list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get results of email sent with queues in paginated form +try { + $Result = Get-SentEmailsWithQueueResults -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SentEmailsWithQueueResults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in inbox sent email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in inbox sent email list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageSentEmailWithQueueProjection**](PageSentEmailWithQueueProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SentOrganizationEmails** +> PageSentEmailProjection Get-SentOrganizationEmails
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ + + +Get all sent organization emails in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Optional inboxId to filter sender of sent emails by (optional) +$Page = 987 # Int32 | Optional page index in sent email list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in sent email list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Get-SentOrganizationEmails -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SentOrganizationEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Optional inboxId to filter sender of sent emails by | [optional] + **Page** | **Int32**| Optional page index in sent email list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in sent email list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageSentEmailProjection**](PageSentEmailProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForDeliveryStatuses** +> DeliveryStatusDto Wait-ForDeliveryStatuses
+>         [-SentId]
+>         [-InboxId]
+>         [-Timeout]
+>         [-Index]
+>         [-Since]
+>         [-Before]
+ + + +Wait for delivery statuses + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SentId = "SentId_example" # String | Optional sent email ID filter (optional) +$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional) +$Timeout = 987 # Int64 | Optional timeout milliseconds (optional) +$Index = 987 # Int32 | Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +try { + $Result = Wait-ForDeliveryStatuses -SentId $SentId -InboxId $InboxId -Timeout $Timeout -Index $Index -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Wait-ForDeliveryStatuses: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SentId** | [**String**](String)| Optional sent email ID filter | [optional] + **InboxId** | [**String**](String)| Optional inbox ID filter | [optional] + **Timeout** | **Int64**| Optional timeout milliseconds | [optional] + **Index** | **Int32**| Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**DeliveryStatusDto**](DeliveryStatusDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/SentSmsDto.md b/docs/SentSmsDto.md new file mode 100644 index 00000000..31f102e0 --- /dev/null +++ b/docs/SentSmsDto.md @@ -0,0 +1,41 @@ +# SentSmsDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**PhoneNumber** | **String** | | +**FromNumber** | **String** | | +**ToNumber** | **String** | | +**Body** | **String** | | +**Sid** | **String** | | +**ReplyToSid** | **String** | | +**ReplyToId** | **String** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$SentSmsDto = Initialize-maislurp-client-powershellSentSmsDto -Id null ` + -UserId null ` + -PhoneNumber null ` + -FromNumber null ` + -ToNumber null ` + -Body null ` + -Sid null ` + -ReplyToSid null ` + -ReplyToId null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$SentSmsDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ServerEndpoints.md b/docs/ServerEndpoints.md new file mode 100644 index 00000000..a5a1fdc9 --- /dev/null +++ b/docs/ServerEndpoints.md @@ -0,0 +1,27 @@ +# ServerEndpoints +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarHost** | **String** | | +**Port** | **Int32** | | +**Tls** | **Boolean** | | +**AltPorts** | **Int32[]** | | + +## Examples + +- Prepare the resource +```powershell +$ServerEndpoints = Initialize-maislurp-client-powershellServerEndpoints -VarHost null ` + -Port null ` + -Tls null ` + -AltPorts null +``` + +- Convert the resource to JSON +```powershell +$ServerEndpoints | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SetInboxFavouritedOptions.md b/docs/SetInboxFavouritedOptions.md new file mode 100644 index 00000000..ae5a1e67 --- /dev/null +++ b/docs/SetInboxFavouritedOptions.md @@ -0,0 +1,21 @@ +# SetInboxFavouritedOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | **Boolean** | Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering | + +## Examples + +- Prepare the resource +```powershell +$SetInboxFavouritedOptions = Initialize-maislurp-client-powershellSetInboxFavouritedOptions -State null +``` + +- Convert the resource to JSON +```powershell +$SetInboxFavouritedOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SimpleSendEmailOptions.md b/docs/SimpleSendEmailOptions.md new file mode 100644 index 00000000..1b7910c4 --- /dev/null +++ b/docs/SimpleSendEmailOptions.md @@ -0,0 +1,27 @@ +# SimpleSendEmailOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SenderId** | **String** | ID of inbox to send from. If null an inbox will be created for sending | [optional] +**To** | **String** | Email address to send to | +**Body** | **String** | Body of the email message. Supports HTML | [optional] +**Subject** | **String** | Subject line of the email | [optional] + +## Examples + +- Prepare the resource +```powershell +$SimpleSendEmailOptions = Initialize-maislurp-client-powershellSimpleSendEmailOptions -SenderId null ` + -To null ` + -Body null ` + -Subject null +``` + +- Convert the resource to JSON +```powershell +$SimpleSendEmailOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SmsControllerApi.md b/docs/SmsControllerApi.md new file mode 100644 index 00000000..4fb24bac --- /dev/null +++ b/docs/SmsControllerApi.md @@ -0,0 +1,427 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.SmsControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-DeleteSmsMessage**](SmsControllerApi#Invoke-DeleteSmsMessage) | **DELETE** /sms/{smsId} | Delete SMS message. +[**Invoke-DeleteSmsMessages**](SmsControllerApi#Invoke-DeleteSmsMessages) | **DELETE** /sms | Delete all SMS messages +[**Get-ReplyForSmsMessage**](SmsControllerApi#Get-ReplyForSmsMessage) | **GET** /sms/{smsId}/reply | Get reply for an SMS message +[**Get-SmsCount**](SmsControllerApi#Get-SmsCount) | **GET** /sms/count | Get SMS count +[**Get-SmsMessage**](SmsControllerApi#Get-SmsMessage) | **GET** /sms/{smsId} | Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. +[**Get-SmsMessagesPaginated**](SmsControllerApi#Get-SmsMessagesPaginated) | **GET** /sms | Get all SMS messages in all phone numbers in paginated form. . +[**Get-UnreadSmsCount**](SmsControllerApi#Get-UnreadSmsCount) | **GET** /sms/unreadCount | Get unread SMS count +[**Invoke-ReplyToSmsMessage**](SmsControllerApi#Invoke-ReplyToSmsMessage) | **POST** /sms/{smsId}/reply | Send a reply to a received SMS message. Replies are sent from the receiving number. + + + +# **Invoke-DeleteSmsMessage** +> void Invoke-DeleteSmsMessage
+>         [-SmsId]
+ +Delete SMS message. + +Delete an SMS message + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SmsId = "SmsId_example" # String | + +# Delete SMS message. +try { + $Result = Invoke-DeleteSmsMessage -SmsId $SmsId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteSmsMessage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SmsId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteSmsMessages** +> void Invoke-DeleteSmsMessages
+>         [-PhoneNumberId]
+ +Delete all SMS messages + +Delete all SMS messages or all messages for a given phone number + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneNumberId = "PhoneNumberId_example" # String | (optional) + +# Delete all SMS messages +try { + $Result = Invoke-DeleteSmsMessages -PhoneNumberId $PhoneNumberId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteSmsMessages: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneNumberId** | [**String**](String)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-ReplyForSmsMessage** +> ReplyForSms Get-ReplyForSmsMessage
+>         [-SmsId]
+ +Get reply for an SMS message + +Get reply for an SMS message. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SmsId = "SmsId_example" # String | + +# Get reply for an SMS message +try { + $Result = Get-ReplyForSmsMessage -SmsId $SmsId +} catch { + Write-Host ("Exception occured when calling Get-ReplyForSmsMessage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SmsId** | [**String**](String)| | + +### Return type + +[**ReplyForSms**](ReplyForSms) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SmsCount** +> CountDto Get-SmsCount
+ +Get SMS count + +Get number of SMS + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get SMS count +try { + $Result = Get-SmsCount +} catch { + Write-Host ("Exception occured when calling Get-SmsCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**CountDto**](CountDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SmsMessage** +> SmsDto Get-SmsMessage
+>         [-SmsId]
+ +Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. + +Returns a SMS summary object with content. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SmsId = "SmsId_example" # String | + +# Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. +try { + $Result = Get-SmsMessage -SmsId $SmsId +} catch { + Write-Host ("Exception occured when calling Get-SmsMessage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SmsId** | [**String**](String)| | + +### Return type + +[**SmsDto**](SmsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-SmsMessagesPaginated** +> PageSmsProjection Get-SmsMessagesPaginated
+>         [-PhoneNumber]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-UnreadOnly]
+>         [-Since]
+>         [-Before]
+ +Get all SMS messages in all phone numbers in paginated form. . + +By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneNumber = "PhoneNumber_example" # String | Optional receiving phone number to filter SMS messages for (optional) +$Page = 987 # Int32 | Optional page index in SMS list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$UnreadOnly = true # Boolean | Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional) (default to $false) +$Since = Get-Date # System.DateTime | Optional filter SMSs received after given date time (optional) +$Before = Get-Date # System.DateTime | Optional filter SMSs received before given date time (optional) + +# Get all SMS messages in all phone numbers in paginated form. . +try { + $Result = Get-SmsMessagesPaginated -PhoneNumber $PhoneNumber -Page $Page -Size $Size -Sort $Sort -UnreadOnly $UnreadOnly -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-SmsMessagesPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneNumber** | [**String**](String)| Optional receiving phone number to filter SMS messages for | [optional] + **Page** | **Int32**| Optional page index in SMS list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **UnreadOnly** | **Boolean**| Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to $false] + **Since** | **System.DateTime**| Optional filter SMSs received after given date time | [optional] + **Before** | **System.DateTime**| Optional filter SMSs received before given date time | [optional] + +### Return type + +[**PageSmsProjection**](PageSmsProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-UnreadSmsCount** +> UnreadCount Get-UnreadSmsCount
+ +Get unread SMS count + +Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get unread SMS count +try { + $Result = Get-UnreadSmsCount +} catch { + Write-Host ("Exception occured when calling Get-UnreadSmsCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UnreadCount**](UnreadCount) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-ReplyToSmsMessage** +> SentSmsDto Invoke-ReplyToSmsMessage
+>         [-SmsId]
+>         [-SmsReplyOptions]
+ +Send a reply to a received SMS message. Replies are sent from the receiving number. + +Reply to an SMS message. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$SmsId = "SmsId_example" # String | +$SmsReplyOptions = (Initialize-SmsReplyOptions -Body "Body_example") # SmsReplyOptions | + +# Send a reply to a received SMS message. Replies are sent from the receiving number. +try { + $Result = Invoke-ReplyToSmsMessage -SmsId $SmsId -SmsReplyOptions $SmsReplyOptions +} catch { + Write-Host ("Exception occured when calling Invoke-ReplyToSmsMessage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **SmsId** | [**String**](String)| | + **SmsReplyOptions** | [**SmsReplyOptions**](SmsReplyOptions)| | + +### Return type + +[**SentSmsDto**](SentSmsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/SmsDto.md b/docs/SmsDto.md new file mode 100644 index 00000000..16109400 --- /dev/null +++ b/docs/SmsDto.md @@ -0,0 +1,35 @@ +# SmsDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**PhoneNumber** | **String** | | +**FromNumber** | **String** | | +**Body** | **String** | | +**Read** | **Boolean** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$SmsDto = Initialize-maislurp-client-powershellSmsDto -Id null ` + -UserId null ` + -PhoneNumber null ` + -FromNumber null ` + -Body null ` + -Read null ` + -CreatedAt null ` + -UpdatedAt null +``` + +- Convert the resource to JSON +```powershell +$SmsDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SmsMatchOption.md b/docs/SmsMatchOption.md new file mode 100644 index 00000000..6feb1204 --- /dev/null +++ b/docs/SmsMatchOption.md @@ -0,0 +1,25 @@ +# SmsMatchOption +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **String** | Fields of an SMS object that can be used to filter results | +**Should** | **String** | How the value of the email field specified should be compared to the value given in the match options. | +**Value** | **String** | The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed. | + +## Examples + +- Prepare the resource +```powershell +$SmsMatchOption = Initialize-maislurp-client-powershellSmsMatchOption -Field null ` + -Should null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$SmsMatchOption | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SmsPreview.md b/docs/SmsPreview.md new file mode 100644 index 00000000..6fde78fa --- /dev/null +++ b/docs/SmsPreview.md @@ -0,0 +1,31 @@ +# SmsPreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**UserId** | **String** | | +**Body** | **String** | | +**PhoneNumber** | **String** | | +**FromNumber** | **String** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$SmsPreview = Initialize-maislurp-client-powershellSmsPreview -Id null ` + -UserId null ` + -Body null ` + -PhoneNumber null ` + -FromNumber null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$SmsPreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SmsProjection.md b/docs/SmsProjection.md new file mode 100644 index 00000000..5db736b9 --- /dev/null +++ b/docs/SmsProjection.md @@ -0,0 +1,33 @@ +# SmsProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | | +**PhoneNumber** | **String** | | +**FromNumber** | **String** | | +**Read** | **Boolean** | | +**Body** | **String** | | +**CreatedAt** | **System.DateTime** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$SmsProjection = Initialize-maislurp-client-powershellSmsProjection -UserId null ` + -PhoneNumber null ` + -FromNumber null ` + -Read null ` + -Body null ` + -CreatedAt null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$SmsProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SmsReplyOptions.md b/docs/SmsReplyOptions.md new file mode 100644 index 00000000..18c0b5f0 --- /dev/null +++ b/docs/SmsReplyOptions.md @@ -0,0 +1,21 @@ +# SmsReplyOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$SmsReplyOptions = Initialize-maislurp-client-powershellSmsReplyOptions -Body null +``` + +- Convert the resource to JSON +```powershell +$SmsReplyOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SmtpAccessDetails.md b/docs/SmtpAccessDetails.md new file mode 100644 index 00000000..c2c9e962 --- /dev/null +++ b/docs/SmtpAccessDetails.md @@ -0,0 +1,37 @@ +# SmtpAccessDetails +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SecureSmtpServerHost** | **String** | Secure TLS SMTP server host domain | +**SecureSmtpServerPort** | **Int32** | Secure TLS SMTP server host port | +**SecureSmtpUsername** | **String** | Secure TLS SMTP username for login | +**SecureSmtpPassword** | **String** | Secure TLS SMTP password for login | +**SmtpServerHost** | **String** | SMTP server host domain | +**SmtpServerPort** | **Int32** | SMTP server host port | +**SmtpUsername** | **String** | SMTP username for login | +**SmtpPassword** | **String** | SMTP password for login | +**MailFromDomain** | **String** | Mail from domain or SMTP HELO value | [optional] + +## Examples + +- Prepare the resource +```powershell +$SmtpAccessDetails = Initialize-maislurp-client-powershellSmtpAccessDetails -SecureSmtpServerHost null ` + -SecureSmtpServerPort null ` + -SecureSmtpUsername null ` + -SecureSmtpPassword null ` + -SmtpServerHost null ` + -SmtpServerPort null ` + -SmtpUsername null ` + -SmtpPassword null ` + -MailFromDomain null +``` + +- Convert the resource to JSON +```powershell +$SmtpAccessDetails | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SortObject.md b/docs/SortObject.md new file mode 100644 index 00000000..d2b0bd01 --- /dev/null +++ b/docs/SortObject.md @@ -0,0 +1,25 @@ +# SortObject +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sorted** | **Boolean** | | [optional] +**Unsorted** | **Boolean** | | [optional] +**Empty** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SortObject = Initialize-maislurp-client-powershellSortObject -Sorted null ` + -Unsorted null ` + -Empty null +``` + +- Convert the resource to JSON +```powershell +$SortObject | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/SpellingIssue.md b/docs/SpellingIssue.md new file mode 100644 index 00000000..09ffcd52 --- /dev/null +++ b/docs/SpellingIssue.md @@ -0,0 +1,27 @@ +# SpellingIssue +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Group** | **String** | | +**Suggestion** | **String** | | +**Severity** | **String** | | +**Message** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$SpellingIssue = Initialize-maislurp-client-powershellSpellingIssue -Group null ` + -Suggestion null ` + -Severity null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$SpellingIssue | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TemplateControllerApi.md b/docs/TemplateControllerApi.md new file mode 100644 index 00000000..6907b0ce --- /dev/null +++ b/docs/TemplateControllerApi.md @@ -0,0 +1,426 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.TemplateControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Template**](TemplateControllerApi#New-Template) | **POST** /templates | Create a Template +[**Invoke-DeleteTemplate**](TemplateControllerApi#Invoke-DeleteTemplate) | **DELETE** /templates/{templateId} | Delete email template +[**Get-AllTemplates**](TemplateControllerApi#Get-AllTemplates) | **GET** /templates/paginated | List templates +[**Get-Template**](TemplateControllerApi#Get-Template) | **GET** /templates/{templateId} | Get template +[**Get-TemplatePreviewHtml**](TemplateControllerApi#Get-TemplatePreviewHtml) | **GET** /templates/{templateId}/preview/html | Get template preview HTML +[**Get-TemplatePreviewJson**](TemplateControllerApi#Get-TemplatePreviewJson) | **GET** /templates/{templateId}/preview/json | Get template preview Json +[**Get-Templates**](TemplateControllerApi#Get-Templates) | **GET** /templates | List templates +[**Update-Template**](TemplateControllerApi#Update-Template) | **PUT** /templates/{templateId} | Update template + + + +# **New-Template** +> TemplateDto New-Template
+>         [-CreateTemplateOptions]
+ +Create a Template + +Create an email template with variables for use with templated transactional emails. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateTemplateOptions = (Initialize-CreateTemplateOptions -Name "Name_example" -Content "Content_example") # CreateTemplateOptions | + +# Create a Template +try { + $Result = New-Template -CreateTemplateOptions $CreateTemplateOptions +} catch { + Write-Host ("Exception occured when calling New-Template: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateTemplateOptions** | [**CreateTemplateOptions**](CreateTemplateOptions)| | + +### Return type + +[**TemplateDto**](TemplateDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteTemplate** +> void Invoke-DeleteTemplate
+>         [-TemplateId]
+ +Delete email template + +Delete template + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TemplateId = "TemplateId_example" # String | Template ID + +# Delete email template +try { + $Result = Invoke-DeleteTemplate -TemplateId $TemplateId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteTemplate: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TemplateId** | [**String**](String)| Template ID | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllTemplates** +> PageTemplateProjection Get-AllTemplates
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +List templates + +Get all templates in paginated format + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List templates +try { + $Result = Get-AllTemplates -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllTemplates: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageTemplateProjection**](PageTemplateProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Template** +> TemplateDto Get-Template
+>         [-TemplateId]
+ +Get template + +Get email template + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TemplateId = "TemplateId_example" # String | Template ID + +# Get template +try { + $Result = Get-Template -TemplateId $TemplateId +} catch { + Write-Host ("Exception occured when calling Get-Template: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TemplateId** | [**String**](String)| Template ID | + +### Return type + +[**TemplateDto**](TemplateDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TemplatePreviewHtml** +> String Get-TemplatePreviewHtml
+>         [-TemplateId]
+ +Get template preview HTML + +Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TemplateId = "TemplateId_example" # String | Template ID + +# Get template preview HTML +try { + $Result = Get-TemplatePreviewHtml -TemplateId $TemplateId +} catch { + Write-Host ("Exception occured when calling Get-TemplatePreviewHtml: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TemplateId** | [**String**](String)| Template ID | + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html;charset=utf-8, text/html + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TemplatePreviewJson** +> TemplatePreview Get-TemplatePreviewJson
+>         [-TemplateId]
+ +Get template preview Json + +Get email template preview with passed template variables in JSON format. Pass template variables as query params. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TemplateId = "TemplateId_example" # String | Template ID + +# Get template preview Json +try { + $Result = Get-TemplatePreviewJson -TemplateId $TemplateId +} catch { + Write-Host ("Exception occured when calling Get-TemplatePreviewJson: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TemplateId** | [**String**](String)| Template ID | + +### Return type + +[**TemplatePreview**](TemplatePreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Templates** +> TemplateProjection[] Get-Templates
+ +List templates + +Get all templates + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# List templates +try { + $Result = Get-Templates +} catch { + Write-Host ("Exception occured when calling Get-Templates: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**TemplateProjection[]**](TemplateProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-Template** +> TemplateDto Update-Template
+>         [-TemplateId]
+>         [-CreateTemplateOptions]
+ +Update template + +Update email template + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$TemplateId = "TemplateId_example" # String | Template ID +$CreateTemplateOptions = (Initialize-CreateTemplateOptions -Name "Name_example" -Content "Content_example") # CreateTemplateOptions | + +# Update template +try { + $Result = Update-Template -TemplateId $TemplateId -CreateTemplateOptions $CreateTemplateOptions +} catch { + Write-Host ("Exception occured when calling Update-Template: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **TemplateId** | [**String**](String)| Template ID | + **CreateTemplateOptions** | [**CreateTemplateOptions**](CreateTemplateOptions)| | + +### Return type + +[**TemplateDto**](TemplateDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/TemplateDto.md b/docs/TemplateDto.md new file mode 100644 index 00000000..d795523f --- /dev/null +++ b/docs/TemplateDto.md @@ -0,0 +1,29 @@ +# TemplateDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of template | +**Name** | **String** | Template name | +**Variables** | [**TemplateVariable[]**](TemplateVariable) | Variables available in template that can be replaced with values | +**Content** | **String** | Content of the template | +**CreatedAt** | **System.DateTime** | Created at time | + +## Examples + +- Prepare the resource +```powershell +$TemplateDto = Initialize-maislurp-client-powershellTemplateDto -Id null ` + -Name null ` + -Variables null ` + -Content null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$TemplateDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TemplatePreview.md b/docs/TemplatePreview.md new file mode 100644 index 00000000..d6d65e03 --- /dev/null +++ b/docs/TemplatePreview.md @@ -0,0 +1,21 @@ +# TemplatePreview +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Preview** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$TemplatePreview = Initialize-maislurp-client-powershellTemplatePreview -Preview null +``` + +- Convert the resource to JSON +```powershell +$TemplatePreview | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TemplateProjection.md b/docs/TemplateProjection.md new file mode 100644 index 00000000..6dc63d97 --- /dev/null +++ b/docs/TemplateProjection.md @@ -0,0 +1,29 @@ +# TemplateProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Variables** | **String[]** | | +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | +**Name** | **String** | | +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$TemplateProjection = Initialize-maislurp-client-powershellTemplateProjection -Variables null ` + -CreatedAt null ` + -UpdatedAt null ` + -Name null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$TemplateProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TemplateVariable.md b/docs/TemplateVariable.md new file mode 100644 index 00000000..4fd07f75 --- /dev/null +++ b/docs/TemplateVariable.md @@ -0,0 +1,23 @@ +# TemplateVariable +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of variable. This can be used in a template as {{name}} | +**VariableType** | **String** | The type of variable | + +## Examples + +- Prepare the resource +```powershell +$TemplateVariable = Initialize-maislurp-client-powershellTemplateVariable -Name null ` + -VariableType null +``` + +- Convert the resource to JSON +```powershell +$TemplateVariable | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestInboxRulesetReceivingOptions.md b/docs/TestInboxRulesetReceivingOptions.md new file mode 100644 index 00000000..50a2e631 --- /dev/null +++ b/docs/TestInboxRulesetReceivingOptions.md @@ -0,0 +1,23 @@ +# TestInboxRulesetReceivingOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | | +**FromSender** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$TestInboxRulesetReceivingOptions = Initialize-maislurp-client-powershellTestInboxRulesetReceivingOptions -InboxId null ` + -FromSender null +``` + +- Convert the resource to JSON +```powershell +$TestInboxRulesetReceivingOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestInboxRulesetReceivingResult.md b/docs/TestInboxRulesetReceivingResult.md new file mode 100644 index 00000000..68d17937 --- /dev/null +++ b/docs/TestInboxRulesetReceivingResult.md @@ -0,0 +1,21 @@ +# TestInboxRulesetReceivingResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CanReceive** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$TestInboxRulesetReceivingResult = Initialize-maislurp-client-powershellTestInboxRulesetReceivingResult -CanReceive null +``` + +- Convert the resource to JSON +```powershell +$TestInboxRulesetReceivingResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestInboxRulesetSendingOptions.md b/docs/TestInboxRulesetSendingOptions.md new file mode 100644 index 00000000..c5d06665 --- /dev/null +++ b/docs/TestInboxRulesetSendingOptions.md @@ -0,0 +1,23 @@ +# TestInboxRulesetSendingOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | | +**Recipient** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$TestInboxRulesetSendingOptions = Initialize-maislurp-client-powershellTestInboxRulesetSendingOptions -InboxId null ` + -Recipient null +``` + +- Convert the resource to JSON +```powershell +$TestInboxRulesetSendingOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestInboxRulesetSendingResult.md b/docs/TestInboxRulesetSendingResult.md new file mode 100644 index 00000000..6a9ecb60 --- /dev/null +++ b/docs/TestInboxRulesetSendingResult.md @@ -0,0 +1,21 @@ +# TestInboxRulesetSendingResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CanSend** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$TestInboxRulesetSendingResult = Initialize-maislurp-client-powershellTestInboxRulesetSendingResult -CanSend null +``` + +- Convert the resource to JSON +```powershell +$TestInboxRulesetSendingResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestNewInboxForwarderOptions.md b/docs/TestNewInboxForwarderOptions.md new file mode 100644 index 00000000..4960b7c4 --- /dev/null +++ b/docs/TestNewInboxForwarderOptions.md @@ -0,0 +1,23 @@ +# TestNewInboxForwarderOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxForwarderTestOptions** | [**InboxForwarderTestOptions**](InboxForwarderTestOptions) | | +**CreateInboxForwarderOptions** | [**CreateInboxForwarderOptions**](CreateInboxForwarderOptions) | | + +## Examples + +- Prepare the resource +```powershell +$TestNewInboxForwarderOptions = Initialize-maislurp-client-powershellTestNewInboxForwarderOptions -InboxForwarderTestOptions null ` + -CreateInboxForwarderOptions null +``` + +- Convert the resource to JSON +```powershell +$TestNewInboxForwarderOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestNewInboxRulesetOptions.md b/docs/TestNewInboxRulesetOptions.md new file mode 100644 index 00000000..da3c8b95 --- /dev/null +++ b/docs/TestNewInboxRulesetOptions.md @@ -0,0 +1,23 @@ +# TestNewInboxRulesetOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxRulesetTestOptions** | [**InboxRulesetTestOptions**](InboxRulesetTestOptions) | | +**CreateInboxRulesetOptions** | [**CreateInboxRulesetOptions**](CreateInboxRulesetOptions) | | + +## Examples + +- Prepare the resource +```powershell +$TestNewInboxRulesetOptions = Initialize-maislurp-client-powershellTestNewInboxRulesetOptions -InboxRulesetTestOptions null ` + -CreateInboxRulesetOptions null +``` + +- Convert the resource to JSON +```powershell +$TestNewInboxRulesetOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TestPhoneNumberOptions.md b/docs/TestPhoneNumberOptions.md new file mode 100644 index 00000000..02731f78 --- /dev/null +++ b/docs/TestPhoneNumberOptions.md @@ -0,0 +1,21 @@ +# TestPhoneNumberOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$TestPhoneNumberOptions = Initialize-maislurp-client-powershellTestPhoneNumberOptions -Message null +``` + +- Convert the resource to JSON +```powershell +$TestPhoneNumberOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ThreadProjection.md b/docs/ThreadProjection.md new file mode 100644 index 00000000..9a665387 --- /dev/null +++ b/docs/ThreadProjection.md @@ -0,0 +1,41 @@ +# ThreadProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | Inbox ID | +**UserId** | **String** | User ID | +**To** | **String[]** | To recipients | +**Bcc** | **String[]** | BCC recipients | [optional] +**Cc** | **String[]** | CC recipients | [optional] +**AliasId** | **String** | Alias ID | +**CreatedAt** | **System.DateTime** | Created at DateTime | +**UpdatedAt** | **System.DateTime** | Updated at DateTime | +**Subject** | **String** | Thread subject | [optional] +**Name** | **String** | Name of thread | [optional] +**Id** | **String** | ID of email thread | + +## Examples + +- Prepare the resource +```powershell +$ThreadProjection = Initialize-maislurp-client-powershellThreadProjection -InboxId null ` + -UserId null ` + -To null ` + -Bcc null ` + -Cc null ` + -AliasId null ` + -CreatedAt null ` + -UpdatedAt null ` + -Subject null ` + -Name null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$ThreadProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ToolsControllerApi.md b/docs/ToolsControllerApi.md new file mode 100644 index 00000000..a7028af2 --- /dev/null +++ b/docs/ToolsControllerApi.md @@ -0,0 +1,592 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.ToolsControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Invoke-CheckEmailFeaturesClientSupport**](ToolsControllerApi#Invoke-CheckEmailFeaturesClientSupport) | **POST** /tools/check-email-features-client-support | Check email client support for email HTML and CSS features +[**New-NewFakeEmailAddress**](ToolsControllerApi#New-NewFakeEmailAddress) | **POST** /tools/fake-email | Create a new email address using the fake email domains +[**New-BimiRecord**](ToolsControllerApi#New-BimiRecord) | **POST** /tools/generate-bimi-record | Create a BIMI record policy +[**New-DmarcRecord**](ToolsControllerApi#New-DmarcRecord) | **POST** /tools/generate-dmarc-record | Create a DMARC record policy +[**New-MtaStsRecord**](ToolsControllerApi#New-MtaStsRecord) | **POST** /tools/generate-mta-sts-record | Create a TLS reporting record policy +[**New-TlsReportingRecord**](ToolsControllerApi#New-TlsReportingRecord) | **POST** /tools/generate-tls-reporting-record | Create a TLS reporting record policy +[**Get-FakeEmailById**](ToolsControllerApi#Get-FakeEmailById) | **GET** /tools/fake-email | +[**Get-FakeEmailsForAddress**](ToolsControllerApi#Get-FakeEmailsForAddress) | **GET** /tools/fake-emails | +[**Invoke-LookupBimiDomain**](ToolsControllerApi#Invoke-LookupBimiDomain) | **POST** /tools/lookup-bimi-domain | Lookup a BIMI record policy +[**Invoke-LookupDmarcDomain**](ToolsControllerApi#Invoke-LookupDmarcDomain) | **POST** /tools/lookup-dmarc-domain | Lookup a DMARC record policy +[**Invoke-LookupMtaStsDomain**](ToolsControllerApi#Invoke-LookupMtaStsDomain) | **POST** /tools/lookup-mta-sts-domain | Lookup a MTA-STS domain policy +[**Invoke-LookupTlsReportingDomain**](ToolsControllerApi#Invoke-LookupTlsReportingDomain) | **POST** /tools/lookup-tls-reporting-domain | Lookup a TLS reporting domain policy + + + +# **Invoke-CheckEmailFeaturesClientSupport** +> CheckEmailFeaturesClientSupportResults Invoke-CheckEmailFeaturesClientSupport
+>         [-CheckEmailFeaturesClientSupportOptions]
+ +Check email client support for email HTML and CSS features + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CheckEmailFeaturesClientSupportOptions = (Initialize-CheckEmailFeaturesClientSupportOptions -EmailBody "EmailBody_example") # CheckEmailFeaturesClientSupportOptions | + +# Check email client support for email HTML and CSS features +try { + $Result = Invoke-CheckEmailFeaturesClientSupport -CheckEmailFeaturesClientSupportOptions $CheckEmailFeaturesClientSupportOptions +} catch { + Write-Host ("Exception occured when calling Invoke-CheckEmailFeaturesClientSupport: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CheckEmailFeaturesClientSupportOptions** | [**CheckEmailFeaturesClientSupportOptions**](CheckEmailFeaturesClientSupportOptions)| | + +### Return type + +[**CheckEmailFeaturesClientSupportResults**](CheckEmailFeaturesClientSupportResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-NewFakeEmailAddress** +> NewFakeEmailAddressResult New-NewFakeEmailAddress
+ +Create a new email address using the fake email domains + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Create a new email address using the fake email domains +try { + $Result = New-NewFakeEmailAddress +} catch { + Write-Host ("Exception occured when calling New-NewFakeEmailAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**NewFakeEmailAddressResult**](NewFakeEmailAddressResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-BimiRecord** +> GenerateBimiRecordResults New-BimiRecord
+>         [-GenerateBimiRecordOptions]
+ +Create a BIMI record policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GenerateBimiRecordOptions = (Initialize-GenerateBimiRecordOptions -Domain "Domain_example" -Version "BIMI1" -LogoUrl "LogoUrl_example" -VmcUrl "VmcUrl_example") # GenerateBimiRecordOptions | + +# Create a BIMI record policy +try { + $Result = New-BimiRecord -GenerateBimiRecordOptions $GenerateBimiRecordOptions +} catch { + Write-Host ("Exception occured when calling New-BimiRecord: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GenerateBimiRecordOptions** | [**GenerateBimiRecordOptions**](GenerateBimiRecordOptions)| | + +### Return type + +[**GenerateBimiRecordResults**](GenerateBimiRecordResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-DmarcRecord** +> GenerateDmarcRecordResults New-DmarcRecord
+>         [-GenerateDmarcRecordOptions]
+ +Create a DMARC record policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GenerateDmarcRecordOptions = (Initialize-GenerateDmarcRecordOptions -Domain "Domain_example" -Version "DMARC1" -Policy "NONE" -SubdomainPolicy "NONE" -ReportEmailAddress @("ReportEmailAddress_example") -ForensicEmailAddress @("ForensicEmailAddress_example") -Percentage 123 -ReportFormat "AFRF" -SecondsBetweenReports 123 -Adkim "STRICT" -Aspf "STRICT" -Fo "FO_0") # GenerateDmarcRecordOptions | + +# Create a DMARC record policy +try { + $Result = New-DmarcRecord -GenerateDmarcRecordOptions $GenerateDmarcRecordOptions +} catch { + Write-Host ("Exception occured when calling New-DmarcRecord: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GenerateDmarcRecordOptions** | [**GenerateDmarcRecordOptions**](GenerateDmarcRecordOptions)| | + +### Return type + +[**GenerateDmarcRecordResults**](GenerateDmarcRecordResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-MtaStsRecord** +> GenerateMtaStsRecordResults New-MtaStsRecord
+>         [-GenerateMtaStsRecordOptions]
+ +Create a TLS reporting record policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GenerateMtaStsRecordOptions = (Initialize-GenerateMtaStsRecordOptions -VarHost "VarHost_example" -Version "STSv1" -Mode "TESTING" -Ttl 123 -MaxAgeSeconds 123 -MxRecords @("MxRecords_example")) # GenerateMtaStsRecordOptions | + +# Create a TLS reporting record policy +try { + $Result = New-MtaStsRecord -GenerateMtaStsRecordOptions $GenerateMtaStsRecordOptions +} catch { + Write-Host ("Exception occured when calling New-MtaStsRecord: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GenerateMtaStsRecordOptions** | [**GenerateMtaStsRecordOptions**](GenerateMtaStsRecordOptions)| | + +### Return type + +[**GenerateMtaStsRecordResults**](GenerateMtaStsRecordResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-TlsReportingRecord** +> GenerateTlsReportingRecordResults New-TlsReportingRecord
+>         [-GenerateTlsReportingRecordOptions]
+ +Create a TLS reporting record policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$GenerateTlsReportingRecordOptions = (Initialize-GenerateTlsReportingRecordOptions -ReportingAddresses @("ReportingAddresses_example") -ReportingUrl "ReportingUrl_example" -VarHost "VarHost_example" -Version "TLSRPTv1" -Ttl 123) # GenerateTlsReportingRecordOptions | + +# Create a TLS reporting record policy +try { + $Result = New-TlsReportingRecord -GenerateTlsReportingRecordOptions $GenerateTlsReportingRecordOptions +} catch { + Write-Host ("Exception occured when calling New-TlsReportingRecord: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **GenerateTlsReportingRecordOptions** | [**GenerateTlsReportingRecordOptions**](GenerateTlsReportingRecordOptions)| | + +### Return type + +[**GenerateTlsReportingRecordResults**](GenerateTlsReportingRecordResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-FakeEmailById** +> FakeEmailResult Get-FakeEmailById
+>         [-Id]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +try { + $Result = Get-FakeEmailById -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-FakeEmailById: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**FakeEmailResult**](FakeEmailResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-FakeEmailsForAddress** +> FakeEmailPreview[] Get-FakeEmailsForAddress
+>         [-EmailAddress]
+>         [-Page]
+ + + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EmailAddress = "EmailAddress_example" # String | +$Page = 987 # Int32 | (optional) + +try { + $Result = Get-FakeEmailsForAddress -EmailAddress $EmailAddress -Page $Page +} catch { + Write-Host ("Exception occured when calling Get-FakeEmailsForAddress: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EmailAddress** | **String**| | + **Page** | **Int32**| | [optional] + +### Return type + +[**FakeEmailPreview[]**](FakeEmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-LookupBimiDomain** +> LookupBimiDomainResults Invoke-LookupBimiDomain
+>         [-LookupBimiDomainOptions]
+ +Lookup a BIMI record policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$LookupBimiDomainOptions = (Initialize-LookupBimiDomainOptions -VarHost "VarHost_example") # LookupBimiDomainOptions | + +# Lookup a BIMI record policy +try { + $Result = Invoke-LookupBimiDomain -LookupBimiDomainOptions $LookupBimiDomainOptions +} catch { + Write-Host ("Exception occured when calling Invoke-LookupBimiDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **LookupBimiDomainOptions** | [**LookupBimiDomainOptions**](LookupBimiDomainOptions)| | + +### Return type + +[**LookupBimiDomainResults**](LookupBimiDomainResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-LookupDmarcDomain** +> LookupDmarcDomainResults Invoke-LookupDmarcDomain
+>         [-LookupDmarcDomainOptions]
+ +Lookup a DMARC record policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$LookupDmarcDomainOptions = (Initialize-LookupDmarcDomainOptions -VarHost "VarHost_example") # LookupDmarcDomainOptions | + +# Lookup a DMARC record policy +try { + $Result = Invoke-LookupDmarcDomain -LookupDmarcDomainOptions $LookupDmarcDomainOptions +} catch { + Write-Host ("Exception occured when calling Invoke-LookupDmarcDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **LookupDmarcDomainOptions** | [**LookupDmarcDomainOptions**](LookupDmarcDomainOptions)| | + +### Return type + +[**LookupDmarcDomainResults**](LookupDmarcDomainResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-LookupMtaStsDomain** +> LookupMtaStsDomainResults Invoke-LookupMtaStsDomain
+>         [-LookupMtaStsDomainOptions]
+ +Lookup a MTA-STS domain policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$LookupMtaStsDomainOptions = (Initialize-LookupMtaStsDomainOptions -VarHost "VarHost_example") # LookupMtaStsDomainOptions | + +# Lookup a MTA-STS domain policy +try { + $Result = Invoke-LookupMtaStsDomain -LookupMtaStsDomainOptions $LookupMtaStsDomainOptions +} catch { + Write-Host ("Exception occured when calling Invoke-LookupMtaStsDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **LookupMtaStsDomainOptions** | [**LookupMtaStsDomainOptions**](LookupMtaStsDomainOptions)| | + +### Return type + +[**LookupMtaStsDomainResults**](LookupMtaStsDomainResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-LookupTlsReportingDomain** +> LookupTlsReportingDomainResults Invoke-LookupTlsReportingDomain
+>         [-LookupTlsReportingDomainOptions]
+ +Lookup a TLS reporting domain policy + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$LookupTlsReportingDomainOptions = (Initialize-LookupTlsReportingDomainOptions -VarHost "VarHost_example") # LookupTlsReportingDomainOptions | + +# Lookup a TLS reporting domain policy +try { + $Result = Invoke-LookupTlsReportingDomain -LookupTlsReportingDomainOptions $LookupTlsReportingDomainOptions +} catch { + Write-Host ("Exception occured when calling Invoke-LookupTlsReportingDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **LookupTlsReportingDomainOptions** | [**LookupTlsReportingDomainOptions**](LookupTlsReportingDomainOptions)| | + +### Return type + +[**LookupTlsReportingDomainResults**](LookupTlsReportingDomainResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/TrackingControllerApi.md b/docs/TrackingControllerApi.md new file mode 100644 index 00000000..152489bb --- /dev/null +++ b/docs/TrackingControllerApi.md @@ -0,0 +1,174 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.TrackingControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-TrackingPixel**](TrackingControllerApi#New-TrackingPixel) | **POST** /tracking/pixels | Create tracking pixel +[**Get-AllTrackingPixels**](TrackingControllerApi#Get-AllTrackingPixels) | **GET** /tracking/pixels | Get tracking pixels +[**Get-TrackingPixel**](TrackingControllerApi#Get-TrackingPixel) | **GET** /tracking/pixels/{id} | Get pixel + + + +# **New-TrackingPixel** +> TrackingPixelDto New-TrackingPixel
+>         [-CreateTrackingPixelOptions]
+ +Create tracking pixel + +Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateTrackingPixelOptions = (Initialize-CreateTrackingPixelOptions -Name "Name_example" -Recipient "Recipient_example") # CreateTrackingPixelOptions | + +# Create tracking pixel +try { + $Result = New-TrackingPixel -CreateTrackingPixelOptions $CreateTrackingPixelOptions +} catch { + Write-Host ("Exception occured when calling New-TrackingPixel: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateTrackingPixelOptions** | [**CreateTrackingPixelOptions**](CreateTrackingPixelOptions)| | + +### Return type + +[**TrackingPixelDto**](TrackingPixelDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllTrackingPixels** +> PageTrackingPixelProjection Get-AllTrackingPixels
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get tracking pixels + +List tracking pixels in paginated form + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get tracking pixels +try { + $Result = Get-AllTrackingPixels -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllTrackingPixels: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageTrackingPixelProjection**](PageTrackingPixelProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TrackingPixel** +> TrackingPixelDto Get-TrackingPixel
+>         [-Id]
+ +Get pixel + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Id = "Id_example" # String | + +# Get pixel +try { + $Result = Get-TrackingPixel -Id $Id +} catch { + Write-Host ("Exception occured when calling Get-TrackingPixel: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | [**String**](String)| | + +### Return type + +[**TrackingPixelDto**](TrackingPixelDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/TrackingPixelDto.md b/docs/TrackingPixelDto.md new file mode 100644 index 00000000..8a997176 --- /dev/null +++ b/docs/TrackingPixelDto.md @@ -0,0 +1,37 @@ +# TrackingPixelDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**Seen** | **Boolean** | | +**Recipient** | **String** | | [optional] +**Html** | **String** | | +**Url** | **String** | | +**InboxId** | **String** | | [optional] +**SentEmailId** | **String** | | [optional] +**SeenAt** | **System.DateTime** | | [optional] +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$TrackingPixelDto = Initialize-maislurp-client-powershellTrackingPixelDto -Id null ` + -Seen null ` + -Recipient null ` + -Html null ` + -Url null ` + -InboxId null ` + -SentEmailId null ` + -SeenAt null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$TrackingPixelDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/TrackingPixelProjection.md b/docs/TrackingPixelProjection.md new file mode 100644 index 00000000..00191192 --- /dev/null +++ b/docs/TrackingPixelProjection.md @@ -0,0 +1,37 @@ +# TrackingPixelProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | | [optional] +**UserId** | **String** | | +**SentEmailId** | **String** | | [optional] +**Recipient** | **String** | | [optional] +**Seen** | **Boolean** | | +**SeenAt** | **System.DateTime** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Name** | **String** | | [optional] +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$TrackingPixelProjection = Initialize-maislurp-client-powershellTrackingPixelProjection -InboxId null ` + -UserId null ` + -SentEmailId null ` + -Recipient null ` + -Seen null ` + -SeenAt null ` + -CreatedAt null ` + -Name null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$TrackingPixelProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UnknownMissedEmailProjection.md b/docs/UnknownMissedEmailProjection.md new file mode 100644 index 00000000..5b0040a7 --- /dev/null +++ b/docs/UnknownMissedEmailProjection.md @@ -0,0 +1,29 @@ +# UnknownMissedEmailProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**To** | **String[]** | | [optional] +**CreatedAt** | **System.DateTime** | | +**Subject** | **String** | | [optional] +**Id** | **String** | | +**VarFrom** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$UnknownMissedEmailProjection = Initialize-maislurp-client-powershellUnknownMissedEmailProjection -To null ` + -CreatedAt null ` + -Subject null ` + -Id null ` + -VarFrom null +``` + +- Convert the resource to JSON +```powershell +$UnknownMissedEmailProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UnreadCount.md b/docs/UnreadCount.md new file mode 100644 index 00000000..8bf19af7 --- /dev/null +++ b/docs/UnreadCount.md @@ -0,0 +1,21 @@ +# UnreadCount +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **Int64** | | + +## Examples + +- Prepare the resource +```powershell +$UnreadCount = Initialize-maislurp-client-powershellUnreadCount -Count null +``` + +- Convert the resource to JSON +```powershell +$UnreadCount | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UnseenErrorCountDto.md b/docs/UnseenErrorCountDto.md new file mode 100644 index 00000000..db72e055 --- /dev/null +++ b/docs/UnseenErrorCountDto.md @@ -0,0 +1,21 @@ +# UnseenErrorCountDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **Int64** | | + +## Examples + +- Prepare the resource +```powershell +$UnseenErrorCountDto = Initialize-maislurp-client-powershellUnseenErrorCountDto -Count null +``` + +- Convert the resource to JSON +```powershell +$UnseenErrorCountDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateAliasOptions.md b/docs/UpdateAliasOptions.md new file mode 100644 index 00000000..b4900ae1 --- /dev/null +++ b/docs/UpdateAliasOptions.md @@ -0,0 +1,21 @@ +# UpdateAliasOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Optional name for alias | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateAliasOptions = Initialize-maislurp-client-powershellUpdateAliasOptions -Name null +``` + +- Convert the resource to JSON +```powershell +$UpdateAliasOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateDomainOptions.md b/docs/UpdateDomainOptions.md new file mode 100644 index 00000000..2519a5d5 --- /dev/null +++ b/docs/UpdateDomainOptions.md @@ -0,0 +1,21 @@ +# UpdateDomainOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CatchAllInboxId** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateDomainOptions = Initialize-maislurp-client-powershellUpdateDomainOptions -CatchAllInboxId null +``` + +- Convert the resource to JSON +```powershell +$UpdateDomainOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateGroupContacts.md b/docs/UpdateGroupContacts.md new file mode 100644 index 00000000..f3049b18 --- /dev/null +++ b/docs/UpdateGroupContacts.md @@ -0,0 +1,21 @@ +# UpdateGroupContacts +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContactIds** | **String[]** | | + +## Examples + +- Prepare the resource +```powershell +$UpdateGroupContacts = Initialize-maislurp-client-powershellUpdateGroupContacts -ContactIds null +``` + +- Convert the resource to JSON +```powershell +$UpdateGroupContacts | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateImapAccessOptions.md b/docs/UpdateImapAccessOptions.md new file mode 100644 index 00000000..b4b118e7 --- /dev/null +++ b/docs/UpdateImapAccessOptions.md @@ -0,0 +1,23 @@ +# UpdateImapAccessOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ImapUsername** | **String** | IMAP username for login | [optional] +**ImapPassword** | **String** | IMAP password for login | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateImapAccessOptions = Initialize-maislurp-client-powershellUpdateImapAccessOptions -ImapUsername null ` + -ImapPassword null +``` + +- Convert the resource to JSON +```powershell +$UpdateImapAccessOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateInboxOptions.md b/docs/UpdateInboxOptions.md new file mode 100644 index 00000000..3d81ffcb --- /dev/null +++ b/docs/UpdateInboxOptions.md @@ -0,0 +1,29 @@ +# UpdateInboxOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search | [optional] +**Description** | **String** | Description of an inbox for labelling and searching purposes | [optional] +**Tags** | **String[]** | Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. | [optional] +**ExpiresAt** | **System.DateTime** | Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. | [optional] +**Favourite** | **Boolean** | Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateInboxOptions = Initialize-maislurp-client-powershellUpdateInboxOptions -Name null ` + -Description null ` + -Tags null ` + -ExpiresAt null ` + -Favourite null +``` + +- Convert the resource to JSON +```powershell +$UpdateInboxOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateInboxReplierOptions.md b/docs/UpdateInboxReplierOptions.md new file mode 100644 index 00000000..ad5cf2ce --- /dev/null +++ b/docs/UpdateInboxReplierOptions.md @@ -0,0 +1,45 @@ +# UpdateInboxReplierOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | Inbox ID to attach replier to | +**Name** | **String** | Name for replier | [optional] +**Field** | **String** | Field to match against to trigger inbox replier for inbound email | +**Match** | **String** | String or wildcard style match for field specified when evaluating reply rules | +**ReplyTo** | **String** | Reply-to email address when sending replying | [optional] +**Subject** | **String** | Subject override when replying to email | [optional] +**VarFrom** | **String** | Send email from address | [optional] +**Charset** | **String** | Email reply charset | [optional] +**IsHTML** | **Boolean** | Send HTML email | [optional] +**IgnoreReplyTo** | **Boolean** | Ignore sender replyTo when responding. Send directly to the sender if enabled. | [optional] +**Body** | **String** | Email body for reply | [optional] +**TemplateId** | **String** | ID of template to use when sending a reply | [optional] +**TemplateVariables** | [**System.Collections.Hashtable**](SystemCollectionsHashtable) | Template variable values | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateInboxReplierOptions = Initialize-maislurp-client-powershellUpdateInboxReplierOptions -InboxId null ` + -Name null ` + -Field null ` + -Match null ` + -ReplyTo null ` + -Subject null ` + -VarFrom null ` + -Charset null ` + -IsHTML null ` + -IgnoreReplyTo null ` + -Body null ` + -TemplateId null ` + -TemplateVariables null +``` + +- Convert the resource to JSON +```powershell +$UpdateInboxReplierOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UpdateSmtpAccessOptions.md b/docs/UpdateSmtpAccessOptions.md new file mode 100644 index 00000000..6bea0e00 --- /dev/null +++ b/docs/UpdateSmtpAccessOptions.md @@ -0,0 +1,23 @@ +# UpdateSmtpAccessOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SmtpUsername** | **String** | SMTP username for login | [optional] +**SmtpPassword** | **String** | SMTP password for login | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateSmtpAccessOptions = Initialize-maislurp-client-powershellUpdateSmtpAccessOptions -SmtpUsername null ` + -SmtpPassword null +``` + +- Convert the resource to JSON +```powershell +$UpdateSmtpAccessOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UploadAttachmentOptions.md b/docs/UploadAttachmentOptions.md new file mode 100644 index 00000000..d771855e --- /dev/null +++ b/docs/UploadAttachmentOptions.md @@ -0,0 +1,27 @@ +# UploadAttachmentOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContentId** | **String** | Optional contentId for file. | [optional] +**ContentType** | **String** | Optional contentType for file. For instance `application/pdf` | [optional] +**Filename** | **String** | Optional filename to save upload with. Will be the name that is shown in email clients | [optional] +**Base64Contents** | **String** | Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/ | + +## Examples + +- Prepare the resource +```powershell +$UploadAttachmentOptions = Initialize-maislurp-client-powershellUploadAttachmentOptions -ContentId null ` + -ContentType null ` + -Filename null ` + -Base64Contents null +``` + +- Convert the resource to JSON +```powershell +$UploadAttachmentOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/UserControllerApi.md b/docs/UserControllerApi.md new file mode 100644 index 00000000..d6ebc011 --- /dev/null +++ b/docs/UserControllerApi.md @@ -0,0 +1,106 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.UserControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-JsonPropertyAsString**](UserControllerApi#Get-JsonPropertyAsString) | **POST** /user/json/pluck | +[**Get-UserInfo**](UserControllerApi#Get-UserInfo) | **GET** /user/info | + + + +# **Get-JsonPropertyAsString** +> String Get-JsonPropertyAsString
+>         [-Property]
+>         [-Body]
+ + + +Utility function to extract properties from JSON objects in language where this is cumbersome. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Property = "Property_example" # String | JSON property name or dot separated path selector such as `a.b.c` +$Body = TODO # SystemCollectionsHashtable | + +try { + $Result = Get-JsonPropertyAsString -Property $Property -Body $Body +} catch { + Write-Host ("Exception occured when calling Get-JsonPropertyAsString: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Property** | **String**| JSON property name or dot separated path selector such as `a.b.c` | + **Body** | **SystemCollectionsHashtable**| | + +### Return type + +**String** + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-UserInfo** +> UserInfoDto Get-UserInfo
+ + + +Get account information for your user + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-UserInfo +} catch { + Write-Host ("Exception occured when calling Get-UserInfo: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserInfoDto**](UserInfoDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/UserInfoDto.md b/docs/UserInfoDto.md new file mode 100644 index 00000000..f077a0ad --- /dev/null +++ b/docs/UserInfoDto.md @@ -0,0 +1,31 @@ +# UserInfoDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | +**EmailAddress** | **String** | | +**AccountState** | **String** | | +**SubscriptionType** | **String** | | [optional] +**AccountType** | **String** | | +**CreatedAt** | **System.DateTime** | | + +## Examples + +- Prepare the resource +```powershell +$UserInfoDto = Initialize-maislurp-client-powershellUserInfoDto -Id null ` + -EmailAddress null ` + -AccountState null ` + -SubscriptionType null ` + -AccountType null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$UserInfoDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ValidateEmailAddressListOptions.md b/docs/ValidateEmailAddressListOptions.md new file mode 100644 index 00000000..53b33bef --- /dev/null +++ b/docs/ValidateEmailAddressListOptions.md @@ -0,0 +1,23 @@ +# ValidateEmailAddressListOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddressList** | **String[]** | | +**IgnoreOldResults** | **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ValidateEmailAddressListOptions = Initialize-maislurp-client-powershellValidateEmailAddressListOptions -EmailAddressList null ` + -IgnoreOldResults null +``` + +- Convert the resource to JSON +```powershell +$ValidateEmailAddressListOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ValidateEmailAddressListResult.md b/docs/ValidateEmailAddressListResult.md new file mode 100644 index 00000000..6cd040f5 --- /dev/null +++ b/docs/ValidateEmailAddressListResult.md @@ -0,0 +1,25 @@ +# ValidateEmailAddressListResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidEmailAddresses** | **String[]** | | +**InvalidEmailAddresses** | **String[]** | | +**ResultMapEmailAddressIsValid** | **System.Collections.Hashtable** | | + +## Examples + +- Prepare the resource +```powershell +$ValidateEmailAddressListResult = Initialize-maislurp-client-powershellValidateEmailAddressListResult -ValidEmailAddresses null ` + -InvalidEmailAddresses null ` + -ResultMapEmailAddressIsValid null +``` + +- Convert the resource to JSON +```powershell +$ValidateEmailAddressListResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ValidationDto.md b/docs/ValidationDto.md new file mode 100644 index 00000000..9ba8f296 --- /dev/null +++ b/docs/ValidationDto.md @@ -0,0 +1,23 @@ +# ValidationDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailId** | **String** | ID of the email validated | +**Html** | [**HTMLValidationResult**](HTMLValidationResult) | | + +## Examples + +- Prepare the resource +```powershell +$ValidationDto = Initialize-maislurp-client-powershellValidationDto -EmailId null ` + -Html null +``` + +- Convert the resource to JSON +```powershell +$ValidationDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/ValidationMessage.md b/docs/ValidationMessage.md new file mode 100644 index 00000000..0880e5cc --- /dev/null +++ b/docs/ValidationMessage.md @@ -0,0 +1,23 @@ +# ValidationMessage +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LineNumber** | **Int32** | | +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ValidationMessage = Initialize-maislurp-client-powershellValidationMessage -LineNumber null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$ValidationMessage | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/VerifyEmailAddressOptions.md b/docs/VerifyEmailAddressOptions.md new file mode 100644 index 00000000..5a7f3e99 --- /dev/null +++ b/docs/VerifyEmailAddressOptions.md @@ -0,0 +1,27 @@ +# VerifyEmailAddressOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MailServerDomain** | **String** | | [optional] +**EmailAddress** | **String** | | +**SenderEmailAddress** | **String** | | [optional] +**Port** | **Int32** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VerifyEmailAddressOptions = Initialize-maislurp-client-powershellVerifyEmailAddressOptions -MailServerDomain null ` + -EmailAddress null ` + -SenderEmailAddress null ` + -Port null +``` + +- Convert the resource to JSON +```powershell +$VerifyEmailAddressOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/VerifyWebhookSignatureOptions.md b/docs/VerifyWebhookSignatureOptions.md new file mode 100644 index 00000000..ef0a4108 --- /dev/null +++ b/docs/VerifyWebhookSignatureOptions.md @@ -0,0 +1,23 @@ +# VerifyWebhookSignatureOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | | +**Signature** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$VerifyWebhookSignatureOptions = Initialize-maislurp-client-powershellVerifyWebhookSignatureOptions -MessageId null ` + -Signature null +``` + +- Convert the resource to JSON +```powershell +$VerifyWebhookSignatureOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/VerifyWebhookSignatureResults.md b/docs/VerifyWebhookSignatureResults.md new file mode 100644 index 00000000..5e852ecb --- /dev/null +++ b/docs/VerifyWebhookSignatureResults.md @@ -0,0 +1,21 @@ +# VerifyWebhookSignatureResults +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | **Boolean** | | + +## Examples + +- Prepare the resource +```powershell +$VerifyWebhookSignatureResults = Initialize-maislurp-client-powershellVerifyWebhookSignatureResults -IsValid null +``` + +- Convert the resource to JSON +```powershell +$VerifyWebhookSignatureResults | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WaitForConditions.md b/docs/WaitForConditions.md new file mode 100644 index 00000000..277b4866 --- /dev/null +++ b/docs/WaitForConditions.md @@ -0,0 +1,39 @@ +# WaitForConditions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InboxId** | **String** | ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count. | +**Count** | **Int32** | Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation. | [optional] +**DelayTimeout** | **Int64** | Max time in milliseconds to wait between retries if a `timeout` is specified. | [optional] +**Timeout** | **Int64** | Max time in milliseconds to retry the `waitFor` operation until conditions are met. | +**UnreadOnly** | **Boolean** | Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard. | [optional] +**CountType** | **String** | How result size should be compared with the expected size. Exactly or at-least matching result? | [optional] +**VarMatches** | [**MatchOption[]**](MatchOption) | Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for. | [optional] +**SortDirection** | **String** | Direction to sort matching emails by created time | [optional] +**Since** | **System.DateTime** | ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date | [optional] +**Before** | **System.DateTime** | ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date | [optional] + +## Examples + +- Prepare the resource +```powershell +$WaitForConditions = Initialize-maislurp-client-powershellWaitForConditions -InboxId null ` + -Count null ` + -DelayTimeout null ` + -Timeout null ` + -UnreadOnly null ` + -CountType null ` + -VarMatches null ` + -SortDirection null ` + -Since null ` + -Before null +``` + +- Convert the resource to JSON +```powershell +$WaitForConditions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WaitForControllerApi.md b/docs/WaitForControllerApi.md new file mode 100644 index 00000000..9a313f81 --- /dev/null +++ b/docs/WaitForControllerApi.md @@ -0,0 +1,521 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.WaitForControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Wait-For**](WaitForControllerApi#Wait-For) | **POST** /waitFor | Wait for an email to match the provided filter conditions such as subject contains keyword. +[**Wait-ForEmailCount**](WaitForControllerApi#Wait-ForEmailCount) | **GET** /waitForEmailCount | Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs +[**Wait-ForLatestEmail**](WaitForControllerApi#Wait-ForLatestEmail) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for an email to arrive +[**Wait-ForLatestSms**](WaitForControllerApi#Wait-ForLatestSms) | **POST** /waitForLatestSms | Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. +[**Wait-ForMatchingEmails**](WaitForControllerApi#Wait-ForMatchingEmails) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns +[**Wait-ForMatchingFirstEmail**](WaitForControllerApi#Wait-ForMatchingFirstEmail) | **POST** /waitForMatchingFirstEmail | Wait for or return the first email that matches provided MatchOptions array +[**Wait-ForNthEmail**](WaitForControllerApi#Wait-ForNthEmail) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. +[**Wait-ForSms**](WaitForControllerApi#Wait-ForSms) | **POST** /waitForSms | Wait for an SMS message to match the provided filter conditions such as body contains keyword. + + + +# **Wait-For** +> EmailPreview[] Wait-For
+>         [-WaitForConditions]
+ +Wait for an email to match the provided filter conditions such as subject contains keyword. + +Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WaitForConditions = (Initialize-WaitForConditions -InboxId "InboxId_example" -Count 123 -DelayTimeout 123 -Timeout 123 -UnreadOnly $false -CountType "EXACTLY" -VarMatches @((Initialize-MatchOption -Field "SUBJECT" -Should "MATCH" -Value "Value_example")) -SortDirection "ASC" -Since Get-Date -Before Get-Date) # WaitForConditions | + +# Wait for an email to match the provided filter conditions such as subject contains keyword. +try { + $Result = Wait-For -WaitForConditions $WaitForConditions +} catch { + Write-Host ("Exception occured when calling Wait-For: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WaitForConditions** | [**WaitForConditions**](WaitForConditions)| | + +### Return type + +[**EmailPreview[]**](EmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForEmailCount** +> EmailPreview[] Wait-ForEmailCount
+>         [-InboxId]
+>         [-Count]
+>         [-Timeout]
+>         [-UnreadOnly]
+>         [-Before]
+>         [-Since]
+>         [-Sort]
+>         [-Delay]
+ +Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs + +If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of the inbox we are fetching emails from +$Count = 987 # Int32 | Number of emails to wait for. Must be greater that 1 +$Timeout = 987 # Int64 | Max milliseconds to wait (optional) +$UnreadOnly = true # Boolean | Optional filter for unread only (optional) (default to $false) +$Before = Get-Date # System.DateTime | Filter for emails that were received before the given timestamp (optional) +$Since = Get-Date # System.DateTime | Filter for emails that were received after the given timestamp (optional) +$Sort = "ASC" # String | Sort direction (optional) +$Delay = 987 # Int64 | Max milliseconds delay between calls (optional) + +# Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs +try { + $Result = Wait-ForEmailCount -InboxId $InboxId -Count $Count -Timeout $Timeout -UnreadOnly $UnreadOnly -Before $Before -Since $Since -Sort $Sort -Delay $Delay +} catch { + Write-Host ("Exception occured when calling Wait-ForEmailCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of the inbox we are fetching emails from | + **Count** | **Int32**| Number of emails to wait for. Must be greater that 1 | + **Timeout** | **Int64**| Max milliseconds to wait | [optional] + **UnreadOnly** | **Boolean**| Optional filter for unread only | [optional] [default to $false] + **Before** | **System.DateTime**| Filter for emails that were received before the given timestamp | [optional] + **Since** | **System.DateTime**| Filter for emails that were received after the given timestamp | [optional] + **Sort** | **String**| Sort direction | [optional] + **Delay** | **Int64**| Max milliseconds delay between calls | [optional] + +### Return type + +[**EmailPreview[]**](EmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForLatestEmail** +> Email Wait-ForLatestEmail
+>         [-InboxId]
+>         [-Timeout]
+>         [-UnreadOnly]
+>         [-Before]
+>         [-Since]
+>         [-Sort]
+>         [-Delay]
+ +Fetch inbox's latest email or if empty wait for an email to arrive + +Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of the inbox we are fetching emails from (optional) +$Timeout = 987 # Int64 | Max milliseconds to wait (optional) +$UnreadOnly = true # Boolean | Optional filter for unread only. (optional) (default to $false) +$Before = Get-Date # System.DateTime | Filter for emails that were before after the given timestamp (optional) +$Since = Get-Date # System.DateTime | Filter for emails that were received after the given timestamp (optional) +$Sort = "ASC" # String | Sort direction (optional) +$Delay = 987 # Int64 | Max milliseconds delay between calls (optional) + +# Fetch inbox's latest email or if empty wait for an email to arrive +try { + $Result = Wait-ForLatestEmail -InboxId $InboxId -Timeout $Timeout -UnreadOnly $UnreadOnly -Before $Before -Since $Since -Sort $Sort -Delay $Delay +} catch { + Write-Host ("Exception occured when calling Wait-ForLatestEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of the inbox we are fetching emails from | [optional] + **Timeout** | **Int64**| Max milliseconds to wait | [optional] + **UnreadOnly** | **Boolean**| Optional filter for unread only. | [optional] [default to $false] + **Before** | **System.DateTime**| Filter for emails that were before after the given timestamp | [optional] + **Since** | **System.DateTime**| Filter for emails that were received after the given timestamp | [optional] + **Sort** | **String**| Sort direction | [optional] + **Delay** | **Int64**| Max milliseconds delay between calls | [optional] + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForLatestSms** +> SmsDto Wait-ForLatestSms
+>         [-WaitForSingleSmsOptions]
+ +Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. + +Wait until a phone number meets given conditions or return immediately if already met + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WaitForSingleSmsOptions = (Initialize-WaitForSingleSmsOptions -PhoneNumberId "PhoneNumberId_example" -Timeout 123 -UnreadOnly $false -Before Get-Date -Since Get-Date -SortDirection "ASC" -Delay 123) # WaitForSingleSmsOptions | + +# Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. +try { + $Result = Wait-ForLatestSms -WaitForSingleSmsOptions $WaitForSingleSmsOptions +} catch { + Write-Host ("Exception occured when calling Wait-ForLatestSms: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WaitForSingleSmsOptions** | [**WaitForSingleSmsOptions**](WaitForSingleSmsOptions)| | + +### Return type + +[**SmsDto**](SmsDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForMatchingEmails** +> EmailPreview[] Wait-ForMatchingEmails
+>         [-InboxId]
+>         [-Count]
+>         [-MatchOptions]
+>         [-Before]
+>         [-Since]
+>         [-Sort]
+>         [-Delay]
+>         [-Timeout]
+>         [-UnreadOnly]
+ +Wait or return list of emails that match simple matching patterns + +Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of the inbox we are fetching emails from +$Count = 987 # Int32 | Number of emails to wait for. Must be greater or equal to 1 +$MatchOptions = (Initialize-MatchOptions -VarMatches @((Initialize-MatchOption -Field "SUBJECT" -Should "MATCH" -Value "Value_example")) -Conditions @((Initialize-ConditionOption -Condition "HAS_ATTACHMENTS" -Value "TRUE"))) # MatchOptions | +$Before = Get-Date # System.DateTime | Filter for emails that were received before the given timestamp (optional) +$Since = Get-Date # System.DateTime | Filter for emails that were received after the given timestamp (optional) +$Sort = "ASC" # String | Sort direction (optional) +$Delay = 987 # Int64 | Max milliseconds delay between calls (optional) +$Timeout = 987 # Int64 | Max milliseconds to wait (optional) +$UnreadOnly = true # Boolean | Optional filter for unread only (optional) (default to $false) + +# Wait or return list of emails that match simple matching patterns +try { + $Result = Wait-ForMatchingEmails -InboxId $InboxId -Count $Count -MatchOptions $MatchOptions -Before $Before -Since $Since -Sort $Sort -Delay $Delay -Timeout $Timeout -UnreadOnly $UnreadOnly +} catch { + Write-Host ("Exception occured when calling Wait-ForMatchingEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of the inbox we are fetching emails from | + **Count** | **Int32**| Number of emails to wait for. Must be greater or equal to 1 | + **MatchOptions** | [**MatchOptions**](MatchOptions)| | + **Before** | **System.DateTime**| Filter for emails that were received before the given timestamp | [optional] + **Since** | **System.DateTime**| Filter for emails that were received after the given timestamp | [optional] + **Sort** | **String**| Sort direction | [optional] + **Delay** | **Int64**| Max milliseconds delay between calls | [optional] + **Timeout** | **Int64**| Max milliseconds to wait | [optional] + **UnreadOnly** | **Boolean**| Optional filter for unread only | [optional] [default to $false] + +### Return type + +[**EmailPreview[]**](EmailPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForMatchingFirstEmail** +> Email Wait-ForMatchingFirstEmail
+>         [-InboxId]
+>         [-MatchOptions]
+>         [-Timeout]
+>         [-UnreadOnly]
+>         [-Since]
+>         [-Before]
+>         [-Sort]
+>         [-Delay]
+ +Wait for or return the first email that matches provided MatchOptions array + +Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of the inbox we are matching an email for +$MatchOptions = (Initialize-MatchOptions -VarMatches @() -Conditions @((Initialize-ConditionOption -Condition "HAS_ATTACHMENTS" -Value "TRUE"))) # MatchOptions | +$Timeout = 987 # Int64 | Max milliseconds to wait (optional) +$UnreadOnly = true # Boolean | Optional filter for unread only (optional) (default to $false) +$Since = Get-Date # System.DateTime | Filter for emails that were received after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter for emails that were received before the given timestamp (optional) +$Sort = "ASC" # String | Sort direction (optional) +$Delay = 987 # Int64 | Max milliseconds delay between calls (optional) + +# Wait for or return the first email that matches provided MatchOptions array +try { + $Result = Wait-ForMatchingFirstEmail -InboxId $InboxId -MatchOptions $MatchOptions -Timeout $Timeout -UnreadOnly $UnreadOnly -Since $Since -Before $Before -Sort $Sort -Delay $Delay +} catch { + Write-Host ("Exception occured when calling Wait-ForMatchingFirstEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of the inbox we are matching an email for | + **MatchOptions** | [**MatchOptions**](MatchOptions)| | + **Timeout** | **Int64**| Max milliseconds to wait | [optional] + **UnreadOnly** | **Boolean**| Optional filter for unread only | [optional] [default to $false] + **Since** | **System.DateTime**| Filter for emails that were received after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter for emails that were received before the given timestamp | [optional] + **Sort** | **String**| Sort direction | [optional] + **Delay** | **Int64**| Max milliseconds delay between calls | [optional] + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForNthEmail** +> Email Wait-ForNthEmail
+>         [-InboxId]
+>         [-Index]
+>         [-Timeout]
+>         [-UnreadOnly]
+>         [-Since]
+>         [-Before]
+>         [-Sort]
+>         [-Delay]
+ +Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. + +If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | Id of the inbox you are fetching emails from (optional) +$Index = 987 # Int32 | Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional) (default to 0) +$Timeout = 987 # Int64 | Max milliseconds to wait for the nth email if not already present (optional) +$UnreadOnly = true # Boolean | Optional filter for unread only (optional) (default to $false) +$Since = Get-Date # System.DateTime | Filter for emails that were received after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter for emails that were received before the given timestamp (optional) +$Sort = "ASC" # String | Sort direction (optional) +$Delay = 987 # Int64 | Max milliseconds delay between calls (optional) + +# Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. +try { + $Result = Wait-ForNthEmail -InboxId $InboxId -Index $Index -Timeout $Timeout -UnreadOnly $UnreadOnly -Since $Since -Before $Before -Sort $Sort -Delay $Delay +} catch { + Write-Host ("Exception occured when calling Wait-ForNthEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| Id of the inbox you are fetching emails from | [optional] + **Index** | **Int32**| Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 | [optional] [default to 0] + **Timeout** | **Int64**| Max milliseconds to wait for the nth email if not already present | [optional] + **UnreadOnly** | **Boolean**| Optional filter for unread only | [optional] [default to $false] + **Since** | **System.DateTime**| Filter for emails that were received after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter for emails that were received before the given timestamp | [optional] + **Sort** | **String**| Sort direction | [optional] + **Delay** | **Int64**| Max milliseconds delay between calls | [optional] + +### Return type + +[**Email**](Email) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForSms** +> SmsPreview[] Wait-ForSms
+>         [-WaitForSmsConditions]
+ +Wait for an SMS message to match the provided filter conditions such as body contains keyword. + +Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WaitForSmsConditions = (Initialize-WaitForSmsConditions -PhoneNumberId "PhoneNumberId_example" -Limit 123 -Count 123 -DelayTimeout 123 -Timeout 123 -UnreadOnly $false -CountType "EXACTLY" -VarMatches @((Initialize-SmsMatchOption -Field "BODY" -Should "MATCH" -Value "Value_example")) -SortDirection "ASC" -Since Get-Date -Before Get-Date) # WaitForSmsConditions | + +# Wait for an SMS message to match the provided filter conditions such as body contains keyword. +try { + $Result = Wait-ForSms -WaitForSmsConditions $WaitForSmsConditions +} catch { + Write-Host ("Exception occured when calling Wait-ForSms: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WaitForSmsConditions** | [**WaitForSmsConditions**](WaitForSmsConditions)| | + +### Return type + +[**SmsPreview[]**](SmsPreview) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/WaitForSingleSmsOptions.md b/docs/WaitForSingleSmsOptions.md new file mode 100644 index 00000000..bdf3c5be --- /dev/null +++ b/docs/WaitForSingleSmsOptions.md @@ -0,0 +1,33 @@ +# WaitForSingleSmsOptions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PhoneNumberId** | **String** | | +**Timeout** | **Int64** | | +**UnreadOnly** | **Boolean** | | [optional] +**Before** | **System.DateTime** | | [optional] +**Since** | **System.DateTime** | | [optional] +**SortDirection** | **String** | | [optional] +**Delay** | **Int64** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WaitForSingleSmsOptions = Initialize-maislurp-client-powershellWaitForSingleSmsOptions -PhoneNumberId null ` + -Timeout null ` + -UnreadOnly null ` + -Before null ` + -Since null ` + -SortDirection null ` + -Delay null +``` + +- Convert the resource to JSON +```powershell +$WaitForSingleSmsOptions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WaitForSmsConditions.md b/docs/WaitForSmsConditions.md new file mode 100644 index 00000000..9c1c2a3c --- /dev/null +++ b/docs/WaitForSmsConditions.md @@ -0,0 +1,41 @@ +# WaitForSmsConditions +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PhoneNumberId** | **String** | ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count. | +**Limit** | **Int32** | Limit results | [optional] +**Count** | **Int64** | Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation. | +**DelayTimeout** | **Int64** | Max time in milliseconds to wait between retries if a `timeout` is specified. | [optional] +**Timeout** | **Int64** | Max time in milliseconds to retry the `waitFor` operation until conditions are met. | +**UnreadOnly** | **Boolean** | Apply conditions only to **unread** SMS. All SMS messages begin with `read=false`. An SMS is marked `read=true` when an `SMS` has been returned to the user at least once. For example you have called `getSms` or `waitForSms` etc., or you have viewed the SMS in the dashboard. | [optional] +**CountType** | **String** | How result size should be compared with the expected size. Exactly or at-least matching result? | [optional] +**VarMatches** | [**SmsMatchOption[]**](SmsMatchOption) | Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for. | [optional] +**SortDirection** | **String** | Direction to sort matching SMSs by created time | [optional] +**Since** | **System.DateTime** | ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date | [optional] +**Before** | **System.DateTime** | ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date | [optional] + +## Examples + +- Prepare the resource +```powershell +$WaitForSmsConditions = Initialize-maislurp-client-powershellWaitForSmsConditions -PhoneNumberId null ` + -Limit null ` + -Count null ` + -DelayTimeout null ` + -Timeout null ` + -UnreadOnly null ` + -CountType null ` + -VarMatches null ` + -SortDirection null ` + -Since null ` + -Before null +``` + +- Convert the resource to JSON +```powershell +$WaitForSmsConditions | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookBouncePayload.md b/docs/WebhookBouncePayload.md new file mode 100644 index 00000000..a9706f9c --- /dev/null +++ b/docs/WebhookBouncePayload.md @@ -0,0 +1,35 @@ +# WebhookBouncePayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**BounceId** | **String** | ID of the bounce email record. Use the ID with the bounce controller to view more information | +**SentToRecipients** | **String[]** | Email sent to recipients | [optional] +**VarSender** | **String** | Sender causing bounce | +**BounceRecipients** | **String[]** | Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookBouncePayload = Initialize-maislurp-client-powershellWebhookBouncePayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -BounceId null ` + -SentToRecipients null ` + -VarSender null ` + -BounceRecipients null +``` + +- Convert the resource to JSON +```powershell +$WebhookBouncePayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookBounceRecipientPayload.md b/docs/WebhookBounceRecipientPayload.md new file mode 100644 index 00000000..fb6d2e25 --- /dev/null +++ b/docs/WebhookBounceRecipientPayload.md @@ -0,0 +1,29 @@ +# WebhookBounceRecipientPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**Recipient** | **String** | Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation. | + +## Examples + +- Prepare the resource +```powershell +$WebhookBounceRecipientPayload = Initialize-maislurp-client-powershellWebhookBounceRecipientPayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -Recipient null +``` + +- Convert the resource to JSON +```powershell +$WebhookBounceRecipientPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookControllerApi.md b/docs/WebhookControllerApi.md new file mode 100644 index 00000000..8c89e2fc --- /dev/null +++ b/docs/WebhookControllerApi.md @@ -0,0 +1,1921 @@ +# maislurp-client-powershell.maislurp-client-powershell/Api.WebhookControllerApi + +All URIs are relative to *https://api.mailslurp.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-AccountWebhook**](WebhookControllerApi#New-AccountWebhook) | **POST** /webhooks | Attach a WebHook URL to an inbox +[**New-Webhook**](WebhookControllerApi#New-Webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox +[**New-WebhookForPhoneNumber**](WebhookControllerApi#New-WebhookForPhoneNumber) | **POST** /phone/numbers/{phoneNumberId}/webhooks | Attach a WebHook URL to a phone number +[**Invoke-DeleteAllWebhooks**](WebhookControllerApi#Invoke-DeleteAllWebhooks) | **DELETE** /webhooks | Delete all webhooks +[**Invoke-DeleteWebhook**](WebhookControllerApi#Invoke-DeleteWebhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox +[**Invoke-DeleteWebhookById**](WebhookControllerApi#Invoke-DeleteWebhookById) | **DELETE** /webhooks/{webhookId} | Delete a webhook +[**Get-AllAccountWebhooks**](WebhookControllerApi#Get-AllAccountWebhooks) | **GET** /webhooks/account/paginated | List account webhooks Paginated +[**Get-AllWebhookResults**](WebhookControllerApi#Get-AllWebhookResults) | **GET** /webhooks/results | Get results for all webhooks +[**Get-AllWebhooks**](WebhookControllerApi#Get-AllWebhooks) | **GET** /webhooks/paginated | List Webhooks Paginated +[**Get-InboxWebhooksPaginated**](WebhookControllerApi#Get-InboxWebhooksPaginated) | **GET** /inboxes/{inboxId}/webhooks/paginated | Get paginated webhooks for an Inbox +[**Get-JsonSchemaForWebhookEvent**](WebhookControllerApi#Get-JsonSchemaForWebhookEvent) | **POST** /webhooks/schema | +[**Get-JsonSchemaForWebhookPayload**](WebhookControllerApi#Get-JsonSchemaForWebhookPayload) | **POST** /webhooks/{webhookId}/schema | +[**Get-PhoneNumberWebhooksPaginated**](WebhookControllerApi#Get-PhoneNumberWebhooksPaginated) | **GET** /phone/numbers/{phoneId}/webhooks/paginated | Get paginated webhooks for a phone number +[**Get-TestWebhookPayload**](WebhookControllerApi#Get-TestWebhookPayload) | **GET** /webhooks/test | +[**Get-TestWebhookPayloadBounce**](WebhookControllerApi#Get-TestWebhookPayloadBounce) | **GET** /webhooks/test/email-bounce-payload | +[**Get-TestWebhookPayloadBounceRecipient**](WebhookControllerApi#Get-TestWebhookPayloadBounceRecipient) | **GET** /webhooks/test/email-bounce-recipient-payload | +[**Get-TestWebhookPayloadDeliveryStatus**](WebhookControllerApi#Get-TestWebhookPayloadDeliveryStatus) | **GET** /webhooks/test/delivery-status-payload | Get webhook test payload for delivery status event +[**Get-TestWebhookPayloadEmailOpened**](WebhookControllerApi#Get-TestWebhookPayloadEmailOpened) | **GET** /webhooks/test/email-opened-payload | +[**Get-TestWebhookPayloadEmailRead**](WebhookControllerApi#Get-TestWebhookPayloadEmailRead) | **GET** /webhooks/test/email-read-payload | +[**Get-TestWebhookPayloadForWebhook**](WebhookControllerApi#Get-TestWebhookPayloadForWebhook) | **POST** /webhooks/{webhookId}/example | +[**Get-TestWebhookPayloadNewAttachment**](WebhookControllerApi#Get-TestWebhookPayloadNewAttachment) | **GET** /webhooks/test/new-attachment-payload | Get webhook test payload for new attachment event +[**Get-TestWebhookPayloadNewContact**](WebhookControllerApi#Get-TestWebhookPayloadNewContact) | **GET** /webhooks/test/new-contact-payload | Get webhook test payload for new contact event +[**Get-TestWebhookPayloadNewEmail**](WebhookControllerApi#Get-TestWebhookPayloadNewEmail) | **GET** /webhooks/test/new-email-payload | Get webhook test payload for new email event +[**Get-TestWebhookPayloadNewSms**](WebhookControllerApi#Get-TestWebhookPayloadNewSms) | **GET** /webhooks/test/new-sms-payload | Get webhook test payload for new sms event +[**Get-Webhook**](WebhookControllerApi#Get-Webhook) | **GET** /webhooks/{webhookId} | Get a webhook +[**Get-WebhookResult**](WebhookControllerApi#Get-WebhookResult) | **GET** /webhooks/results/{webhookResultId} | Get a webhook result for a webhook +[**Get-WebhookResults**](WebhookControllerApi#Get-WebhookResults) | **GET** /webhooks/{webhookId}/results | Get a webhook results for a webhook +[**Get-WebhookResultsCount**](WebhookControllerApi#Get-WebhookResultsCount) | **GET** /webhooks/{webhookId}/results/count | Get a webhook results count for a webhook +[**Get-WebhookResultsUnseenErrorCount**](WebhookControllerApi#Get-WebhookResultsUnseenErrorCount) | **GET** /webhooks/results/unseen-count | Get count of unseen webhook results with error status +[**Get-Webhooks**](WebhookControllerApi#Get-Webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all webhooks for an Inbox +[**Invoke-RedriveAllWebhookResults**](WebhookControllerApi#Invoke-RedriveAllWebhookResults) | **POST** /webhooks/results/redrive | Redrive all webhook results that have failed status +[**Invoke-RedriveWebhookResult**](WebhookControllerApi#Invoke-RedriveWebhookResult) | **POST** /webhooks/results/{webhookResultId}/redrive | Get a webhook result and try to resend the original webhook payload +[**Send-TestData**](WebhookControllerApi#Send-TestData) | **POST** /webhooks/{webhookId}/test | Send webhook test data +[**Update-WebhookHeaders**](WebhookControllerApi#Update-WebhookHeaders) | **PUT** /webhooks/{webhookId}/headers | Update a webhook request headers +[**Test-WebhookSignature**](WebhookControllerApi#Test-WebhookSignature) | **POST** /webhooks/verify | Verify a webhook payload signature +[**Wait-ForWebhookResults**](WebhookControllerApi#Wait-ForWebhookResults) | **GET** /webhooks/{webhookId}/wait | Wait for webhook results for a webhook + + + +# **New-AccountWebhook** +> WebhookDto New-AccountWebhook
+>         [-CreateWebhookOptions]
+ +Attach a WebHook URL to an inbox + +Get notified of account level events such as bounce and bounce recipient. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$CreateWebhookOptions = (Initialize-CreateWebhookOptions -Url "Url_example" -BasicAuth (Initialize-BasicAuthOptions -Username "Username_example" -Password "Password_example") -Name "Name_example" -EventName "EMAIL_RECEIVED" -IncludeHeaders (Initialize-WebhookHeaders -Headers @((Initialize-WebhookHeaderNameValue -Name "Name_example" -Value "Value_example"))) -RequestBodyTemplate "RequestBodyTemplate_example" -UseStaticIpRange $false -IgnoreInsecureSslCertificates $false) # CreateWebhookOptions | + +# Attach a WebHook URL to an inbox +try { + $Result = New-AccountWebhook -CreateWebhookOptions $CreateWebhookOptions +} catch { + Write-Host ("Exception occured when calling New-AccountWebhook: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **CreateWebhookOptions** | [**CreateWebhookOptions**](CreateWebhookOptions)| | + +### Return type + +[**WebhookDto**](WebhookDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-Webhook** +> WebhookDto New-Webhook
+>         [-InboxId]
+>         [-CreateWebhookOptions]
+ +Attach a WebHook URL to an inbox + +Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$CreateWebhookOptions = (Initialize-CreateWebhookOptions -Url "Url_example" -BasicAuth (Initialize-BasicAuthOptions -Username "Username_example" -Password "Password_example") -Name "Name_example" -EventName "EMAIL_RECEIVED" -IncludeHeaders (Initialize-WebhookHeaders -Headers @((Initialize-WebhookHeaderNameValue -Name "Name_example" -Value "Value_example"))) -RequestBodyTemplate "RequestBodyTemplate_example" -UseStaticIpRange $false -IgnoreInsecureSslCertificates $false) # CreateWebhookOptions | + +# Attach a WebHook URL to an inbox +try { + $Result = New-Webhook -InboxId $InboxId -CreateWebhookOptions $CreateWebhookOptions +} catch { + Write-Host ("Exception occured when calling New-Webhook: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **CreateWebhookOptions** | [**CreateWebhookOptions**](CreateWebhookOptions)| | + +### Return type + +[**WebhookDto**](WebhookDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **New-WebhookForPhoneNumber** +> WebhookDto New-WebhookForPhoneNumber
+>         [-PhoneNumberId]
+>         [-CreateWebhookOptions]
+ +Attach a WebHook URL to a phone number + +Get notified whenever a phone number receives an SMS via a WebHook URL. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneNumberId = "PhoneNumberId_example" # String | +$CreateWebhookOptions = # CreateWebhookOptions | + +# Attach a WebHook URL to a phone number +try { + $Result = New-WebhookForPhoneNumber -PhoneNumberId $PhoneNumberId -CreateWebhookOptions $CreateWebhookOptions +} catch { + Write-Host ("Exception occured when calling New-WebhookForPhoneNumber: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneNumberId** | [**String**](String)| | + **CreateWebhookOptions** | [**CreateWebhookOptions**](CreateWebhookOptions)| | + +### Return type + +[**WebhookDto**](WebhookDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteAllWebhooks** +> void Invoke-DeleteAllWebhooks
+>         [-Before]
+ +Delete all webhooks + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Before = Get-Date # System.DateTime | before (optional) + +# Delete all webhooks +try { + $Result = Invoke-DeleteAllWebhooks -Before $Before +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteAllWebhooks: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Before** | **System.DateTime**| before | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteWebhook** +> void Invoke-DeleteWebhook
+>         [-InboxId]
+>         [-WebhookId]
+ +Delete and disable a Webhook for an Inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$WebhookId = "WebhookId_example" # String | + +# Delete and disable a Webhook for an Inbox +try { + $Result = Invoke-DeleteWebhook -InboxId $InboxId -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteWebhook: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **WebhookId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-DeleteWebhookById** +> void Invoke-DeleteWebhookById
+>         [-WebhookId]
+ +Delete a webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | + +# Delete a webhook +try { + $Result = Invoke-DeleteWebhookById -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Invoke-DeleteWebhookById: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| | + +### Return type + +void (empty response body) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllAccountWebhooks** +> PageWebhookProjection Get-AllAccountWebhooks
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-EventType]
+>         [-Since]
+>         [-Before]
+ +List account webhooks Paginated + +List account webhooks in paginated form. Allows for page index, page size, and sort direction. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size for paginated result list. (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "DESC") +$EventType = "EMAIL_RECEIVED" # String | Optional event type (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List account webhooks Paginated +try { + $Result = Get-AllAccountWebhooks -Page $Page -Size $Size -Sort $Sort -EventType $EventType -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllAccountWebhooks: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size for paginated result list. | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "DESC"] + **EventType** | **String**| Optional event type | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageWebhookProjection**](PageWebhookProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllWebhookResults** +> PageWebhookResult Get-AllWebhookResults
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+>         [-UnseenOnly]
+>         [-ResultType]
+>         [-EventName]
+>         [-MinStatusCode]
+>         [-MaxStatusCode]
+>         [-InboxId]
+>         [-SmsId]
+>         [-AttachmentId]
+>         [-EmailId]
+>         [-PhoneId]
+ +Get results for all webhooks + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$UnseenOnly = true # Boolean | Filter for unseen exceptions only (optional) +$ResultType = "BAD_RESPONSE" # String | Filter by result type (optional) +$EventName = "EMAIL_RECEIVED" # String | Filter by event name (optional) +$MinStatusCode = 987 # Int32 | Minimum response status (optional) +$MaxStatusCode = 987 # Int32 | Maximum response status (optional) +$InboxId = "InboxId_example" # String | Inbox ID (optional) +$SmsId = "SmsId_example" # String | Sms ID (optional) +$AttachmentId = "AttachmentId_example" # String | Attachment ID (optional) +$EmailId = "EmailId_example" # String | Email ID (optional) +$PhoneId = "PhoneId_example" # String | Phone ID (optional) + +# Get results for all webhooks +try { + $Result = Get-AllWebhookResults -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -UnseenOnly $UnseenOnly -ResultType $ResultType -EventName $EventName -MinStatusCode $MinStatusCode -MaxStatusCode $MaxStatusCode -InboxId $InboxId -SmsId $SmsId -AttachmentId $AttachmentId -EmailId $EmailId -PhoneId $PhoneId +} catch { + Write-Host ("Exception occured when calling Get-AllWebhookResults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **UnseenOnly** | **Boolean**| Filter for unseen exceptions only | [optional] + **ResultType** | **String**| Filter by result type | [optional] + **EventName** | **String**| Filter by event name | [optional] + **MinStatusCode** | **Int32**| Minimum response status | [optional] + **MaxStatusCode** | **Int32**| Maximum response status | [optional] + **InboxId** | [**String**](String)| Inbox ID | [optional] + **SmsId** | [**String**](String)| Sms ID | [optional] + **AttachmentId** | [**String**](String)| Attachment ID | [optional] + **EmailId** | [**String**](String)| Email ID | [optional] + **PhoneId** | [**String**](String)| Phone ID | [optional] + +### Return type + +[**PageWebhookResult**](PageWebhookResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-AllWebhooks** +> PageWebhookProjection Get-AllWebhooks
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-InboxId]
+>         [-PhoneId]
+>         [-Before]
+ +List Webhooks Paginated + +List webhooks in paginated form. Allows for page index, page size, and sort direction. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size for paginated result list. (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "DESC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$InboxId = "InboxId_example" # String | Filter by inboxId (optional) +$PhoneId = "PhoneId_example" # String | Filter by phoneId (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# List Webhooks Paginated +try { + $Result = Get-AllWebhooks -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -InboxId $InboxId -PhoneId $PhoneId -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-AllWebhooks: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size for paginated result list. | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "DESC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **InboxId** | [**String**](String)| Filter by inboxId | [optional] + **PhoneId** | [**String**](String)| Filter by phoneId | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageWebhookProjection**](PageWebhookProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-InboxWebhooksPaginated** +> PageWebhookProjection Get-InboxWebhooksPaginated
+>         [-InboxId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+ +Get paginated webhooks for an Inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get paginated webhooks for an Inbox +try { + $Result = Get-InboxWebhooksPaginated -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-InboxWebhooksPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageWebhookProjection**](PageWebhookProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-JsonSchemaForWebhookEvent** +> JSONSchemaDto Get-JsonSchemaForWebhookEvent
+>         [-Event]
+ + + +Get JSON Schema definition for webhook payload by event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$Event = "EMAIL_RECEIVED" # String | + +try { + $Result = Get-JsonSchemaForWebhookEvent -Event $Event +} catch { + Write-Host ("Exception occured when calling Get-JsonSchemaForWebhookEvent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Event** | **String**| | + +### Return type + +[**JSONSchemaDto**](JSONSchemaDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-JsonSchemaForWebhookPayload** +> JSONSchemaDto Get-JsonSchemaForWebhookPayload
+>         [-WebhookId]
+ + + +Get JSON Schema definition for webhook payload + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | + +try { + $Result = Get-JsonSchemaForWebhookPayload -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Get-JsonSchemaForWebhookPayload: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| | + +### Return type + +[**JSONSchemaDto**](JSONSchemaDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-PhoneNumberWebhooksPaginated** +> PageWebhookProjection Get-PhoneNumberWebhooksPaginated
+>         [-PhoneId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-Since]
+>         [-Before]
+ +Get paginated webhooks for a phone number + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$PhoneId = "PhoneId_example" # String | +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) + +# Get paginated webhooks for a phone number +try { + $Result = Get-PhoneNumberWebhooksPaginated -PhoneId $PhoneId -Page $Page -Size $Size -Sort $Sort -Since $Since -Before $Before +} catch { + Write-Host ("Exception occured when calling Get-PhoneNumberWebhooksPaginated: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **PhoneId** | [**String**](String)| | + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + +### Return type + +[**PageWebhookProjection**](PageWebhookProjection) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayload** +> AbstractWebhookPayload Get-TestWebhookPayload
+>         [-EventName]
+ + + +Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$EventName = "EMAIL_RECEIVED" # String | (optional) + +try { + $Result = Get-TestWebhookPayload -EventName $EventName +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayload: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **EventName** | **String**| | [optional] + +### Return type + +[**AbstractWebhookPayload**](AbstractWebhookPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadBounce** +> WebhookBouncePayload Get-TestWebhookPayloadBounce
+ + + +Get webhook test payload for bounce + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-TestWebhookPayloadBounce +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadBounce: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookBouncePayload**](WebhookBouncePayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadBounceRecipient** +> WebhookBounceRecipientPayload Get-TestWebhookPayloadBounceRecipient
+ + + +Get webhook test payload for bounce recipient + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-TestWebhookPayloadBounceRecipient +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadBounceRecipient: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookBounceRecipientPayload**](WebhookBounceRecipientPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadDeliveryStatus** +> WebhookDeliveryStatusPayload Get-TestWebhookPayloadDeliveryStatus
+ +Get webhook test payload for delivery status event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get webhook test payload for delivery status event +try { + $Result = Get-TestWebhookPayloadDeliveryStatus +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadDeliveryStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookDeliveryStatusPayload**](WebhookDeliveryStatusPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadEmailOpened** +> WebhookEmailOpenedPayload Get-TestWebhookPayloadEmailOpened
+ + + +Get webhook test payload for email opened event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-TestWebhookPayloadEmailOpened +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadEmailOpened: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookEmailOpenedPayload**](WebhookEmailOpenedPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadEmailRead** +> WebhookEmailReadPayload Get-TestWebhookPayloadEmailRead
+ + + +Get webhook test payload for email opened event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +try { + $Result = Get-TestWebhookPayloadEmailRead +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadEmailRead: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookEmailReadPayload**](WebhookEmailReadPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadForWebhook** +> AbstractWebhookPayload Get-TestWebhookPayloadForWebhook
+>         [-WebhookId]
+ + + +Get example payload for webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | + +try { + $Result = Get-TestWebhookPayloadForWebhook -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadForWebhook: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| | + +### Return type + +[**AbstractWebhookPayload**](AbstractWebhookPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadNewAttachment** +> WebhookNewAttachmentPayload Get-TestWebhookPayloadNewAttachment
+ +Get webhook test payload for new attachment event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get webhook test payload for new attachment event +try { + $Result = Get-TestWebhookPayloadNewAttachment +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadNewAttachment: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookNewAttachmentPayload**](WebhookNewAttachmentPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadNewContact** +> WebhookNewContactPayload Get-TestWebhookPayloadNewContact
+ +Get webhook test payload for new contact event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get webhook test payload for new contact event +try { + $Result = Get-TestWebhookPayloadNewContact +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadNewContact: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookNewContactPayload**](WebhookNewContactPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadNewEmail** +> WebhookNewEmailPayload Get-TestWebhookPayloadNewEmail
+ +Get webhook test payload for new email event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get webhook test payload for new email event +try { + $Result = Get-TestWebhookPayloadNewEmail +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadNewEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookNewEmailPayload**](WebhookNewEmailPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-TestWebhookPayloadNewSms** +> WebhookNewSmsPayload Get-TestWebhookPayloadNewSms
+ +Get webhook test payload for new sms event + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get webhook test payload for new sms event +try { + $Result = Get-TestWebhookPayloadNewSms +} catch { + Write-Host ("Exception occured when calling Get-TestWebhookPayloadNewSms: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookNewSmsPayload**](WebhookNewSmsPayload) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Webhook** +> WebhookDto Get-Webhook
+>         [-WebhookId]
+ +Get a webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | + +# Get a webhook +try { + $Result = Get-Webhook -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Get-Webhook: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| | + +### Return type + +[**WebhookDto**](WebhookDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-WebhookResult** +> WebhookResultDto Get-WebhookResult
+>         [-WebhookResultId]
+ +Get a webhook result for a webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookResultId = "WebhookResultId_example" # String | Webhook Result ID + +# Get a webhook result for a webhook +try { + $Result = Get-WebhookResult -WebhookResultId $WebhookResultId +} catch { + Write-Host ("Exception occured when calling Get-WebhookResult: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookResultId** | [**String**](String)| Webhook Result ID | + +### Return type + +[**WebhookResultDto**](WebhookResultDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-WebhookResults** +> PageWebhookResult Get-WebhookResults
+>         [-WebhookId]
+>         [-Page]
+>         [-Size]
+>         [-Sort]
+>         [-SearchFilter]
+>         [-Since]
+>         [-Before]
+>         [-UnseenOnly]
+>         [-ResultType]
+>         [-EventName]
+>         [-MinStatusCode]
+>         [-MaxStatusCode]
+>         [-InboxId]
+>         [-SmsId]
+>         [-AttachmentId]
+>         [-EmailId]
+>         [-PhoneId]
+ +Get a webhook results for a webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | ID of webhook to get results for +$Page = 987 # Int32 | Optional page index in list pagination (optional) (default to 0) +$Size = 987 # Int32 | Optional page size in list pagination (optional) (default to 20) +$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC") +$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional) +$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional) +$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional) +$UnseenOnly = true # Boolean | Filter for unseen exceptions only (optional) +$ResultType = "BAD_RESPONSE" # String | Filter by result type (optional) +$EventName = "EMAIL_RECEIVED" # String | Filter by event name (optional) +$MinStatusCode = 987 # Int32 | Minimum response status (optional) +$MaxStatusCode = 987 # Int32 | Maximum response status (optional) +$InboxId = "InboxId_example" # String | Inbox ID (optional) +$SmsId = "SmsId_example" # String | Sms ID (optional) +$AttachmentId = "AttachmentId_example" # String | Attachment ID (optional) +$EmailId = "EmailId_example" # String | Email ID (optional) +$PhoneId = "PhoneId_example" # String | Phone ID (optional) + +# Get a webhook results for a webhook +try { + $Result = Get-WebhookResults -WebhookId $WebhookId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -UnseenOnly $UnseenOnly -ResultType $ResultType -EventName $EventName -MinStatusCode $MinStatusCode -MaxStatusCode $MaxStatusCode -InboxId $InboxId -SmsId $SmsId -AttachmentId $AttachmentId -EmailId $EmailId -PhoneId $PhoneId +} catch { + Write-Host ("Exception occured when calling Get-WebhookResults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| ID of webhook to get results for | + **Page** | **Int32**| Optional page index in list pagination | [optional] [default to 0] + **Size** | **Int32**| Optional page size in list pagination | [optional] [default to 20] + **Sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] + **SearchFilter** | **String**| Optional search filter | [optional] + **Since** | **System.DateTime**| Filter by created at after the given timestamp | [optional] + **Before** | **System.DateTime**| Filter by created at before the given timestamp | [optional] + **UnseenOnly** | **Boolean**| Filter for unseen exceptions only | [optional] + **ResultType** | **String**| Filter by result type | [optional] + **EventName** | **String**| Filter by event name | [optional] + **MinStatusCode** | **Int32**| Minimum response status | [optional] + **MaxStatusCode** | **Int32**| Maximum response status | [optional] + **InboxId** | [**String**](String)| Inbox ID | [optional] + **SmsId** | [**String**](String)| Sms ID | [optional] + **AttachmentId** | [**String**](String)| Attachment ID | [optional] + **EmailId** | [**String**](String)| Email ID | [optional] + **PhoneId** | [**String**](String)| Phone ID | [optional] + +### Return type + +[**PageWebhookResult**](PageWebhookResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-WebhookResultsCount** +> CountDto Get-WebhookResultsCount
+>         [-WebhookId]
+ +Get a webhook results count for a webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | ID of webhook to get results for + +# Get a webhook results count for a webhook +try { + $Result = Get-WebhookResultsCount -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Get-WebhookResultsCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| ID of webhook to get results for | + +### Return type + +[**CountDto**](CountDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-WebhookResultsUnseenErrorCount** +> UnseenErrorCountDto Get-WebhookResultsUnseenErrorCount
+ +Get count of unseen webhook results with error status + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Get count of unseen webhook results with error status +try { + $Result = Get-WebhookResultsUnseenErrorCount +} catch { + Write-Host ("Exception occured when calling Get-WebhookResultsUnseenErrorCount: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UnseenErrorCountDto**](UnseenErrorCountDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Get-Webhooks** +> WebhookDto[] Get-Webhooks
+>         [-InboxId]
+ +Get all webhooks for an Inbox + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$InboxId = "InboxId_example" # String | + +# Get all webhooks for an Inbox +try { + $Result = Get-Webhooks -InboxId $InboxId +} catch { + Write-Host ("Exception occured when calling Get-Webhooks: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **InboxId** | [**String**](String)| | + +### Return type + +[**WebhookDto[]**](WebhookDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-RedriveAllWebhookResults** +> WebhookRedriveAllResult Invoke-RedriveAllWebhookResults
+ +Redrive all webhook results that have failed status + +Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + + +# Redrive all webhook results that have failed status +try { + $Result = Invoke-RedriveAllWebhookResults +} catch { + Write-Host ("Exception occured when calling Invoke-RedriveAllWebhookResults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WebhookRedriveAllResult**](WebhookRedriveAllResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Invoke-RedriveWebhookResult** +> WebhookRedriveResult Invoke-RedriveWebhookResult
+>         [-WebhookResultId]
+ +Get a webhook result and try to resend the original webhook payload + +Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookResultId = "WebhookResultId_example" # String | Webhook Result ID + +# Get a webhook result and try to resend the original webhook payload +try { + $Result = Invoke-RedriveWebhookResult -WebhookResultId $WebhookResultId +} catch { + Write-Host ("Exception occured when calling Invoke-RedriveWebhookResult: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookResultId** | [**String**](String)| Webhook Result ID | + +### Return type + +[**WebhookRedriveResult**](WebhookRedriveResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Send-TestData** +> WebhookTestResult Send-TestData
+>         [-WebhookId]
+ +Send webhook test data + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | + +# Send webhook test data +try { + $Result = Send-TestData -WebhookId $WebhookId +} catch { + Write-Host ("Exception occured when calling Send-TestData: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| | + +### Return type + +[**WebhookTestResult**](WebhookTestResult) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Update-WebhookHeaders** +> WebhookDto Update-WebhookHeaders
+>         [-WebhookId]
+>         [-WebhookHeaders]
+ +Update a webhook request headers + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | +$WebhookHeaders = # WebhookHeaders | + +# Update a webhook request headers +try { + $Result = Update-WebhookHeaders -WebhookId $WebhookId -WebhookHeaders $WebhookHeaders +} catch { + Write-Host ("Exception occured when calling Update-WebhookHeaders: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| | + **WebhookHeaders** | [**WebhookHeaders**](WebhookHeaders)| | + +### Return type + +[**WebhookDto**](WebhookDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Test-WebhookSignature** +> VerifyWebhookSignatureResults Test-WebhookSignature
+>         [-VerifyWebhookSignatureOptions]
+ +Verify a webhook payload signature + +Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$VerifyWebhookSignatureOptions = (Initialize-VerifyWebhookSignatureOptions -MessageId "MessageId_example" -Signature "Signature_example") # VerifyWebhookSignatureOptions | + +# Verify a webhook payload signature +try { + $Result = Test-WebhookSignature -VerifyWebhookSignatureOptions $VerifyWebhookSignatureOptions +} catch { + Write-Host ("Exception occured when calling Test-WebhookSignature: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **VerifyWebhookSignatureOptions** | [**VerifyWebhookSignatureOptions**](VerifyWebhookSignatureOptions)| | + +### Return type + +[**VerifyWebhookSignatureResults**](VerifyWebhookSignatureResults) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + + +# **Wait-ForWebhookResults** +> WebhookResultDto[] Wait-ForWebhookResults
+>         [-WebhookId]
+>         [-ExpectedCount]
+>         [-Timeout]
+ +Wait for webhook results for a webhook + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure API key authorization: API_KEY +$Configuration.ApiKey.x-api-key = "YOUR_API_KEY" +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +#$Configuration.ApiKeyPrefix.x-api-key = "Bearer" + +$WebhookId = "WebhookId_example" # String | ID of webhook to get results for +$ExpectedCount = 987 # Int32 | Expected result count +$Timeout = 987 # Int32 | Max time to wait in milliseconds + +# Wait for webhook results for a webhook +try { + $Result = Wait-ForWebhookResults -WebhookId $WebhookId -ExpectedCount $ExpectedCount -Timeout $Timeout +} catch { + Write-Host ("Exception occured when calling Wait-ForWebhookResults: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **WebhookId** | [**String**](String)| ID of webhook to get results for | + **ExpectedCount** | **Int32**| Expected result count | + **Timeout** | **Int32**| Max time to wait in milliseconds | + +### Return type + +[**WebhookResultDto[]**](WebhookResultDto) (PSCustomObject) + +### Authorization + +[API_KEY](../README#API_KEY) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to Model list]](../README#documentation-for-models) [[Back to README]](../README) + diff --git a/docs/WebhookDeliveryStatusPayload.md b/docs/WebhookDeliveryStatusPayload.md new file mode 100644 index 00000000..44a9023f --- /dev/null +++ b/docs/WebhookDeliveryStatusPayload.md @@ -0,0 +1,51 @@ +# WebhookDeliveryStatusPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**Id** | **String** | ID of delivery status | +**UserId** | **String** | User ID of event | +**SentId** | **String** | ID of sent email | [optional] +**RemoteMtaIp** | **String** | IP address of the remote Mail Transfer Agent | [optional] +**InboxId** | **String** | Id of the inbox | [optional] +**ReportingMta** | **String** | Mail Transfer Agent reporting delivery status | [optional] +**Recipients** | **String[]** | Recipients for delivery | [optional] +**SmtpResponse** | **String** | SMTP server response message | [optional] +**SmtpStatusCode** | **Int32** | SMTP server status | [optional] +**ProcessingTimeMillis** | **Int64** | Time in milliseconds for delivery processing | [optional] +**Received** | **System.DateTime** | Time event was received | [optional] +**Subject** | **String** | Email subject | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookDeliveryStatusPayload = Initialize-maislurp-client-powershellWebhookDeliveryStatusPayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -Id null ` + -UserId null ` + -SentId null ` + -RemoteMtaIp null ` + -InboxId null ` + -ReportingMta null ` + -Recipients null ` + -SmtpResponse null ` + -SmtpStatusCode null ` + -ProcessingTimeMillis null ` + -Received null ` + -Subject null +``` + +- Convert the resource to JSON +```powershell +$WebhookDeliveryStatusPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookDto.md b/docs/WebhookDto.md new file mode 100644 index 00000000..60233245 --- /dev/null +++ b/docs/WebhookDto.md @@ -0,0 +1,51 @@ +# WebhookDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the Webhook | +**UserId** | **String** | User ID of the Webhook | +**BasicAuth** | **Boolean** | Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. | +**Name** | **String** | Name of the webhook | [optional] +**PhoneId** | **String** | The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set | [optional] +**InboxId** | **String** | The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set | [optional] +**RequestBodyTemplate** | **String** | Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. | [optional] +**Url** | **String** | URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. | +**Method** | **String** | HTTP method that your server endpoint must listen for | +**PayloadJsonSchema** | **String** | Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method | +**CreatedAt** | **System.DateTime** | When the webhook was created | +**UpdatedAt** | **System.DateTime** | | +**EventName** | **String** | Webhook trigger event name | [optional] +**RequestHeaders** | [**WebhookHeaders**](WebhookHeaders) | | [optional] +**IgnoreInsecureSslCertificates** | **Boolean** | Should notifier ignore insecure SSL certificates | [optional] +**UseStaticIpRange** | **Boolean** | Should notifier use static IP range when sending webhook payload | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookDto = Initialize-maislurp-client-powershellWebhookDto -Id null ` + -UserId null ` + -BasicAuth null ` + -Name null ` + -PhoneId null ` + -InboxId null ` + -RequestBodyTemplate null ` + -Url null ` + -Method null ` + -PayloadJsonSchema null ` + -CreatedAt null ` + -UpdatedAt null ` + -EventName null ` + -RequestHeaders null ` + -IgnoreInsecureSslCertificates null ` + -UseStaticIpRange null +``` + +- Convert the resource to JSON +```powershell +$WebhookDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookEmailOpenedPayload.md b/docs/WebhookEmailOpenedPayload.md new file mode 100644 index 00000000..f6c825a0 --- /dev/null +++ b/docs/WebhookEmailOpenedPayload.md @@ -0,0 +1,37 @@ +# WebhookEmailOpenedPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**InboxId** | **String** | Id of the inbox | +**PixelId** | **String** | ID of the tracking pixel | +**SentEmailId** | **String** | ID of sent email | +**Recipient** | **String** | Email address for the recipient of the tracking pixel | +**CreatedAt** | **System.DateTime** | Date time of event creation | + +## Examples + +- Prepare the resource +```powershell +$WebhookEmailOpenedPayload = Initialize-maislurp-client-powershellWebhookEmailOpenedPayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -InboxId null ` + -PixelId null ` + -SentEmailId null ` + -Recipient null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$WebhookEmailOpenedPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookEmailReadPayload.md b/docs/WebhookEmailReadPayload.md new file mode 100644 index 00000000..3ed0deaf --- /dev/null +++ b/docs/WebhookEmailReadPayload.md @@ -0,0 +1,35 @@ +# WebhookEmailReadPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**EmailId** | **String** | ID of the email that was received. Use this ID for fetching the email with the `EmailController`. | +**InboxId** | **String** | Id of the inbox | +**EmailIsRead** | **Boolean** | Is the email read | +**CreatedAt** | **System.DateTime** | Date time of event creation | + +## Examples + +- Prepare the resource +```powershell +$WebhookEmailReadPayload = Initialize-maislurp-client-powershellWebhookEmailReadPayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -EmailId null ` + -InboxId null ` + -EmailIsRead null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$WebhookEmailReadPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookHeaderNameValue.md b/docs/WebhookHeaderNameValue.md new file mode 100644 index 00000000..fcc55cc4 --- /dev/null +++ b/docs/WebhookHeaderNameValue.md @@ -0,0 +1,23 @@ +# WebhookHeaderNameValue +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of header | +**Value** | **String** | Value of header | + +## Examples + +- Prepare the resource +```powershell +$WebhookHeaderNameValue = Initialize-maislurp-client-powershellWebhookHeaderNameValue -Name null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$WebhookHeaderNameValue | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookHeaders.md b/docs/WebhookHeaders.md new file mode 100644 index 00000000..e981c801 --- /dev/null +++ b/docs/WebhookHeaders.md @@ -0,0 +1,21 @@ +# WebhookHeaders +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Headers** | [**WebhookHeaderNameValue[]**](WebhookHeaderNameValue) | List of header name value pairs to include with webhook requests | + +## Examples + +- Prepare the resource +```powershell +$WebhookHeaders = Initialize-maislurp-client-powershellWebhookHeaders -Headers null +``` + +- Convert the resource to JSON +```powershell +$WebhookHeaders | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookNewAttachmentPayload.md b/docs/WebhookNewAttachmentPayload.md new file mode 100644 index 00000000..f6086c45 --- /dev/null +++ b/docs/WebhookNewAttachmentPayload.md @@ -0,0 +1,35 @@ +# WebhookNewAttachmentPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**AttachmentId** | **String** | ID of attachment. Use the `AttachmentController` to | +**Name** | **String** | Filename of the attachment if present | +**ContentType** | **String** | Content type of attachment such as 'image/png' or 'application/pdf | +**ContentLength** | **Int64** | Size of attachment in bytes | + +## Examples + +- Prepare the resource +```powershell +$WebhookNewAttachmentPayload = Initialize-maislurp-client-powershellWebhookNewAttachmentPayload -MessageId null ` + -WebhookId null ` + -WebhookName null ` + -EventName null ` + -AttachmentId null ` + -Name null ` + -ContentType null ` + -ContentLength null +``` + +- Convert the resource to JSON +```powershell +$WebhookNewAttachmentPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookNewContactPayload.md b/docs/WebhookNewContactPayload.md new file mode 100644 index 00000000..d5451c0c --- /dev/null +++ b/docs/WebhookNewContactPayload.md @@ -0,0 +1,49 @@ +# WebhookNewContactPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**ContactId** | **String** | Contact ID | +**GroupId** | **String** | Contact group ID | [optional] +**FirstName** | **String** | Contact first name | [optional] +**LastName** | **String** | Contact last name | [optional] +**Company** | **String** | Contact company name | [optional] +**PrimaryEmailAddress** | **String** | Primary email address for contact | [optional] +**EmailAddresses** | **String[]** | Email addresses for contact | +**Tags** | **String[]** | Tags for contact | +**MetaData** | [**SystemCollectionsHashtable**]() | | [optional] +**OptOut** | **Boolean** | Has contact opted out of emails | +**CreatedAt** | **System.DateTime** | Date time of event creation | + +## Examples + +- Prepare the resource +```powershell +$WebhookNewContactPayload = Initialize-maislurp-client-powershellWebhookNewContactPayload -MessageId null ` + -WebhookId null ` + -WebhookName null ` + -EventName null ` + -ContactId null ` + -GroupId null ` + -FirstName null ` + -LastName null ` + -Company null ` + -PrimaryEmailAddress null ` + -EmailAddresses null ` + -Tags null ` + -MetaData null ` + -OptOut null ` + -CreatedAt null +``` + +- Convert the resource to JSON +```powershell +$WebhookNewContactPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookNewEmailPayload.md b/docs/WebhookNewEmailPayload.md new file mode 100644 index 00000000..938ebdef --- /dev/null +++ b/docs/WebhookNewEmailPayload.md @@ -0,0 +1,47 @@ +# WebhookNewEmailPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**InboxId** | **String** | Id of the inbox | +**DomainId** | **String** | Id of the domain that received an email | [optional] +**EmailId** | **String** | ID of the email that was received. Use this ID for fetching the email with the `EmailController`. | +**CreatedAt** | **System.DateTime** | Date time of event creation | +**To** | **String[]** | List of `To` recipient email addresses that the email was addressed to. See recipients object for names. | +**VarFrom** | **String** | Who the email was sent from. An email address - see fromName for the sender name. | +**Cc** | **String[]** | List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. | +**Bcc** | **String[]** | List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. | +**Subject** | **String** | The subject line of the email message as specified by SMTP subject header | [optional] +**AttachmentMetaDatas** | [**AttachmentMetaData[]**](AttachmentMetaData) | List of attachment meta data objects if attachments present | + +## Examples + +- Prepare the resource +```powershell +$WebhookNewEmailPayload = Initialize-maislurp-client-powershellWebhookNewEmailPayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -InboxId null ` + -DomainId null ` + -EmailId null ` + -CreatedAt null ` + -To null ` + -VarFrom null ` + -Cc null ` + -Bcc null ` + -Subject null ` + -AttachmentMetaDatas null +``` + +- Convert the resource to JSON +```powershell +$WebhookNewEmailPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookNewSmsPayload.md b/docs/WebhookNewSmsPayload.md new file mode 100644 index 00000000..a26e0835 --- /dev/null +++ b/docs/WebhookNewSmsPayload.md @@ -0,0 +1,41 @@ +# WebhookNewSmsPayload +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MessageId** | **String** | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | +**WebhookId** | **String** | ID of webhook entity being triggered | +**EventName** | **String** | Name of the event type webhook is being triggered for. | +**WebhookName** | **String** | Name of the webhook being triggered | [optional] +**SmsId** | **String** | ID of SMS message | +**UserId** | **String** | User ID of event | +**PhoneNumber** | **String** | ID of phone number receiving SMS | +**ToNumber** | **String** | Recipient phone number | +**FromNumber** | **String** | Sender phone number | +**Body** | **String** | SMS message body | +**Read** | **Boolean** | SMS has been read | + +## Examples + +- Prepare the resource +```powershell +$WebhookNewSmsPayload = Initialize-maislurp-client-powershellWebhookNewSmsPayload -MessageId null ` + -WebhookId null ` + -EventName null ` + -WebhookName null ` + -SmsId null ` + -UserId null ` + -PhoneNumber null ` + -ToNumber null ` + -FromNumber null ` + -Body null ` + -Read null +``` + +- Convert the resource to JSON +```powershell +$WebhookNewSmsPayload | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookProjection.md b/docs/WebhookProjection.md new file mode 100644 index 00000000..4f10a861 --- /dev/null +++ b/docs/WebhookProjection.md @@ -0,0 +1,35 @@ +# WebhookProjection +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | | +**InboxId** | **String** | | [optional] +**EventName** | **String** | | [optional] +**PhoneNumberId** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | +**Name** | **String** | | [optional] +**Id** | **String** | | + +## Examples + +- Prepare the resource +```powershell +$WebhookProjection = Initialize-maislurp-client-powershellWebhookProjection -Url null ` + -InboxId null ` + -EventName null ` + -PhoneNumberId null ` + -CreatedAt null ` + -UpdatedAt null ` + -Name null ` + -Id null +``` + +- Convert the resource to JSON +```powershell +$WebhookProjection | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookRedriveAllResult.md b/docs/WebhookRedriveAllResult.md new file mode 100644 index 00000000..8e2f526b --- /dev/null +++ b/docs/WebhookRedriveAllResult.md @@ -0,0 +1,23 @@ +# WebhookRedriveAllResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | **Boolean** | | +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookRedriveAllResult = Initialize-maislurp-client-powershellWebhookRedriveAllResult -Success null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$WebhookRedriveAllResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookRedriveResult.md b/docs/WebhookRedriveResult.md new file mode 100644 index 00000000..8fa777db --- /dev/null +++ b/docs/WebhookRedriveResult.md @@ -0,0 +1,25 @@ +# WebhookRedriveResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WebhookResultId** | **String** | | +**Success** | **Boolean** | | +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookRedriveResult = Initialize-maislurp-client-powershellWebhookRedriveResult -WebhookResultId null ` + -Success null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$WebhookRedriveResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookResultDto.md b/docs/WebhookResultDto.md new file mode 100644 index 00000000..c8f0af3e --- /dev/null +++ b/docs/WebhookResultDto.md @@ -0,0 +1,59 @@ +# WebhookResultDto +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [optional] +**UserId** | **String** | | +**WebhookId** | **String** | | +**WebhookUrl** | **String** | | +**MessageId** | **String** | | +**RedriveId** | **String** | | [optional] +**HttpMethod** | **String** | | +**WebhookEvent** | **String** | | +**ResponseStatus** | **Int32** | | [optional] +**ResponseTimeMillis** | **Int64** | | +**ResponseBodyExtract** | **String** | | [optional] +**ResultType** | **String** | | [optional] +**CreatedAt** | **System.DateTime** | | +**UpdatedAt** | **System.DateTime** | | +**Seen** | **Boolean** | | +**InboxId** | **String** | | [optional] +**EmailId** | **String** | | [optional] +**AttachmentId** | **String** | | [optional] +**PhoneId** | **String** | | [optional] +**SmsId** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookResultDto = Initialize-maislurp-client-powershellWebhookResultDto -Id null ` + -UserId null ` + -WebhookId null ` + -WebhookUrl null ` + -MessageId null ` + -RedriveId null ` + -HttpMethod null ` + -WebhookEvent null ` + -ResponseStatus null ` + -ResponseTimeMillis null ` + -ResponseBodyExtract null ` + -ResultType null ` + -CreatedAt null ` + -UpdatedAt null ` + -Seen null ` + -InboxId null ` + -EmailId null ` + -AttachmentId null ` + -PhoneId null ` + -SmsId null +``` + +- Convert the resource to JSON +```powershell +$WebhookResultDto | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookTestRequest.md b/docs/WebhookTestRequest.md new file mode 100644 index 00000000..d6d09f39 --- /dev/null +++ b/docs/WebhookTestRequest.md @@ -0,0 +1,27 @@ +# WebhookTestRequest +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | | +**Method** | **String** | | +**Headers** | **System.Collections.Hashtable** | | +**Payload** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookTestRequest = Initialize-maislurp-client-powershellWebhookTestRequest -Url null ` + -Method null ` + -Headers null ` + -Payload null +``` + +- Convert the resource to JSON +```powershell +$WebhookTestRequest | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookTestResponse.md b/docs/WebhookTestResponse.md new file mode 100644 index 00000000..a07ecdda --- /dev/null +++ b/docs/WebhookTestResponse.md @@ -0,0 +1,23 @@ +# WebhookTestResponse +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StatusCode** | **Int32** | | [optional] +**Message** | **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WebhookTestResponse = Initialize-maislurp-client-powershellWebhookTestResponse -StatusCode null ` + -Message null +``` + +- Convert the resource to JSON +```powershell +$WebhookTestResponse | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/docs/WebhookTestResult.md b/docs/WebhookTestResult.md new file mode 100644 index 00000000..69aac682 --- /dev/null +++ b/docs/WebhookTestResult.md @@ -0,0 +1,25 @@ +# WebhookTestResult +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | | [optional] +**Response** | [**WebhookTestResponse**](WebhookTestResponse) | | +**Request** | [**WebhookTestRequest**](WebhookTestRequest) | | + +## Examples + +- Prepare the resource +```powershell +$WebhookTestResult = Initialize-maislurp-client-powershellWebhookTestResult -Message null ` + -Response null ` + -Request null +``` + +- Convert the resource to JSON +```powershell +$WebhookTestResult | ConvertTo-JSON +``` + +[[Back to Model list]](../README#documentation-for-models) [[Back to API list]](../README#documentation-for-api-endpoints) [[Back to README]](../README) + diff --git a/src/maislurp-client-powershell/Api/AliasControllerApi.ps1 b/src/maislurp-client-powershell/Api/AliasControllerApi.ps1 new file mode 100644 index 00000000..bf31e87e --- /dev/null +++ b/src/maislurp-client-powershell/Api/AliasControllerApi.ps1 @@ -0,0 +1,1117 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. + +.DESCRIPTION + +No description available. + +.PARAMETER CreateAliasOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AliasDto +#> +function New-Alias { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateAliasOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Alias' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/aliases' + + if (!$CreateAliasOptions) { + throw "Error! The required parameter `CreateAliasOptions` missing when calling createAlias." + } + + $LocalVarBodyParameter = $CreateAliasOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AliasDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an email alias + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAlias { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAlias' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/aliases/{aliasId}' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling deleteAlias." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an email alias + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AliasDto +#> +function Get-Alias { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Alias' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/aliases/{aliasId}' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling getAlias." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AliasDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get emails for an alias + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +No description available. + +.PARAMETER Page +Optional page index alias email list pagination + +.PARAMETER Size +Optional page size alias email list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Optional filter by sent after given date time + +.PARAMETER Before +Optional filter by sent before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailProjection +#> +function Get-AliasEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AliasEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/aliases/{aliasId}/emails' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling getAliasEmails." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get threads created for an alias + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +No description available. + +.PARAMETER Page +Optional page index in thread list pagination + +.PARAMETER Size +Optional page size in thread list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Optional filter by sent after given date time + +.PARAMETER Before +Optional filter by sent before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageThreadProjection +#> +function Get-AliasThreads { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AliasThreads' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/aliases/{aliasId}/threads' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling getAliasThreads." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageThreadProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all email aliases you have created + +.DESCRIPTION + +No description available. + +.PARAMETER Search +Optional search term + +.PARAMETER Page +Optional page index in alias list pagination + +.PARAMETER Size +Optional page size in alias list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageAlias +#> +function Get-Aliases { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Search}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Aliases' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/aliases' + + if ($Search) { + $LocalVarQueryParameters['search'] = $Search + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageAlias" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a thread + +.DESCRIPTION + +No description available. + +.PARAMETER ThreadId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ThreadProjection +#> +function Get-Thread { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ThreadId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Thread' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/aliases/threads/{threadId}' + if (!$ThreadId) { + throw "Error! The required parameter `ThreadId` missing when calling getThread." + } + $LocalVarUri = $LocalVarUri.replace('{threadId}', $ThreadId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ThreadProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all threads + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in thread list pagination + +.PARAMETER Size +Optional page size in thread list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Optional filter by sent after given date time + +.PARAMETER Before +Optional filter by sent before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageThreadProjection +#> +function Get-ThreadsPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ThreadsPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/aliases/threads' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageThreadProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Reply to an email + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +ID of the alias that email belongs to + +.PARAMETER EmailId +ID of the email that should be replied to + +.PARAMETER ReplyToAliasEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Invoke-ReplyToAliasEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ReplyToAliasEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ReplyToAliasEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/aliases/{aliasId}/emails/{emailId}' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling replyToAliasEmail." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling replyToAliasEmail." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$ReplyToAliasEmailOptions) { + throw "Error! The required parameter `ReplyToAliasEmailOptions` missing when calling replyToAliasEmail." + } + + $LocalVarBodyParameter = $ReplyToAliasEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send an email from an alias inbox + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +No description available. + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Send-AliasEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-AliasEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/aliases/{aliasId}/emails' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling sendAliasEmail." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling sendAliasEmail." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update an email alias + +.DESCRIPTION + +No description available. + +.PARAMETER AliasId +No description available. + +.PARAMETER UpdateAliasOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AliasDto +#> +function Update-Alias { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AliasId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateAliasOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-Alias' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/aliases/{aliasId}' + if (!$AliasId) { + throw "Error! The required parameter `AliasId` missing when calling updateAlias." + } + $LocalVarUri = $LocalVarUri.replace('{aliasId}', $AliasId) + + if (!$UpdateAliasOptions) { + throw "Error! The required parameter `UpdateAliasOptions` missing when calling updateAlias." + } + + $LocalVarBodyParameter = $UpdateAliasOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AliasDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/AttachmentControllerApi.ps1 b/src/maislurp-client-powershell/Api/AttachmentControllerApi.ps1 new file mode 100644 index 00000000..82176099 --- /dev/null +++ b/src/maislurp-client-powershell/Api/AttachmentControllerApi.ps1 @@ -0,0 +1,919 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Delete all attachments + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllAttachments { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllAttachments' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/attachments' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an attachment + +.DESCRIPTION + +No description available. + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAttachment { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAttachment' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/attachments/{attachmentId}' + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling deleteAttachment." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. + +.DESCRIPTION + +No description available. + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DownloadAttachmentDto +#> +function Invoke-DownloadAttachmentAsBase64Encoded { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DownloadAttachmentAsBase64Encoded' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/attachments/{attachmentId}/base64' + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling downloadAttachmentAsBase64Encoded." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DownloadAttachmentDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. + +.DESCRIPTION + +No description available. + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SystemByte +#> +function Invoke-DownloadAttachmentAsBytes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DownloadAttachmentAsBytes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('application/octet-stream') + + $LocalVarUri = '/attachments/{attachmentId}/bytes' + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling downloadAttachmentAsBytes." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SystemByte" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an attachment entity + +.DESCRIPTION + +No description available. + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AttachmentEntity +#> +function Get-Attachment { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Attachment' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/attachments/{attachmentId}' + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling getAttachment." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AttachmentEntity" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email attachment metadata information + +.DESCRIPTION + +No description available. + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AttachmentMetaData +#> +function Get-AttachmentInfo { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AttachmentInfo' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/attachments/{attachmentId}/metadata' + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling getAttachmentInfo." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AttachmentMetaData" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email attachments + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index for list pagination + +.PARAMETER Size +Optional page size for list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER FileNameFilter +Optional file name and content type search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER InboxId +Optional inboxId to filter attachments by + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageAttachmentEntity +#> +function Get-Attachments { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${FileNameFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Attachments' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/attachments' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($FileNameFilter) { + $LocalVarQueryParameters['fileNameFilter'] = $FileNameFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageAttachmentEntity" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. + +.DESCRIPTION + +No description available. + +.PARAMETER UploadAttachmentOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String[] +#> +function Invoke-UploadAttachment { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UploadAttachmentOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-UploadAttachment' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/attachments' + + if (!$UploadAttachmentOptions) { + throw "Error! The required parameter `UploadAttachmentOptions` missing when calling uploadAttachment." + } + + $LocalVarBodyParameter = $UploadAttachmentOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. + +.DESCRIPTION + +No description available. + +.PARAMETER ContentType +No description available. + +.PARAMETER ContentType2 +Optional contentType for file. For instance `application/pdf` + +.PARAMETER ContentId +Optional content ID (CID) to save upload with + +.PARAMETER Filename +Optional filename to save upload with + +.PARAMETER Filename2 +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String[] +#> +function Invoke-UploadAttachmentBytes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ContentType}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ContentType2}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ContentId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Filename}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Filename2}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-UploadAttachmentBytes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('application/json') + + $LocalVarUri = '/attachments/bytes' + + if ($ContentType) { + $LocalVarHeaderParameters['contentType'] = $ContentType + } + + if ($Filename2) { + $LocalVarHeaderParameters['filename'] = $Filename2 + } + + if ($ContentType2) { + $LocalVarQueryParameters['contentType'] = $ContentType2 + } + + if ($ContentId) { + $LocalVarQueryParameters['contentId'] = $ContentId + } + + if ($Filename) { + $LocalVarQueryParameters['filename'] = $Filename + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. + +.DESCRIPTION + +No description available. + +.PARAMETER ContentId +Optional content ID of attachment + +.PARAMETER ContentType +Optional content type of attachment + +.PARAMETER Filename +Optional name of file + +.PARAMETER XFilename +Optional content type header of attachment + +.PARAMETER InlineObject +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String[] +#> +function Invoke-UploadMultipartForm { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ContentId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ContentType}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Filename}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${XFilename}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InlineObject}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-UploadMultipartForm' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/attachments/multipart' + + if ($ContentId) { + $LocalVarQueryParameters['contentId'] = $ContentId + } + + if ($ContentType) { + $LocalVarQueryParameters['contentType'] = $ContentType + } + + if ($Filename) { + $LocalVarQueryParameters['filename'] = $Filename + } + + if ($XFilename) { + $LocalVarQueryParameters['x-filename'] = $XFilename + } + + $LocalVarBodyParameter = $InlineObject | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/BounceControllerApi.ps1 b/src/maislurp-client-powershell/Api/BounceControllerApi.ps1 new file mode 100644 index 00000000..33b21cba --- /dev/null +++ b/src/maislurp-client-powershell/Api/BounceControllerApi.ps1 @@ -0,0 +1,859 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Filter a list of email recipients and remove those who have bounced + +.DESCRIPTION + +No description available. + +.PARAMETER FilterBouncedRecipientsOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +FilterBouncedRecipientsResult +#> +function Invoke-FilterBouncedRecipient { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${FilterBouncedRecipientsOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-FilterBouncedRecipient' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/bounce/filter-recipients' + + if (!$FilterBouncedRecipientsOptions) { + throw "Error! The required parameter `FilterBouncedRecipientsOptions` missing when calling filterBouncedRecipient." + } + + $LocalVarBodyParameter = $FilterBouncedRecipientsOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "FilterBouncedRecipientsResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Can account send email + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AccountBounceBlockDto +#> +function Get-AccountBounceBlockStatus { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AccountBounceBlockStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/account-block' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AccountBounceBlockDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a bounced email. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of the bounced email to fetch + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +BouncedEmailDto +#> +function Get-BouncedEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-BouncedEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/emails/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getBouncedEmail." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "BouncedEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get paginated list of bounced emails. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index + +.PARAMETER Size +Optional page size + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageBouncedEmail +#> +function Get-BouncedEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-BouncedEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/emails' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageBouncedEmail" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a bounced email. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of the bounced recipient + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +BouncedRecipientDto +#> +function Get-BouncedRecipient { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-BouncedRecipient' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/recipients/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getBouncedRecipient." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "BouncedRecipientDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get paginated list of bounced recipients. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index + +.PARAMETER Size +Optional page size + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageBouncedRecipients +#> +function Get-BouncedRecipients { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-BouncedRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/recipients' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageBouncedRecipients" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get complaint + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of the complaint + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Complaint +#> +function Get-Complaint { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Complaint' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/complaints/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getComplaint." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Complaint" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get paginated list of complaints. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index + +.PARAMETER Size +Optional page size + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageComplaint +#> +function Get-Complaints { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Complaints' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/complaints' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageComplaint" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get paginated list of unsubscribed recipients. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index + +.PARAMETER Size +Optional page size + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER DomainId +Filter by domainId + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageListUnsubscribeRecipients +#> +function Get-ListUnsubscribeRecipients { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DomainId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ListUnsubscribeRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bounce/list-unsubscribe-recipients' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($DomainId) { + $LocalVarQueryParameters['domainId'] = $DomainId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageListUnsubscribeRecipients" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/BulkActionsControllerApi.ps1 b/src/maislurp-client-powershell/Api/BulkActionsControllerApi.ps1 new file mode 100644 index 00000000..6895816f --- /dev/null +++ b/src/maislurp-client-powershell/Api/BulkActionsControllerApi.ps1 @@ -0,0 +1,247 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Bulk create Inboxes (email addresses) + +.DESCRIPTION + +No description available. + +.PARAMETER Count +Number of inboxes to be created in bulk + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto[] +#> +function Invoke-BulkCreateInboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int32] + ${Count}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-BulkCreateInboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/bulk/inboxes' + + if (!$Count) { + throw "Error! The required parameter `Count` missing when calling bulkCreateInboxes." + } + $LocalVarQueryParameters['count'] = $Count + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Bulk Delete Inboxes + +.DESCRIPTION + +No description available. + +.PARAMETER RequestBody +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-BulkDeleteInboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${RequestBody}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-BulkDeleteInboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/bulk/inboxes' + + if (!$RequestBody) { + throw "Error! The required parameter `RequestBody` missing when calling bulkDeleteInboxes." + } + + $LocalVarBodyParameter = $RequestBody | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Bulk Send Emails + +.DESCRIPTION + +No description available. + +.PARAMETER BulkSendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-BulkSendEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${BulkSendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-BulkSendEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/bulk/send' + + if (!$BulkSendEmailOptions) { + throw "Error! The required parameter `BulkSendEmailOptions` missing when calling bulkSendEmails." + } + + $LocalVarBodyParameter = $BulkSendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/CommonActionsControllerApi.ps1 b/src/maislurp-client-powershell/Api/CommonActionsControllerApi.ps1 new file mode 100644 index 00000000..c1467334 --- /dev/null +++ b/src/maislurp-client-powershell/Api/CommonActionsControllerApi.ps1 @@ -0,0 +1,784 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create new random inbox + +.DESCRIPTION + +No description available. + +.PARAMETER AllowTeamAccess +No description available. + +.PARAMETER UseDomainPool +No description available. + +.PARAMETER ExpiresAt +No description available. + +.PARAMETER ExpiresIn +No description available. + +.PARAMETER EmailAddress +No description available. + +.PARAMETER InboxType +No description available. + +.PARAMETER Description +No description available. + +.PARAMETER Name +No description available. + +.PARAMETER Tags +No description available. + +.PARAMETER Favourite +No description available. + +.PARAMETER VirtualInbox +No description available. + +.PARAMETER UseShortAddress +No description available. + +.PARAMETER DomainName +No description available. + +.PARAMETER DomainId +No description available. + +.PARAMETER Prefix +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function New-NewEmailAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${AllowTeamAccess}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseDomainPool}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${ExpiresAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${ExpiresIn}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Description}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Name}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${Tags}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${VirtualInbox}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseShortAddress}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${DomainName}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DomainId}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Prefix}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-NewEmailAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/newEmailAddress' + + if ($AllowTeamAccess) { + $LocalVarQueryParameters['allowTeamAccess'] = $AllowTeamAccess + } + + if ($UseDomainPool) { + $LocalVarQueryParameters['useDomainPool'] = $UseDomainPool + } + + if ($ExpiresAt) { + $LocalVarQueryParameters['expiresAt'] = $ExpiresAt + } + + if ($ExpiresIn) { + $LocalVarQueryParameters['expiresIn'] = $ExpiresIn + } + + if ($EmailAddress) { + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + } + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($Description) { + $LocalVarQueryParameters['description'] = $Description + } + + if ($Name) { + $LocalVarQueryParameters['name'] = $Name + } + + if ($Tags) { + $LocalVarQueryParameters['tags'] = $Tags + } + + if ($Favourite) { + $LocalVarQueryParameters['favourite'] = $Favourite + } + + if ($VirtualInbox) { + $LocalVarQueryParameters['virtualInbox'] = $VirtualInbox + } + + if ($UseShortAddress) { + $LocalVarQueryParameters['useShortAddress'] = $UseShortAddress + } + + if ($DomainName) { + $LocalVarQueryParameters['domainName'] = $DomainName + } + + if ($DomainId) { + $LocalVarQueryParameters['domainId'] = $DomainId + } + + if ($Prefix) { + $LocalVarQueryParameters['prefix'] = $Prefix + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create new random inbox + +.DESCRIPTION + +No description available. + +.PARAMETER AllowTeamAccess +No description available. + +.PARAMETER UseDomainPool +No description available. + +.PARAMETER ExpiresAt +No description available. + +.PARAMETER ExpiresIn +No description available. + +.PARAMETER EmailAddress +No description available. + +.PARAMETER InboxType +No description available. + +.PARAMETER Description +No description available. + +.PARAMETER Name +No description available. + +.PARAMETER Tags +No description available. + +.PARAMETER Favourite +No description available. + +.PARAMETER VirtualInbox +No description available. + +.PARAMETER UseShortAddress +No description available. + +.PARAMETER DomainName +No description available. + +.PARAMETER DomainId +No description available. + +.PARAMETER Prefix +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function New-RandomInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${AllowTeamAccess}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseDomainPool}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${ExpiresAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${ExpiresIn}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Description}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Name}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${Tags}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${VirtualInbox}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseShortAddress}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${DomainName}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DomainId}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Prefix}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-RandomInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/createInbox' + + if ($AllowTeamAccess) { + $LocalVarQueryParameters['allowTeamAccess'] = $AllowTeamAccess + } + + if ($UseDomainPool) { + $LocalVarQueryParameters['useDomainPool'] = $UseDomainPool + } + + if ($ExpiresAt) { + $LocalVarQueryParameters['expiresAt'] = $ExpiresAt + } + + if ($ExpiresIn) { + $LocalVarQueryParameters['expiresIn'] = $ExpiresIn + } + + if ($EmailAddress) { + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + } + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($Description) { + $LocalVarQueryParameters['description'] = $Description + } + + if ($Name) { + $LocalVarQueryParameters['name'] = $Name + } + + if ($Tags) { + $LocalVarQueryParameters['tags'] = $Tags + } + + if ($Favourite) { + $LocalVarQueryParameters['favourite'] = $Favourite + } + + if ($VirtualInbox) { + $LocalVarQueryParameters['virtualInbox'] = $VirtualInbox + } + + if ($UseShortAddress) { + $LocalVarQueryParameters['useShortAddress'] = $UseShortAddress + } + + if ($DomainName) { + $LocalVarQueryParameters['domainName'] = $DomainName + } + + if ($DomainId) { + $LocalVarQueryParameters['domainId'] = $DomainId + } + + if ($Prefix) { + $LocalVarQueryParameters['prefix'] = $Prefix + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inbox email address by inbox id + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteEmailAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteEmailAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/deleteEmailAddress' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling deleteEmailAddress." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all emails in an inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-EmptyInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-EmptyInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/emptyInbox' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling emptyInbox." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send an email using query parameters + +.DESCRIPTION + +No description available. + +.PARAMETER To +Email address to send to + +.PARAMETER SenderId +ID of inbox to send from. If null an inbox will be created for sending + +.PARAMETER Body +Body of the email message. Supports HTML + +.PARAMETER Subject +Subject line of the email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Send-EmailQuery { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${To}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SenderId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Body}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Subject}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-EmailQuery' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/sendEmailQuery' + + if ($SenderId) { + $LocalVarQueryParameters['senderId'] = $SenderId + } + + if (!$To) { + throw "Error! The required parameter `To` missing when calling sendEmailQuery." + } + $LocalVarQueryParameters['to'] = $To + + if ($Body) { + $LocalVarQueryParameters['body'] = $Body + } + + if ($Subject) { + $LocalVarQueryParameters['subject'] = $Subject + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send an email + +.DESCRIPTION + +No description available. + +.PARAMETER SimpleSendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Send-EmailSimple { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SimpleSendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-EmailSimple' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/sendEmail' + + if (!$SimpleSendEmailOptions) { + throw "Error! The required parameter `SimpleSendEmailOptions` missing when calling sendEmailSimple." + } + + $LocalVarBodyParameter = $SimpleSendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/ConnectorControllerApi.ps1 b/src/maislurp-client-powershell/Api/ConnectorControllerApi.ps1 new file mode 100644 index 00000000..e00b222e --- /dev/null +++ b/src/maislurp-client-powershell/Api/ConnectorControllerApi.ps1 @@ -0,0 +1,1261 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create an inbox connector + +.DESCRIPTION + +No description available. + +.PARAMETER CreateConnectorOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorDto +#> +function New-Connector { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateConnectorOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Connector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/connectors' + + if (!$CreateConnectorOptions) { + throw "Error! The required parameter `CreateConnectorOptions` missing when calling createConnector." + } + + $LocalVarBodyParameter = $CreateConnectorOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create an inbox connector IMAP connection + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER CreateConnectorImapConnectionOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorImapConnectionDto +#> +function New-ConnectorImapConnection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateConnectorImapConnectionOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-ConnectorImapConnection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/connectors/{id}/imap' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling createConnectorImapConnection." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$CreateConnectorImapConnectionOptions) { + throw "Error! The required parameter `CreateConnectorImapConnectionOptions` missing when calling createConnectorImapConnection." + } + + $LocalVarBodyParameter = $CreateConnectorImapConnectionOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorImapConnectionDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create an inbox connector SMTP connection + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER CreateConnectorSmtpConnectionOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorSmtpConnectionDto +#> +function New-ConnectorSmtpConnection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateConnectorSmtpConnectionOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-ConnectorSmtpConnection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/connectors/{id}/smtp' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling createConnectorSmtpConnection." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$CreateConnectorSmtpConnectionOptions) { + throw "Error! The required parameter `CreateConnectorSmtpConnectionOptions` missing when calling createConnectorSmtpConnection." + } + + $LocalVarBodyParameter = $CreateConnectorSmtpConnectionOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorSmtpConnectionDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all inbox connectors + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllConnector { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllConnector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/connectors' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an inbox connector + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteConnector { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteConnector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/connectors/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteConnector." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an inbox connector IMAP connection + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteConnectorImapConnection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteConnectorImapConnection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/connectors/{id}/imap' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteConnectorImapConnection." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an inbox connector SMTP connection + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteConnectorSmtpConnection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteConnectorSmtpConnection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/connectors/{id}/smtp' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteConnectorSmtpConnection." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all inbox connector sync events + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in connector list pagination + +.PARAMETER Size +Optional page size in connector list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageConnectorSyncEvents +#> +function Get-AllConnectorSyncEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllConnectorSyncEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/connectors/events' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageConnectorSyncEvents" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox connector + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorDto +#> +function Get-Connector { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Connector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/connectors/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getConnector." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox connector sync event + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorSyncEventDto +#> +function Get-ConnectorSyncEvent { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ConnectorSyncEvent' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/connectors/events/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getConnectorSyncEvent." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorSyncEventDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox connector sync events + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER Page +Optional page index in connector list pagination + +.PARAMETER Size +Optional page size in connector list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageConnectorSyncEvents +#> +function Get-ConnectorSyncEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ConnectorSyncEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/connectors/{id}/events' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getConnectorSyncEvents." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageConnectorSyncEvents" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get inbox connectors + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in connector list pagination + +.PARAMETER Size +Optional page size in connector list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageConnector +#> +function Get-Connectors { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Connectors' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/connectors' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageConnector" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Sync an inbox connector + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorSyncRequestResult +#> +function Sync-Connector { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Sync-Connector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/connectors/{id}/sync' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling syncConnector." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorSyncRequestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update an inbox connector + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER CreateConnectorOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ConnectorDto +#> +function Update-Connector { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateConnectorOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-Connector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/connectors/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling updateConnector." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$CreateConnectorOptions) { + throw "Error! The required parameter `CreateConnectorOptions` missing when calling updateConnector." + } + + $LocalVarBodyParameter = $CreateConnectorOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ConnectorDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/ContactControllerApi.ps1 b/src/maislurp-client-powershell/Api/ContactControllerApi.ps1 new file mode 100644 index 00000000..764cd411 --- /dev/null +++ b/src/maislurp-client-powershell/Api/ContactControllerApi.ps1 @@ -0,0 +1,516 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create a contact + +.DESCRIPTION + +No description available. + +.PARAMETER CreateContactOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ContactDto +#> +function New-Contact { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateContactOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Contact' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/contacts' + + if (!$CreateContactOptions) { + throw "Error! The required parameter `CreateContactOptions` missing when calling createContact." + } + + $LocalVarBodyParameter = $CreateContactOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ContactDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete contact + +.DESCRIPTION + +No description available. + +.PARAMETER ContactId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteContact { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ContactId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteContact' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/contacts/{contactId}' + if (!$ContactId) { + throw "Error! The required parameter `ContactId` missing when calling deleteContact." + } + $LocalVarUri = $LocalVarUri.replace('{contactId}', $ContactId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all contacts + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER Search +Search terms + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageContactProjection +#> +function Get-AllContacts { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Search}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllContacts' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/contacts/paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Search) { + $LocalVarQueryParameters['search'] = $Search + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageContactProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get contact + +.DESCRIPTION + +No description available. + +.PARAMETER ContactId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ContactDto +#> +function Get-Contact { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ContactId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Contact' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/contacts/{contactId}' + if (!$ContactId) { + throw "Error! The required parameter `ContactId` missing when calling getContact." + } + $LocalVarUri = $LocalVarUri.replace('{contactId}', $ContactId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ContactDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get contact vCard vcf file + +.DESCRIPTION + +No description available. + +.PARAMETER ContactId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Get-ContactVCard { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ContactId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ContactVCard' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/contacts/{contactId}/download' + if (!$ContactId) { + throw "Error! The required parameter `ContactId` missing when calling getContactVCard." + } + $LocalVarUri = $LocalVarUri.replace('{contactId}', $ContactId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all contacts + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ContactProjection[] +#> +function Get-Contacts { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Contacts' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/contacts' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ContactProjection[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/DomainControllerApi.ps1 b/src/maislurp-client-powershell/Api/DomainControllerApi.ps1 new file mode 100644 index 00000000..6ed02ee7 --- /dev/null +++ b/src/maislurp-client-powershell/Api/DomainControllerApi.ps1 @@ -0,0 +1,800 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Add catch all wild card inbox to domain + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainDto +#> +function Add-DomainWildcardCatchAll { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Add-DomainWildcardCatchAll' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/{id}/wildcard' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling addDomainWildcardCatchAll." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create Domain + +.DESCRIPTION + +No description available. + +.PARAMETER CreateDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainDto +#> +function New-Domain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Domain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/domains' + + if (!$CreateDomainOptions) { + throw "Error! The required parameter `CreateDomainOptions` missing when calling createDomain." + } + + $LocalVarBodyParameter = $CreateDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete a domain + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String[] +#> +function Invoke-DeleteDomain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteDomain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteDomain." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all usable domains + +.DESCRIPTION + +No description available. + +.PARAMETER InboxType +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainGroupsDto +#> +function Get-AvailableDomains { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AvailableDomains' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/available-domains' + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainGroupsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a domain + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER CheckForErrors +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainDto +#> +function Get-Domain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${CheckForErrors}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Domain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getDomain." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($CheckForErrors) { + $LocalVarQueryParameters['checkForErrors'] = $CheckForErrors + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get domain issues + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainIssuesDto +#> +function Get-DomainIssues { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-DomainIssues' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/issues' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainIssuesDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get catch all wild card inbox for domain + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function Get-DomainWildcardCatchAllInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-DomainWildcardCatchAllInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/{id}/wildcard' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getDomainWildcardCatchAllInbox." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get domains + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainPreview[] +#> +function Get-Domains { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Domains' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get MailSlurp domains + +.DESCRIPTION + +No description available. + +.PARAMETER InboxType +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainGroupsDto +#> +function Get-MailSlurpDomains { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-MailSlurpDomains' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/domains/mailslurp-domains' + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainGroupsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update a domain + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER UpdateDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DomainDto +#> +function Update-Domain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-Domain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/domains/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling updateDomain." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$UpdateDomainOptions) { + throw "Error! The required parameter `UpdateDomainOptions` missing when calling updateDomain." + } + + $LocalVarBodyParameter = $UpdateDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DomainDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/EmailControllerApi.ps1 b/src/maislurp-client-powershell/Api/EmailControllerApi.ps1 new file mode 100644 index 00000000..5b57b06e --- /dev/null +++ b/src/maislurp-client-powershell/Api/EmailControllerApi.ps1 @@ -0,0 +1,3730 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Set IMAP flags associated with a message. Only supports '\Seen' flag. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER ImapFlagOperationOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreview +#> +function Invoke-ApplyImapFlagOperation { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ImapFlagOperationOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ApplyImapFlagOperation' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/{emailId}/imap-flag-operation' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling applyImapFlagOperation." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$ImapFlagOperationOptions) { + throw "Error! The required parameter `ImapFlagOperationOptions` missing when calling applyImapFlagOperation." + } + + $LocalVarBodyParameter = $ImapFlagOperationOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreview" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Check if email can be sent and options are valid. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CanSendEmailResults +#> +function Invoke-CanSend { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-CanSend' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/can-send' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling canSend." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling canSend." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CanSendEmailResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Detect broken links, spelling, and images in email content + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CheckEmailBodyResults +#> +function Invoke-CheckEmailBody { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-CheckEmailBody' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/check-email-body' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling checkEmailBody." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CheckEmailBodyResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Show which mail clients support the HTML and CSS features used in an email body. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CheckEmailBodyFeatureSupportResults +#> +function Invoke-CheckEmailBodyFeatureSupport { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-CheckEmailBodyFeatureSupport' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/check-email-body-feature-support' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling checkEmailBodyFeatureSupport." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CheckEmailBodyFeatureSupportResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Show which email programs and devices support the features used in an email body. + +.DESCRIPTION + +No description available. + +.PARAMETER CheckEmailClientSupportOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CheckEmailClientSupportResults +#> +function Invoke-CheckEmailClientSupport { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CheckEmailClientSupportOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-CheckEmailClientSupport' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/check-email-client-support' + + if (!$CheckEmailClientSupportOptions) { + throw "Error! The required parameter `CheckEmailClientSupportOptions` missing when calling checkEmailClientSupport." + } + + $LocalVarBodyParameter = $CheckEmailClientSupportOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CheckEmailClientSupportResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all emails in all inboxes. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllEmails { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/emails' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an email + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email to delete + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/emails/{emailId}' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling deleteEmail." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER ApiKey +Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SystemByte +#> +function Invoke-DownloadAttachment { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ApiKey}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DownloadAttachment' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('application/octet-stream') + + $LocalVarUri = '/emails/{emailId}/attachments/{attachmentId}' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling downloadAttachment." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling downloadAttachment." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($ApiKey) { + $LocalVarQueryParameters['apiKey'] = $ApiKey + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SystemByte" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DownloadAttachmentDto +#> +function Invoke-DownloadAttachmentBase64 { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DownloadAttachmentBase64' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/attachments/{attachmentId}/base64' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling downloadAttachmentBase64." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling downloadAttachmentBase64." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DownloadAttachmentDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email body as string. Returned as `plain/text` with content type header. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER ReturnType + +Select the return type (optional): text/plain, text/html + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Invoke-DownloadBody { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [String] + [ValidateSet("text/plain", "text/html")] + $ReturnType, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DownloadBody' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('text/plain', 'text/html') + + if ($ReturnType) { + # use the return type (MIME) provided by the user + $LocalVarAccepts = @($ReturnType) + } + + $LocalVarUri = '/emails/{emailId}/body' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling downloadBody." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email body in bytes. Returned as `octet-stream` with content type header. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SystemByte +#> +function Invoke-DownloadBodyBytes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DownloadBodyBytes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('application/octet-stream') + + $LocalVarUri = '/emails/{emailId}/body-bytes' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling downloadBodyBytes." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SystemByte" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Forward email to recipients + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER ForwardEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Invoke-ForwardEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ForwardEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ForwardEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/{emailId}/forward' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling forwardEmail." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$ForwardEmailOptions) { + throw "Error! The required parameter `ForwardEmailOptions` missing when calling forwardEmail." + } + + $LocalVarBodyParameter = $ForwardEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER AttachmentId +ID of attachment + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AttachmentMetaData +#> +function Get-AttachmentMetaData { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${AttachmentId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AttachmentMetaData' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/attachments/{attachmentId}/metadata' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getAttachmentMetaData." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + if (!$AttachmentId) { + throw "Error! The required parameter `AttachmentId` missing when calling getAttachmentMetaData." + } + $LocalVarUri = $LocalVarUri.replace('{attachmentId}', $AttachmentId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AttachmentMetaData" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER Decode +Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Get-Email { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Decode}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Email' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmail." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Decode) { + $LocalVarQueryParameters['decode'] = $Decode + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all email attachment metadata. Metadata includes name and size of attachments. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AttachmentMetaData[] +#> +function Get-EmailAttachments { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailAttachments' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/attachments' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailAttachments." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AttachmentMetaData[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email content regex pattern match results. Runs regex against email body and returns match groups. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email to match against + +.PARAMETER ContentMatchOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailContentMatchResult +#> +function Get-EmailContentMatch { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ContentMatchOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailContentMatch' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/{emailId}/contentMatch' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailContentMatch." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$ContentMatchOptions) { + throw "Error! The required parameter `ContentMatchOptions` missing when calling getEmailContentMatch." + } + + $LocalVarBodyParameter = $ContentMatchOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailContentMatchResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email content part by content type + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email to match against + +.PARAMETER ContentType +Content type + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailContentPartResult +#> +function Get-EmailContentPart { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ContentType}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailContentPart' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/contentPart' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailContentPart." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$ContentType) { + throw "Error! The required parameter `ContentType` missing when calling getEmailContentPart." + } + $LocalVarQueryParameters['contentType'] = $ContentType + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailContentPartResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email count + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CountDto +#> +function Get-EmailCount { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/emails/count' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CountDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email content as HTML. For displaying emails in browser context. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER Decode +No description available. + +.PARAMETER ReplaceCidImages +No description available. + +.PARAMETER ReturnType + +Select the return type (optional): text/html;charset=utf-8, text/html + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Get-EmailHTML { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Decode}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${ReplaceCidImages}, + [String] + [ValidateSet("text/html;charset=utf-8", "text/html")] + $ReturnType, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailHTML' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('text/html;charset=utf-8', 'text/html') + + if ($ReturnType) { + # use the return type (MIME) provided by the user + $LocalVarAccepts = @($ReturnType) + } + + $LocalVarUri = '/emails/{emailId}/html' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailHTML." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Decode) { + $LocalVarQueryParameters['decode'] = $Decode + } + + if ($ReplaceCidImages) { + $LocalVarQueryParameters['replaceCidImages'] = $ReplaceCidImages + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER Decode +No description available. + +.PARAMETER ReplaceCidImages +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailHtmlDto +#> +function Get-EmailHTMLJson { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Decode}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${ReplaceCidImages}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailHTMLJson' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/html/json' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailHTMLJson." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Decode) { + $LocalVarQueryParameters['decode'] = $Decode + } + + if ($ReplaceCidImages) { + $LocalVarQueryParameters['replaceCidImages'] = $ReplaceCidImages + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailHtmlDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Parse and return text from an email, stripping HTML and decoding encoded characters + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email to perform HTML query on + +.PARAMETER HtmlSelector +HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailTextLinesResult +#> +function Get-EmailHTMLQuery { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${HtmlSelector}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailHTMLQuery' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/htmlQuery' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailHTMLQuery." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$HtmlSelector) { + throw "Error! The required parameter `HtmlSelector` missing when calling getEmailHTMLQuery." + } + $LocalVarQueryParameters['htmlSelector'] = $HtmlSelector + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailTextLinesResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Parse and return list of links found in an email (only works for HTML content) + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email to fetch text for + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailLinksResult +#> +function Get-EmailLinks { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailLinks' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/links' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailLinks." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailLinksResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email URLs for viewing in browser or downloading + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreviewUrls +#> +function Get-EmailPreviewURLs { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailPreviewURLs' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/urls' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailPreviewURLs." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreviewUrls" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Take a screenshot of an email in a browser and return base64 encoded string + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER GetEmailScreenshotOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailScreenshotResult +#> +function Get-EmailScreenshotAsBase64 { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GetEmailScreenshotOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailScreenshotAsBase64' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/{emailId}/screenshot/base64' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailScreenshotAsBase64." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$GetEmailScreenshotOptions) { + throw "Error! The required parameter `GetEmailScreenshotOptions` missing when calling getEmailScreenshotAsBase64." + } + + $LocalVarBodyParameter = $GetEmailScreenshotOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailScreenshotResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Take a screenshot of an email in a browser + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER GetEmailScreenshotOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Get-EmailScreenshotAsBinary { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GetEmailScreenshotOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailScreenshotAsBinary' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/{emailId}/screenshot/binary' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailScreenshotAsBinary." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$GetEmailScreenshotOptions) { + throw "Error! The required parameter `GetEmailScreenshotOptions` missing when calling getEmailScreenshotAsBinary." + } + + $LocalVarBodyParameter = $GetEmailScreenshotOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Parse and return text from an email, stripping HTML and decoding encoded characters + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email to fetch text for + +.PARAMETER DecodeHtmlEntities +Decode HTML entities + +.PARAMETER LineSeparator +Line separator character + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailTextLinesResult +#> +function Get-EmailTextLines { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${DecodeHtmlEntities}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${LineSeparator}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailTextLines' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/textLines' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getEmailTextLines." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($DecodeHtmlEntities) { + $LocalVarQueryParameters['decodeHtmlEntities'] = $DecodeHtmlEntities + } + + if ($LineSeparator) { + $LocalVarQueryParameters['lineSeparator'] = $LineSeparator + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailTextLinesResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all emails in all inboxes in paginated form. Email API list all. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. + +.PARAMETER Page +Optional page index in email list pagination + +.PARAMETER Size +Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER UnreadOnly +Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly + +.PARAMETER SearchFilter +Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body + +.PARAMETER Since +Optional filter emails received after given date time + +.PARAMETER Before +Optional filter emails received before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailProjection +#> +function Get-EmailsOffsetPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailsOffsetPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/offset-paginated' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all emails in all inboxes in paginated form. Email API list all. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. + +.PARAMETER Page +Optional page index in email list pagination + +.PARAMETER Size +Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER UnreadOnly +Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly + +.PARAMETER SearchFilter +Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body + +.PARAMETER Since +Optional filter emails received after given date time. If unset will use time 24hours prior to now. + +.PARAMETER Before +Optional filter emails received before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailProjection +#> +function Get-EmailsPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmailsPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailAddress +No description available. + +.PARAMETER Size +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GravatarUrl +#> +function Get-GravatarUrlForEmailAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Size}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-GravatarUrlForEmailAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/gravatarFor' + + if (!$EmailAddress) { + throw "Error! The required parameter `EmailAddress` missing when calling getGravatarUrlForEmailAddress." + } + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GravatarUrl" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get latest email in all inboxes. Most recently received. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxIds +Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Get-LatestEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${InboxIds}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-LatestEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/latest' + + if ($InboxIds) { + $LocalVarQueryParameters['inboxIds'] = $InboxIds + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to get the latest email from + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Get-LatestEmailInInbox1 { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-LatestEmailInInbox1' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/latestIn' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getLatestEmailInInbox1." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all organization emails. List team or shared test email accounts + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. + +.PARAMETER Page +Optional page index in email list pagination + +.PARAMETER Size +Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER UnreadOnly +Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly + +.PARAMETER SearchFilter +Optional search filter search filter for emails. + +.PARAMETER Since +Optional filter emails received after given date time. If unset will use time 24hours prior to now. + +.PARAMETER Before +Optional filter emails received before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailProjection +#> +function Get-OrganizationEmailsPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-OrganizationEmailsPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/organization' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get raw email string. Returns unparsed raw SMTP message with headers and body. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Get-RawEmailContents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-RawEmailContents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/emails/{emailId}/raw' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getRawEmailContents." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +RawEmailJson +#> +function Get-RawEmailJson { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-RawEmailJson' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/raw/json' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getRawEmailJson." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "RawEmailJson" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get unread email count + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox ID filter + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +UnreadCount +#> +function Get-UnreadEmailCount { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-UnreadEmailCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/unreadCount' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "UnreadCount" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Mark all emails as read or unread + +.DESCRIPTION + +No description available. + +.PARAMETER Read +What value to assign to email read property. Default true. + +.PARAMETER InboxId +Optional inbox ID filter + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-MarkAllAsRead { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Read}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-MarkAllAsRead' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/emails/read' + + if ($Read) { + $LocalVarQueryParameters['read'] = $Read + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Mark an email as read or unread + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +No description available. + +.PARAMETER Read +What value to assign to email read property. Default true. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreview +#> +function Invoke-MarkAsRead { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Read}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-MarkAsRead' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/read' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling markAsRead." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Read) { + $LocalVarQueryParameters['read'] = $Read + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreview" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Reply to an email + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of the email that should be replied to + +.PARAMETER ReplyToEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Invoke-ReplyToEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ReplyToEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ReplyToEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/{emailId}' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling replyToEmail." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if (!$ReplyToEmailOptions) { + throw "Error! The required parameter `ReplyToEmailOptions` missing when calling replyToEmail." + } + + $LocalVarBodyParameter = $ReplyToEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all emails by search criteria. Return in paginated form. + +.DESCRIPTION + +No description available. + +.PARAMETER SearchEmailsOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailProjection +#> +function Search-Emails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SearchEmailsOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Search-Emails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails/search' + + if (!$SearchEmailsOptions) { + throw "Error! The required parameter `SearchEmailsOptions` missing when calling searchEmails." + } + + $LocalVarBodyParameter = $SearchEmailsOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send email + +.DESCRIPTION + +No description available. + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER UseDomainPool +Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. + +.PARAMETER VirtualSend +Optionally create inbox to send from that is a virtual inbox and won't send to external addresses + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Send-EmailSourceOptional { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseDomainPool}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${VirtualSend}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-EmailSourceOptional' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/emails' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($UseDomainPool) { + $LocalVarQueryParameters['useDomainPool'] = $UseDomainPool + } + + if ($VirtualSend) { + $LocalVarQueryParameters['virtualSend'] = $VirtualSend + } + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling sendEmailSourceOptional." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Validate email HTML contents + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ValidationDto +#> +function Confirm-Email { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Confirm-Email' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/emails/{emailId}/validate' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling validateEmail." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ValidationDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/EmailVerificationControllerApi.ps1 b/src/maislurp-client-powershell/Api/EmailVerificationControllerApi.ps1 new file mode 100644 index 00000000..461341c8 --- /dev/null +++ b/src/maislurp-client-powershell/Api/EmailVerificationControllerApi.ps1 @@ -0,0 +1,370 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Delete all validation requests + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllValidationRequests { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllValidationRequests' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/email-verification' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete a validation record + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteValidationRequest { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteValidationRequest' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/email-verification/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteValidationRequest." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Validate a list of email addresses. Per unit billing. See your plan for pricing. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size for paginated result list. + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER IsValid +Filter where email is valid is true or false + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailValidationRequest +#> +function Get-ValidationRequests { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${IsValid}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ValidationRequests' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/email-verification/validation-requests' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($IsValid) { + $LocalVarQueryParameters['isValid'] = $IsValid + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailValidationRequest" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Validate a list of email addresses. Per unit billing. See your plan for pricing. + +.DESCRIPTION + +No description available. + +.PARAMETER ValidateEmailAddressListOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ValidateEmailAddressListResult +#> +function Confirm-EmailAddressList { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ValidateEmailAddressListOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Confirm-EmailAddressList' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/email-verification/email-address-list' + + if (!$ValidateEmailAddressListOptions) { + throw "Error! The required parameter `ValidateEmailAddressListOptions` missing when calling validateEmailAddressList." + } + + $LocalVarBodyParameter = $ValidateEmailAddressListOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ValidateEmailAddressListResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/ExpiredControllerApi.ps1 b/src/maislurp-client-powershell/Api/ExpiredControllerApi.ps1 new file mode 100644 index 00000000..f1471e63 --- /dev/null +++ b/src/maislurp-client-powershell/Api/ExpiredControllerApi.ps1 @@ -0,0 +1,351 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Get default expiration settings + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ExpirationDefaults +#> +function Get-ExpirationDefaults { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ExpirationDefaults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/expired/defaults' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ExpirationDefaults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get expired inbox record for a previously existing inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of inbox you want to retrieve (not the inbox ID) + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ExpiredInboxDto +#> +function Get-ExpiredInboxByInboxId { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ExpiredInboxByInboxId' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/expired/inbox/{inboxId}' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getExpiredInboxByInboxId." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ExpiredInboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an expired inbox record + +.DESCRIPTION + +No description available. + +.PARAMETER ExpiredId +ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ExpiredInboxDto +#> +function Get-ExpiredInboxRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ExpiredId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ExpiredInboxRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/expired/{expiredId}' + if (!$ExpiredId) { + throw "Error! The required parameter `ExpiredId` missing when calling getExpiredInboxRecord." + } + $LocalVarUri = $LocalVarUri.replace('{expiredId}', $ExpiredId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ExpiredInboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List records of expired inboxes + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in inbox sent email list pagination + +.PARAMETER Size +Optional page size in inbox sent email list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageExpiredInboxRecordProjection +#> +function Get-ExpiredInboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ExpiredInboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/expired' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageExpiredInboxRecordProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/ExportControllerApi.ps1 b/src/maislurp-client-powershell/Api/ExportControllerApi.ps1 new file mode 100644 index 00000000..89cceae8 --- /dev/null +++ b/src/maislurp-client-powershell/Api/ExportControllerApi.ps1 @@ -0,0 +1,266 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Export inboxes link callable via browser + +.DESCRIPTION + +No description available. + +.PARAMETER ExportType +No description available. + +.PARAMETER ApiKey +No description available. + +.PARAMETER OutputFormat +No description available. + +.PARAMETER Filter +No description available. + +.PARAMETER ListSeparatorToken +No description available. + +.PARAMETER ExcludePreviouslyExported +No description available. + +.PARAMETER CreatedEarliestTime +No description available. + +.PARAMETER CreatedOldestTime +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SystemByte +#> +function Export-Entities { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("INBOXES", "CONTACTS", "ATTACHMENTS", "EMAILS")] + [String] + ${ExportType}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ApiKey}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("CSV_DEFAULT", "CSV_EXCEL")] + [String] + ${OutputFormat}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Filter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ListSeparatorToken}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${ExcludePreviouslyExported}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${CreatedEarliestTime}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${CreatedOldestTime}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Export-Entities' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/export' + + if (!$ExportType) { + throw "Error! The required parameter `ExportType` missing when calling exportEntities." + } + $LocalVarQueryParameters['exportType'] = $ExportType + + if (!$ApiKey) { + throw "Error! The required parameter `ApiKey` missing when calling exportEntities." + } + $LocalVarQueryParameters['apiKey'] = $ApiKey + + if (!$OutputFormat) { + throw "Error! The required parameter `OutputFormat` missing when calling exportEntities." + } + $LocalVarQueryParameters['outputFormat'] = $OutputFormat + + if ($Filter) { + $LocalVarQueryParameters['filter'] = $Filter + } + + if ($ListSeparatorToken) { + $LocalVarQueryParameters['listSeparatorToken'] = $ListSeparatorToken + } + + if ($ExcludePreviouslyExported) { + $LocalVarQueryParameters['excludePreviouslyExported'] = $ExcludePreviouslyExported + } + + if ($CreatedEarliestTime) { + $LocalVarQueryParameters['createdEarliestTime'] = $CreatedEarliestTime + } + + if ($CreatedOldestTime) { + $LocalVarQueryParameters['createdOldestTime'] = $CreatedOldestTime + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SystemByte" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get export link + +.DESCRIPTION + +No description available. + +.PARAMETER ExportType +No description available. + +.PARAMETER ExportOptions +No description available. + +.PARAMETER ApiKey +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ExportLink +#> +function Get-ExportLink { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("INBOXES", "CONTACTS", "ATTACHMENTS", "EMAILS")] + [String] + ${ExportType}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ExportOptions}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${ApiKey}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ExportLink' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/export' + + if (!$ExportType) { + throw "Error! The required parameter `ExportType` missing when calling getExportLink." + } + $LocalVarQueryParameters['exportType'] = $ExportType + + if ($ApiKey) { + $LocalVarQueryParameters['apiKey'] = $ApiKey + } + + if (!$ExportOptions) { + throw "Error! The required parameter `ExportOptions` missing when calling getExportLink." + } + + $LocalVarBodyParameter = $ExportOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ExportLink" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/FormControllerApi.ps1 b/src/maislurp-client-powershell/Api/FormControllerApi.ps1 new file mode 100644 index 00000000..e66988a3 --- /dev/null +++ b/src/maislurp-client-powershell/Api/FormControllerApi.ps1 @@ -0,0 +1,146 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Submit a form to be parsed and sent as an email to an address determined by the form fields + +.DESCRIPTION + +No description available. + +.PARAMETER To +The email address that submitted form should be sent to. + +.PARAMETER Subject +Optional subject of the email that will be sent. + +.PARAMETER RedirectTo +Optional URL to redirect form submitter to after submission. If not present user will see a success message. + +.PARAMETER EmailAddress +Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. + +.PARAMETER SuccessMessage +Optional success message to display if no _redirectTo present. + +.PARAMETER SpamCheck +Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored. + +.PARAMETER OtherParameters +All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Submit-Form { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${To}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Subject}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${RedirectTo}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SuccessMessage}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SpamCheck}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${OtherParameters}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Submit-Form' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forms' + + if ($To) { + $LocalVarQueryParameters['_to'] = $To + } + + if ($Subject) { + $LocalVarQueryParameters['_subject'] = $Subject + } + + if ($RedirectTo) { + $LocalVarQueryParameters['_redirectTo'] = $RedirectTo + } + + if ($EmailAddress) { + $LocalVarQueryParameters['_emailAddress'] = $EmailAddress + } + + if ($SuccessMessage) { + $LocalVarQueryParameters['_successMessage'] = $SuccessMessage + } + + if ($SpamCheck) { + $LocalVarQueryParameters['_spamCheck'] = $SpamCheck + } + + if ($OtherParameters) { + $LocalVarQueryParameters['otherParameters'] = $OtherParameters + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/GroupControllerApi.ps1 b/src/maislurp-client-powershell/Api/GroupControllerApi.ps1 new file mode 100644 index 00000000..046577c7 --- /dev/null +++ b/src/maislurp-client-powershell/Api/GroupControllerApi.ps1 @@ -0,0 +1,824 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Add contacts to a group + +.DESCRIPTION + +No description available. + +.PARAMETER GroupId +No description available. + +.PARAMETER UpdateGroupContacts +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GroupContactsDto +#> +function Add-ContactsToGroup { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GroupId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateGroupContacts}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Add-ContactsToGroup' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/groups/{groupId}/contacts' + if (!$GroupId) { + throw "Error! The required parameter `GroupId` missing when calling addContactsToGroup." + } + $LocalVarUri = $LocalVarUri.replace('{groupId}', $GroupId) + + if (!$UpdateGroupContacts) { + throw "Error! The required parameter `UpdateGroupContacts` missing when calling addContactsToGroup." + } + + $LocalVarBodyParameter = $UpdateGroupContacts | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GroupContactsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create a group + +.DESCRIPTION + +No description available. + +.PARAMETER CreateGroupOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GroupDto +#> +function New-Group { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateGroupOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Group' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/groups' + + if (!$CreateGroupOptions) { + throw "Error! The required parameter `CreateGroupOptions` missing when calling createGroup." + } + + $LocalVarBodyParameter = $CreateGroupOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GroupDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete group + +.DESCRIPTION + +No description available. + +.PARAMETER GroupId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteGroup { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GroupId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteGroup' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/groups/{groupId}' + if (!$GroupId) { + throw "Error! The required parameter `GroupId` missing when calling deleteGroup." + } + $LocalVarUri = $LocalVarUri.replace('{groupId}', $GroupId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all Contact Groups in paginated format + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageGroupProjection +#> +function Get-AllGroups { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllGroups' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/groups/paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageGroupProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get group + +.DESCRIPTION + +No description available. + +.PARAMETER GroupId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GroupDto +#> +function Get-Group { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GroupId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Group' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/groups/{groupId}' + if (!$GroupId) { + throw "Error! The required parameter `GroupId` missing when calling getGroup." + } + $LocalVarUri = $LocalVarUri.replace('{groupId}', $GroupId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GroupDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get group and contacts belonging to it + +.DESCRIPTION + +No description available. + +.PARAMETER GroupId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GroupContactsDto +#> +function Get-GroupWithContacts { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GroupId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-GroupWithContacts' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/groups/{groupId}/contacts' + if (!$GroupId) { + throw "Error! The required parameter `GroupId` missing when calling getGroupWithContacts." + } + $LocalVarUri = $LocalVarUri.replace('{groupId}', $GroupId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GroupContactsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER GroupId +No description available. + +.PARAMETER Page +Optional page index in group contact pagination + +.PARAMETER Size +Optional page size in group contact pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageContactProjection +#> +function Get-GroupWithContactsPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GroupId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-GroupWithContactsPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/groups/{groupId}/contacts-paginated' + if (!$GroupId) { + throw "Error! The required parameter `GroupId` missing when calling getGroupWithContactsPaginated." + } + $LocalVarUri = $LocalVarUri.replace('{groupId}', $GroupId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageContactProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all groups + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GroupProjection[] +#> +function Get-Groups { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Groups' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/groups' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GroupProjection[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Remove contacts from a group + +.DESCRIPTION + +No description available. + +.PARAMETER GroupId +No description available. + +.PARAMETER UpdateGroupContacts +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GroupContactsDto +#> +function Remove-ContactsFromGroup { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GroupId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateGroupContacts}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Remove-ContactsFromGroup' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/groups/{groupId}/contacts' + if (!$GroupId) { + throw "Error! The required parameter `GroupId` missing when calling removeContactsFromGroup." + } + $LocalVarUri = $LocalVarUri.replace('{groupId}', $GroupId) + + if (!$UpdateGroupContacts) { + throw "Error! The required parameter `UpdateGroupContacts` missing when calling removeContactsFromGroup." + } + + $LocalVarBodyParameter = $UpdateGroupContacts | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GroupContactsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/ImapControllerApi.ps1 b/src/maislurp-client-powershell/Api/ImapControllerApi.ps1 new file mode 100644 index 00000000..b7bb2e15 --- /dev/null +++ b/src/maislurp-client-powershell/Api/ImapControllerApi.ps1 @@ -0,0 +1,555 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Fetch message in an inbox + +.DESCRIPTION + +No description available. + +.PARAMETER SeqNum +No description available. + +.PARAMETER InboxId +Inbox ID to search + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapServerFetchResult +#> +function Invoke-ImapServerFetch { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int64] + ${SeqNum}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ImapServerFetch' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/imap/server/fetch' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$SeqNum) { + throw "Error! The required parameter `SeqNum` missing when calling imapServerFetch." + } + $LocalVarQueryParameters['seqNum'] = $SeqNum + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapServerFetchResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a message by email ID + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +Email ID to get + +.PARAMETER InboxId +Inbox ID to search + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapServerGetResult +#> +function Invoke-ImapServerGet { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ImapServerGet' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/imap/server/get' + + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling imapServerGet." + } + $LocalVarQueryParameters['emailId'] = $EmailId + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapServerGetResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List messages in an inbox + +.DESCRIPTION + +No description available. + +.PARAMETER ImapServerListOptions +No description available. + +.PARAMETER InboxId +Inbox ID to list + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapServerListResult +#> +function Invoke-ImapServerList { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ImapServerListOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ImapServerList' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/imap/server/list' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$ImapServerListOptions) { + throw "Error! The required parameter `ImapServerListOptions` missing when calling imapServerList." + } + + $LocalVarBodyParameter = $ImapServerListOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapServerListResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Search messages in an inbox + +.DESCRIPTION + +No description available. + +.PARAMETER ImapServerSearchOptions +No description available. + +.PARAMETER InboxId +Inbox ID to search + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapServerSearchResult +#> +function Invoke-ImapServerSearch { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ImapServerSearchOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ImapServerSearch' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/imap/server/search' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$ImapServerSearchOptions) { + throw "Error! The required parameter `ImapServerSearchOptions` missing when calling imapServerSearch." + } + + $LocalVarBodyParameter = $ImapServerSearchOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapServerSearchResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get status for mailbox + +.DESCRIPTION + +No description available. + +.PARAMETER ImapServerStatusOptions +No description available. + +.PARAMETER InboxId +Inbox ID to list + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapServerStatusResult +#> +function Invoke-ImapServerStatus { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ImapServerStatusOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ImapServerStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/imap/server/status' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$ImapServerStatusOptions) { + throw "Error! The required parameter `ImapServerStatusOptions` missing when calling imapServerStatus." + } + + $LocalVarBodyParameter = $ImapServerStatusOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapServerStatusResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER ImapUpdateFlagsOptions +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-ImapServerUpdateFlags { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${ImapUpdateFlagsOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ImapServerUpdateFlags' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/imap/server/update-flags' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$ImapUpdateFlagsOptions) { + throw "Error! The required parameter `ImapUpdateFlagsOptions` missing when calling imapServerUpdateFlags." + } + + $LocalVarBodyParameter = $ImapUpdateFlagsOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/InboxControllerApi.ps1 b/src/maislurp-client-powershell/Api/InboxControllerApi.ps1 new file mode 100644 index 00000000..b2b8216e --- /dev/null +++ b/src/maislurp-client-powershell/Api/InboxControllerApi.ps1 @@ -0,0 +1,4971 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Cancel a scheduled email job + +.DESCRIPTION + +No description available. + +.PARAMETER JobId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ScheduledJobDto +#> +function Stop-ScheduledJob { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${JobId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Stop-ScheduledJob' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/scheduled-jobs/{jobId}' + if (!$JobId) { + throw "Error! The required parameter `JobId` missing when calling cancelScheduledJob." + } + $LocalVarUri = $LocalVarUri.replace('{jobId}', $JobId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ScheduledJobDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailAddress +A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. + +.PARAMETER Tags +Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. + +.PARAMETER Name +Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. + +.PARAMETER Description +Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with + +.PARAMETER UseDomainPool +Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. + +.PARAMETER Favourite +Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering + +.PARAMETER ExpiresAt +Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. + +.PARAMETER ExpiresIn +Number of milliseconds that inbox should exist for + +.PARAMETER AllowTeamAccess +DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. + +.PARAMETER InboxType +HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. + +.PARAMETER VirtualInbox +Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. + +.PARAMETER UseShortAddress +Use a shorter email address under 31 characters + +.PARAMETER DomainId +ID of custom domain to use for email address. + +.PARAMETER DomainName +FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. + +.PARAMETER Prefix +Prefix to add before the email address for easier labelling or identification. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function New-Inbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${Tags}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Name}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Description}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseDomainPool}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${ExpiresAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${ExpiresIn}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${AllowTeamAccess}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${VirtualInbox}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UseShortAddress}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DomainId}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${DomainName}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Prefix}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Inbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes' + + if ($EmailAddress) { + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + } + + if ($Tags) { + $LocalVarQueryParameters['tags'] = $Tags + } + + if ($Name) { + $LocalVarQueryParameters['name'] = $Name + } + + if ($Description) { + $LocalVarQueryParameters['description'] = $Description + } + + if ($UseDomainPool) { + $LocalVarQueryParameters['useDomainPool'] = $UseDomainPool + } + + if ($Favourite) { + $LocalVarQueryParameters['favourite'] = $Favourite + } + + if ($ExpiresAt) { + $LocalVarQueryParameters['expiresAt'] = $ExpiresAt + } + + if ($ExpiresIn) { + $LocalVarQueryParameters['expiresIn'] = $ExpiresIn + } + + if ($AllowTeamAccess) { + $LocalVarQueryParameters['allowTeamAccess'] = $AllowTeamAccess + } + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($VirtualInbox) { + $LocalVarQueryParameters['virtualInbox'] = $VirtualInbox + } + + if ($UseShortAddress) { + $LocalVarQueryParameters['useShortAddress'] = $UseShortAddress + } + + if ($DomainId) { + $LocalVarQueryParameters['domainId'] = $DomainId + } + + if ($DomainName) { + $LocalVarQueryParameters['domainName'] = $DomainName + } + + if ($Prefix) { + $LocalVarQueryParameters['prefix'] = $Prefix + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create an inbox ruleset + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +inboxId + +.PARAMETER CreateInboxRulesetOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxRulesetDto +#> +function New-InboxRuleset { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateInboxRulesetOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-InboxRuleset' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/rulesets' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling createInboxRuleset." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$CreateInboxRulesetOptions) { + throw "Error! The required parameter `CreateInboxRulesetOptions` missing when calling createInboxRuleset." + } + + $LocalVarBodyParameter = $CreateInboxRulesetOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxRulesetDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create an inbox with default options. Uses MailSlurp domain pool address and is private. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function New-InboxWithDefaults { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-InboxWithDefaults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/withDefaults' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create an inbox with options. Extended options for inbox creation. + +.DESCRIPTION + +No description available. + +.PARAMETER CreateInboxDto +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function New-InboxWithOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateInboxDto}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-InboxWithOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/withOptions' + + if (!$CreateInboxDto) { + throw "Error! The required parameter `CreateInboxDto` missing when calling createInboxWithOptions." + } + + $LocalVarBodyParameter = $CreateInboxDto | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all emails in a given inboxes. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllInboxEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllInboxEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/{inboxId}/deleteAllInboxEmails' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling deleteAllInboxEmails." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all inboxes + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllInboxes { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllInboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inboxes by description + +.DESCRIPTION + +No description available. + +.PARAMETER Description +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllInboxesByDescription { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Description}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllInboxesByDescription' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/by-description' + + if (!$Description) { + throw "Error! The required parameter `Description` missing when calling deleteAllInboxesByDescription." + } + $LocalVarQueryParameters['description'] = $Description + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inboxes by name + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllInboxesByName { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Name}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllInboxesByName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/by-name' + + if (!$Name) { + throw "Error! The required parameter `Name` missing when calling deleteAllInboxesByName." + } + $LocalVarQueryParameters['name'] = $Name + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inboxes by tag + +.DESCRIPTION + +No description available. + +.PARAMETER Tag +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllInboxesByTag { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Tag}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllInboxesByTag' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/by-tag' + + if (!$Tag) { + throw "Error! The required parameter `Tag` missing when calling deleteAllInboxesByTag." + } + $LocalVarQueryParameters['tag'] = $Tag + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/{inboxId}' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling deleteInbox." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Does inbox exist + +.DESCRIPTION + +No description available. + +.PARAMETER EmailAddress +Email address + +.PARAMETER AllowCatchAll +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxExistsDto +#> +function Invoke-DoesInboxExist { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${AllowCatchAll}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DoesInboxExist' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/exists' + + if (!$EmailAddress) { + throw "Error! The required parameter `EmailAddress` missing when calling doesInboxExist." + } + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + + if ($AllowCatchAll) { + $LocalVarQueryParameters['allowCatchAll'] = $AllowCatchAll + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxExistsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Remove expired inboxes + +.DESCRIPTION + +No description available. + +.PARAMETER Before +Optional expired at before flag to flush expired inboxes that have expired before the given time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +FlushExpiredInboxesResult +#> +function Clear-Expired { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Clear-Expired' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/expired' + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "FlushExpiredInboxesResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List All Inboxes Paginated + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Favourite +Optionally filter results for favourites only + +.PARAMETER Search +Optionally filter by search words partial matching ID, tags, name, and email address + +.PARAMETER Tag +Optionally filter by tags. Will return inboxes that include given tags + +.PARAMETER TeamAccess +DEPRECATED. Optionally filter by team access. + +.PARAMETER Since +Optional filter by created after given date time + +.PARAMETER Before +Optional filter by created before given date time + +.PARAMETER InboxType +Optional filter by inbox type + +.PARAMETER InboxFunction +Optional filter by inbox function + +.PARAMETER DomainId +Optional domain ID filter + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxProjection +#> +function Get-AllInboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Search}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Tag}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${TeamAccess}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR")] + [String] + ${InboxFunction}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DomainId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllInboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Favourite) { + $LocalVarQueryParameters['favourite'] = $Favourite + } + + if ($Search) { + $LocalVarQueryParameters['search'] = $Search + } + + if ($Tag) { + $LocalVarQueryParameters['tag'] = $Tag + } + + if ($TeamAccess) { + $LocalVarQueryParameters['teamAccess'] = $TeamAccess + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($InboxFunction) { + $LocalVarQueryParameters['inboxFunction'] = $InboxFunction + } + + if ($DomainId) { + $LocalVarQueryParameters['domainId'] = $DomainId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List All Inboxes Offset Paginated + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Favourite +Optionally filter results for favourites only + +.PARAMETER Search +Optionally filter by search words partial matching ID, tags, name, and email address + +.PARAMETER Tag +Optionally filter by tags. Will return inboxes that include given tags + +.PARAMETER TeamAccess +DEPRECATED. Optionally filter by team access. + +.PARAMETER Since +Optional filter by created after given date time + +.PARAMETER Before +Optional filter by created before given date time + +.PARAMETER InboxType +Optional filter by inbox type + +.PARAMETER InboxFunction +Optional filter by inbox function + +.PARAMETER DomainId +Optional domain ID filter + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxProjection +#> +function Get-AllInboxesOffsetPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Search}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Tag}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${TeamAccess}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR")] + [String] + ${InboxFunction}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DomainId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllInboxesOffsetPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/offset-paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Favourite) { + $LocalVarQueryParameters['favourite'] = $Favourite + } + + if ($Search) { + $LocalVarQueryParameters['search'] = $Search + } + + if ($Tag) { + $LocalVarQueryParameters['tag'] = $Tag + } + + if ($TeamAccess) { + $LocalVarQueryParameters['teamAccess'] = $TeamAccess + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($InboxType) { + $LocalVarQueryParameters['inboxType'] = $InboxType + } + + if ($InboxFunction) { + $LocalVarQueryParameters['inboxFunction'] = $InboxFunction + } + + if ($DomainId) { + $LocalVarQueryParameters['domainId'] = $DomainId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all scheduled email sending jobs for account + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in scheduled job list pagination + +.PARAMETER Size +Optional page size in scheduled job list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageScheduledJobs +#> +function Get-AllScheduledJobs { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllScheduledJobs' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/scheduled-jobs' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageScheduledJobs" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER Page +Optional page index in delivery status list pagination + +.PARAMETER Size +Optional page size in delivery status list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageDeliveryStatus +#> +function Get-DeliveryStatusesByInboxId { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-DeliveryStatusesByInboxId' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/delivery-status' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getDeliveryStatusesByInboxId." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageDeliveryStatus" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of inbox that emails belongs to + +.PARAMETER Size +Alias for limit. Assessed first before assessing any passed limit. + +.PARAMETER Limit +Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller + +.PARAMETER Sort +Sort the results by received date and direction ASC or DESC + +.PARAMETER RetryTimeout +Maximum milliseconds to spend retrying inbox database until minCount emails are returned + +.PARAMETER DelayTimeout +No description available. + +.PARAMETER MinCount +Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. + +.PARAMETER UnreadOnly +No description available. + +.PARAMETER Before +Exclude emails received after this ISO 8601 date time + +.PARAMETER Since +Exclude emails received before this ISO 8601 date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreview[] +#> +function Get-Emails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Limit}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${RetryTimeout}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${DelayTimeout}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${MinCount}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Emails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/emails' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getEmails." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Limit) { + $LocalVarQueryParameters['limit'] = $Limit + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($RetryTimeout) { + $LocalVarQueryParameters['retryTimeout'] = $RetryTimeout + } + + if ($DelayTimeout) { + $LocalVarQueryParameters['delayTimeout'] = $DelayTimeout + } + + if ($MinCount) { + $LocalVarQueryParameters['minCount'] = $MinCount + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Inbox ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapAccessDetails +#> +function Get-ImapAccess { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ImapAccess' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/imap-access' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapAccessDetails" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Inbox ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapSmtpAccessDetails +#> +function Get-ImapSmtpAccess { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ImapSmtpAccess' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/imap-smtp-access' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapSmtpAccessDetails" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Inbox ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Get-ImapSmtpAccessEnv { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ImapSmtpAccessEnv' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/imap-smtp-access/env' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ImapSmtpAccessServers +#> +function Get-ImapSmtpAccessServers { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ImapSmtpAccessServers' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/imap-smtp-access/servers' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ImapSmtpAccessServers" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get Inbox. Returns properties of an inbox. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function Get-Inbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Inbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getInbox." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Search for an inbox with the provided email address + +.DESCRIPTION + +No description available. + +.PARAMETER EmailAddress +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxByEmailAddressResult +#> +function Get-InboxByEmailAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxByEmailAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/byEmailAddress' + + if (!$EmailAddress) { + throw "Error! The required parameter `EmailAddress` missing when calling getInboxByEmailAddress." + } + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxByEmailAddressResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Search for an inbox with the given name + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxByNameResult +#> +function Get-InboxByName { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Name}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxByName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/byName' + + if (!$Name) { + throw "Error! The required parameter `Name` missing when calling getInboxByName." + } + $LocalVarQueryParameters['name'] = $Name + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxByNameResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get total inbox count + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CountDto +#> +function Get-InboxCount { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/count' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CountDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get email count in inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of inbox that emails belongs to + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CountDto +#> +function Get-InboxEmailCount { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxEmailCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/emails/count' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getInboxEmailCount." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CountDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get inbox emails paginated + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of inbox that emails belongs to + +.PARAMETER Page +Optional page index in inbox emails list pagination + +.PARAMETER Size +Optional page size in inbox emails list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Optional filter by received after given date time + +.PARAMETER Before +Optional filter by received before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageEmailPreview +#> +function Get-InboxEmailsPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxEmailsPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/emails/paginated' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getInboxEmailsPaginated." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageEmailPreview" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all inbox IDs + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxIdsResult +#> +function Get-InboxIds { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxIds' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/ids' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxIdsResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get Inbox Sent Emails + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER Page +Optional page index in inbox sent email list pagination + +.PARAMETER Size +Optional page size in inbox sent email list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional sent email search + +.PARAMETER Since +Optional filter by sent after given date time + +.PARAMETER Before +Optional filter by sent before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageSentEmailProjection +#> +function Get-InboxSentEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxSentEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/sent' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getInboxSentEmails." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageSentEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get inbox tags + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String[] +#> +function Get-InboxTags { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxTags' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/tags' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List Inboxes and email addresses + +.DESCRIPTION + +No description available. + +.PARAMETER Size +Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Optional filter by created after given date time + +.PARAMETER ExcludeCatchAllInboxes +Optional exclude catch all inboxes + +.PARAMETER Before +Optional filter by created before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto[] +#> +function Get-Inboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${ExcludeCatchAllInboxes}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Inboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes' + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($ExcludeCatchAllInboxes) { + $LocalVarQueryParameters['excludeCatchAllInboxes'] = $ExcludeCatchAllInboxes + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to get the latest email from + +.PARAMETER TimeoutMillis +Timeout milliseconds to wait for latest email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Get-LatestEmailInInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int64] + ${TimeoutMillis}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-LatestEmailInInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/getLatestEmail' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getLatestEmailInInbox." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$TimeoutMillis) { + throw "Error! The required parameter `TimeoutMillis` missing when calling getLatestEmailInInbox." + } + $LocalVarQueryParameters['timeoutMillis'] = $TimeoutMillis + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List Organization Inboxes Paginated + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Optional filter by created after given date time + +.PARAMETER Before +Optional filter by created before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageOrganizationInboxProjection +#> +function Get-OrganizationInboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-OrganizationInboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/organization' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageOrganizationInboxProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a scheduled email job + +.DESCRIPTION + +No description available. + +.PARAMETER JobId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ScheduledJobDto +#> +function Get-ScheduledJob { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${JobId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ScheduledJob' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/scheduled-jobs/{jobId}' + if (!$JobId) { + throw "Error! The required parameter `JobId` missing when calling getScheduledJob." + } + $LocalVarUri = $LocalVarUri.replace('{jobId}', $JobId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ScheduledJobDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all scheduled email sending jobs for the inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER Page +Optional page index in scheduled job list pagination + +.PARAMETER Size +Optional page size in scheduled job list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageScheduledJobs +#> +function Get-ScheduledJobsByInboxId { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ScheduledJobsByInboxId' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/scheduled-jobs' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getScheduledJobsByInboxId." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageScheduledJobs" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Inbox ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SmtpAccessDetails +#> +function Get-SmtpAccess { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SmtpAccess' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/smtp-access' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SmtpAccessDetails" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List inbox rulesets + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER Page +Optional page index in inbox ruleset list pagination + +.PARAMETER Size +Optional page size in inbox ruleset list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Optional filter by created after given date time + +.PARAMETER Before +Optional filter by created before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxRulesetDto +#> +function Invoke-ListInboxRulesets { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ListInboxRulesets' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/rulesets' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling listInboxRulesets." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxRulesetDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List inbox tracking pixels + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER Page +Optional page index in inbox tracking pixel list pagination + +.PARAMETER Size +Optional page size in inbox tracking pixel list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Optional filter by created after given date time + +.PARAMETER Before +Optional filter by created before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageTrackingPixelProjection +#> +function Invoke-ListInboxTrackingPixels { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ListInboxTrackingPixels' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/tracking-pixels' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling listInboxTrackingPixels." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageTrackingPixelProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Search all inboxes and return matching inboxes + +.DESCRIPTION + +No description available. + +.PARAMETER SearchInboxesOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxProjection +#> +function Search-Inboxes { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SearchInboxesOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Search-Inboxes' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/search' + + if (!$SearchInboxesOptions) { + throw "Error! The required parameter `SearchInboxesOptions` missing when calling searchInboxes." + } + + $LocalVarBodyParameter = $SearchInboxesOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send Email + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Send-Email { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-Email' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling sendEmail." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling sendEmail." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send email and return sent confirmation + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Send-EmailAndConfirm { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-EmailAndConfirm' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/confirm' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling sendEmailAndConfirm." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling sendEmailAndConfirm." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send email with queue + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER ValidateBeforeEnqueue +Validate before adding to queue + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Send-EmailWithQueue { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Boolean] + ${ValidateBeforeEnqueue}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-EmailWithQueue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/with-queue' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling sendEmailWithQueue." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$ValidateBeforeEnqueue) { + throw "Error! The required parameter `ValidateBeforeEnqueue` missing when calling sendEmailWithQueue." + } + $LocalVarQueryParameters['validateBeforeEnqueue'] = $ValidateBeforeEnqueue + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling sendEmailWithQueue." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send email using an SMTP mail envelope and message body and return sent confirmation + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER SendSMTPEnvelopeOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Send-SmtpEnvelope { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendSMTPEnvelopeOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-SmtpEnvelope' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/smtp-envelope' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling sendSmtpEnvelope." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$SendSMTPEnvelopeOptions) { + throw "Error! The required parameter `SendSMTPEnvelopeOptions` missing when calling sendSmtpEnvelope." + } + + $LocalVarBodyParameter = $SendSMTPEnvelopeOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send a test email to inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Send-TestEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-TestEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/{inboxId}/send-test-email' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling sendTestEmail." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send email with with delay or schedule + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of the inbox you want to send the email from + +.PARAMETER SendEmailOptions +No description available. + +.PARAMETER SendAtTimestamp +Sending timestamp + +.PARAMETER SendAtNowPlusSeconds +Send after n seconds + +.PARAMETER ValidateBeforeEnqueue +Validate before adding to queue + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ScheduledJobDto +#> +function Send-WithSchedule { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SendEmailOptions}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${SendAtTimestamp}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${SendAtNowPlusSeconds}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${ValidateBeforeEnqueue}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-WithSchedule' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/with-schedule' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling sendWithSchedule." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($SendAtTimestamp) { + $LocalVarQueryParameters['sendAtTimestamp'] = $SendAtTimestamp + } + + if ($SendAtNowPlusSeconds) { + $LocalVarQueryParameters['sendAtNowPlusSeconds'] = $SendAtNowPlusSeconds + } + + if ($ValidateBeforeEnqueue) { + $LocalVarQueryParameters['validateBeforeEnqueue'] = $ValidateBeforeEnqueue + } + + if (!$SendEmailOptions) { + throw "Error! The required parameter `SendEmailOptions` missing when calling sendWithSchedule." + } + + $LocalVarBodyParameter = $SendEmailOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ScheduledJobDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Set inbox favourited state + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of inbox to set favourite state + +.PARAMETER SetInboxFavouritedOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function Set-InboxFavourited { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SetInboxFavouritedOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Set-InboxFavourited' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/favourite' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling setInboxFavourited." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$SetInboxFavouritedOptions) { + throw "Error! The required parameter `SetInboxFavouritedOptions` missing when calling setInboxFavourited." + } + + $LocalVarBodyParameter = $SetInboxFavouritedOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER UpdateImapAccessOptions +No description available. + +.PARAMETER InboxId +Inbox ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Update-ImapAccess { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateImapAccessOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-ImapAccess' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/imap-access' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$UpdateImapAccessOptions) { + throw "Error! The required parameter `UpdateImapAccessOptions` missing when calling updateImapAccess." + } + + $LocalVarBodyParameter = $UpdateImapAccessOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update Inbox. Change name and description. Email address is not editable. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER UpdateInboxOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxDto +#> +function Update-Inbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateInboxOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-Inbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling updateInbox." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$UpdateInboxOptions) { + throw "Error! The required parameter `UpdateInboxOptions` missing when calling updateInbox." + } + + $LocalVarBodyParameter = $UpdateInboxOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER UpdateSmtpAccessOptions +No description available. + +.PARAMETER InboxId +Inbox ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Update-SmtpAccess { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateSmtpAccessOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-SmtpAccess' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/smtp-access' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$UpdateSmtpAccessOptions) { + throw "Error! The required parameter `UpdateSmtpAccessOptions` missing when calling updateSmtpAccess." + } + + $LocalVarBodyParameter = $UpdateSmtpAccessOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/InboxForwarderControllerApi.ps1 b/src/maislurp-client-powershell/Api/InboxForwarderControllerApi.ps1 new file mode 100644 index 00000000..a4f83b49 --- /dev/null +++ b/src/maislurp-client-powershell/Api/InboxForwarderControllerApi.ps1 @@ -0,0 +1,1216 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create an inbox forwarder + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Inbox id to attach forwarder to + +.PARAMETER CreateInboxForwarderOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderDto +#> +function New-NewInboxForwarder { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateInboxForwarderOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-NewInboxForwarder' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/forwarders' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling createNewInboxForwarder." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$CreateInboxForwarderOptions) { + throw "Error! The required parameter `CreateInboxForwarderOptions` missing when calling createNewInboxForwarder." + } + + $LocalVarBodyParameter = $CreateInboxForwarderOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an inbox forwarder + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox forwarder + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInboxForwarder { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInboxForwarder' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/forwarders/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteInboxForwarder." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inbox forwarders + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox id to attach forwarder to + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInboxForwarders { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInboxForwarders' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/forwarders' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all inbox forwarder events + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in inbox forwarder event list pagination + +.PARAMETER Size +Optional page size in inbox forwarder event list pagination + +.PARAMETER InboxId +Optional inbox ID to filter for + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxForwarderEvents +#> +function Get-AllInboxForwarderEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllInboxForwarderEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forwarders/events' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxForwarderEvents" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a forwarder event + +.DESCRIPTION + +No description available. + +.PARAMETER EventId +ID of inbox forwarder event + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderEventDto +#> +function Get-ForwarderEvent { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EventId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ForwarderEvent' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forwarders/events/{eventId}' + if (!$EventId) { + throw "Error! The required parameter `EventId` missing when calling getForwarderEvent." + } + $LocalVarUri = $LocalVarUri.replace('{eventId}', $EventId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderEventDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox forwarder + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox forwarder + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderDto +#> +function Get-InboxForwarder { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxForwarder' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forwarders/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getInboxForwarder." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox forwarder event + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox forwarder + +.PARAMETER EventId +ID of inbox forwarder event + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderEventDto +#> +function Get-InboxForwarderEvent { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EventId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxForwarderEvent' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forwarders/{id}/events/{eventId}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getInboxForwarderEvent." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + if (!$EventId) { + throw "Error! The required parameter `EventId` missing when calling getInboxForwarderEvent." + } + $LocalVarUri = $LocalVarUri.replace('{eventId}', $EventId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderEventDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox forwarder event list + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox forwarder + +.PARAMETER Page +Optional page index in inbox forwarder event list pagination + +.PARAMETER Size +Optional page size in inbox forwarder event list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxForwarderEvents +#> +function Get-InboxForwarderEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxForwarderEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forwarders/{id}/events' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getInboxForwarderEvents." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxForwarderEvents" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List inbox forwarders + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox id to get forwarders from + +.PARAMETER Page +Optional page index in inbox forwarder list pagination + +.PARAMETER Size +Optional page size in inbox forwarder list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxForwarderDto +#> +function Get-InboxForwarders { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxForwarders' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/forwarders' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxForwarderDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test an inbox forwarder + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox forwarder + +.PARAMETER InboxForwarderTestOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderTestResult +#> +function Test-InboxForwarder { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxForwarderTestOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-InboxForwarder' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/forwarders/{id}/test' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling testInboxForwarder." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$InboxForwarderTestOptions) { + throw "Error! The required parameter `InboxForwarderTestOptions` missing when calling testInboxForwarder." + } + + $LocalVarBodyParameter = $InboxForwarderTestOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test inbox forwarders for inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of inbox + +.PARAMETER InboxForwarderTestOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderTestResult +#> +function Test-InboxForwardersForInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxForwarderTestOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-InboxForwardersForInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/forwarders' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling testInboxForwardersForInbox." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$InboxForwarderTestOptions) { + throw "Error! The required parameter `InboxForwarderTestOptions` missing when calling testInboxForwardersForInbox." + } + + $LocalVarBodyParameter = $InboxForwarderTestOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test new inbox forwarder + +.DESCRIPTION + +No description available. + +.PARAMETER TestNewInboxForwarderOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderTestResult +#> +function Test-NewInboxForwarder { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TestNewInboxForwarderOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-NewInboxForwarder' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/forwarders' + + if (!$TestNewInboxForwarderOptions) { + throw "Error! The required parameter `TestNewInboxForwarderOptions` missing when calling testNewInboxForwarder." + } + + $LocalVarBodyParameter = $TestNewInboxForwarderOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update an inbox forwarder + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox forwarder + +.PARAMETER CreateInboxForwarderOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxForwarderDto +#> +function Update-InboxForwarder { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateInboxForwarderOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-InboxForwarder' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/forwarders/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling updateInboxForwarder." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$CreateInboxForwarderOptions) { + throw "Error! The required parameter `CreateInboxForwarderOptions` missing when calling updateInboxForwarder." + } + + $LocalVarBodyParameter = $CreateInboxForwarderOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxForwarderDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/InboxReplierControllerApi.ps1 b/src/maislurp-client-powershell/Api/InboxReplierControllerApi.ps1 new file mode 100644 index 00000000..ad11bec5 --- /dev/null +++ b/src/maislurp-client-powershell/Api/InboxReplierControllerApi.ps1 @@ -0,0 +1,650 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create an inbox replier + +.DESCRIPTION + +No description available. + +.PARAMETER CreateInboxReplierOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxReplierDto +#> +function New-NewInboxReplier { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateInboxReplierOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-NewInboxReplier' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/repliers' + + if (!$CreateInboxReplierOptions) { + throw "Error! The required parameter `CreateInboxReplierOptions` missing when calling createNewInboxReplier." + } + + $LocalVarBodyParameter = $CreateInboxReplierOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxReplierDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an inbox replier + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox replier + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInboxReplier { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInboxReplier' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/repliers/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteInboxReplier." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inbox repliers + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox id to attach replier to + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInboxRepliers { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInboxRepliers' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/repliers' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox replier + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox replier + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxReplierDto +#> +function Get-InboxReplier { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxReplier' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/repliers/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getInboxReplier." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxReplierDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox replier event list + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox replier + +.PARAMETER Page +Optional page index in inbox replier event list pagination + +.PARAMETER Size +Optional page size in inbox replier event list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxReplierEvents +#> +function Get-InboxReplierEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxReplierEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/repliers/{id}/events' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getInboxReplierEvents." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxReplierEvents" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List inbox repliers + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox id to get repliers from + +.PARAMETER Page +Optional page index in inbox replier list pagination + +.PARAMETER Size +Optional page size in inbox replier list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxReplierDto +#> +function Get-InboxRepliers { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxRepliers' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/repliers' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxReplierDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update an inbox replier + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox replier + +.PARAMETER UpdateInboxReplierOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxReplierDto +#> +function Update-InboxReplier { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${UpdateInboxReplierOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-InboxReplier' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/repliers/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling updateInboxReplier." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$UpdateInboxReplierOptions) { + throw "Error! The required parameter `UpdateInboxReplierOptions` missing when calling updateInboxReplier." + } + + $LocalVarBodyParameter = $UpdateInboxReplierOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxReplierDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/InboxRulesetControllerApi.ps1 b/src/maislurp-client-powershell/Api/InboxRulesetControllerApi.ps1 new file mode 100644 index 00000000..b0da9a33 --- /dev/null +++ b/src/maislurp-client-powershell/Api/InboxRulesetControllerApi.ps1 @@ -0,0 +1,904 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create an inbox ruleset + +.DESCRIPTION + +No description available. + +.PARAMETER CreateInboxRulesetOptions +No description available. + +.PARAMETER InboxId +Inbox id to attach ruleset to + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxRulesetDto +#> +function New-NewInboxRuleset { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateInboxRulesetOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-NewInboxRuleset' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/rulesets' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if (!$CreateInboxRulesetOptions) { + throw "Error! The required parameter `CreateInboxRulesetOptions` missing when calling createNewInboxRuleset." + } + + $LocalVarBodyParameter = $CreateInboxRulesetOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxRulesetDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete an inbox ruleset + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox ruleset + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInboxRuleset { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInboxRuleset' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/rulesets/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteInboxRuleset." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete inbox rulesets + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox id to attach ruleset to + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteInboxRulesets { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteInboxRulesets' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/rulesets' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get an inbox ruleset + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox ruleset + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxRulesetDto +#> +function Get-InboxRuleset { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxRuleset' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/rulesets/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getInboxRuleset." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxRulesetDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List inbox rulesets + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inbox id to get rulesets from + +.PARAMETER Page +Optional page index in inbox ruleset list pagination + +.PARAMETER Size +Optional page size in inbox ruleset list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageInboxRulesetDto +#> +function Get-InboxRulesets { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxRulesets' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/rulesets' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageInboxRulesetDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test an inbox ruleset + +.DESCRIPTION + +No description available. + +.PARAMETER Id +ID of inbox ruleset + +.PARAMETER InboxRulesetTestOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxRulesetTestResult +#> +function Test-InboxRuleset { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxRulesetTestOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-InboxRuleset' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/rulesets/{id}/test' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling testInboxRuleset." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if (!$InboxRulesetTestOptions) { + throw "Error! The required parameter `InboxRulesetTestOptions` missing when calling testInboxRuleset." + } + + $LocalVarBodyParameter = $InboxRulesetTestOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxRulesetTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test receiving with inbox rulesets + +.DESCRIPTION + +No description available. + +.PARAMETER TestInboxRulesetReceivingOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TestInboxRulesetReceivingResult +#> +function Test-InboxRulesetReceiving { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TestInboxRulesetReceivingOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-InboxRulesetReceiving' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/rulesets/test-receiving' + + if (!$TestInboxRulesetReceivingOptions) { + throw "Error! The required parameter `TestInboxRulesetReceivingOptions` missing when calling testInboxRulesetReceiving." + } + + $LocalVarBodyParameter = $TestInboxRulesetReceivingOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TestInboxRulesetReceivingResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test sending with inbox rulesets + +.DESCRIPTION + +No description available. + +.PARAMETER TestInboxRulesetSendingOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TestInboxRulesetSendingResult +#> +function Test-InboxRulesetSending { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TestInboxRulesetSendingOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-InboxRulesetSending' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/rulesets/test-sending' + + if (!$TestInboxRulesetSendingOptions) { + throw "Error! The required parameter `TestInboxRulesetSendingOptions` missing when calling testInboxRulesetSending." + } + + $LocalVarBodyParameter = $TestInboxRulesetSendingOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TestInboxRulesetSendingResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test inbox rulesets for inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +ID of inbox + +.PARAMETER InboxRulesetTestOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxRulesetTestResult +#> +function Test-InboxRulesetsForInbox { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxRulesetTestOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-InboxRulesetsForInbox' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/rulesets' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling testInboxRulesetsForInbox." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$InboxRulesetTestOptions) { + throw "Error! The required parameter `InboxRulesetTestOptions` missing when calling testInboxRulesetsForInbox." + } + + $LocalVarBodyParameter = $InboxRulesetTestOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxRulesetTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test new inbox ruleset + +.DESCRIPTION + +No description available. + +.PARAMETER TestNewInboxRulesetOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +InboxRulesetTestResult +#> +function Test-NewInboxRuleset { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TestNewInboxRulesetOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-NewInboxRuleset' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/rulesets' + + if (!$TestNewInboxRulesetOptions) { + throw "Error! The required parameter `TestNewInboxRulesetOptions` missing when calling testNewInboxRuleset." + } + + $LocalVarBodyParameter = $TestNewInboxRulesetOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "InboxRulesetTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/MailServerControllerApi.ps1 b/src/maislurp-client-powershell/Api/MailServerControllerApi.ps1 new file mode 100644 index 00000000..b2bcd5a2 --- /dev/null +++ b/src/maislurp-client-powershell/Api/MailServerControllerApi.ps1 @@ -0,0 +1,419 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Get DNS Mail Server records for a domain + +.DESCRIPTION + +No description available. + +.PARAMETER DescribeDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DescribeMailServerDomainResult +#> +function Invoke-DescribeMailServerDomain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DescribeDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DescribeMailServerDomain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/mail-server/describe/domain' + + if (!$DescribeDomainOptions) { + throw "Error! The required parameter `DescribeDomainOptions` missing when calling describeMailServerDomain." + } + + $LocalVarBodyParameter = $DescribeDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DescribeMailServerDomainResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Lookup DNS records for a domain + +.DESCRIPTION + +No description available. + +.PARAMETER DNSLookupOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DNSLookupResults +#> +function Get-DnsLookup { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DNSLookupOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-DnsLookup' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/mail-server/describe/dns-lookup' + + if (!$DNSLookupOptions) { + throw "Error! The required parameter `DNSLookupOptions` missing when calling getDnsLookup." + } + + $LocalVarBodyParameter = $DNSLookupOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DNSLookupResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Lookup DNS records for multiple domains + +.DESCRIPTION + +No description available. + +.PARAMETER DNSLookupsOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DNSLookupResults +#> +function Get-DnsLookups { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DNSLookupsOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-DnsLookups' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/mail-server/describe/dns-lookups' + + if (!$DNSLookupsOptions) { + throw "Error! The required parameter `DNSLookupsOptions` missing when calling getDnsLookups." + } + + $LocalVarBodyParameter = $DNSLookupsOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DNSLookupResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get IP address for a domain + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +IPAddressResult +#> +function Get-IpAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Name}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-IpAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/mail-server/describe/ip-address' + + if (!$Name) { + throw "Error! The required parameter `Name` missing when calling getIpAddress." + } + $LocalVarQueryParameters['name'] = $Name + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "IPAddressResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server. + +.DESCRIPTION + +No description available. + +.PARAMETER VerifyEmailAddressOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailVerificationResult +#> +function Test-EmailAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${VerifyEmailAddressOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-EmailAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/mail-server/verify/email-address' + + if (!$VerifyEmailAddressOptions) { + throw "Error! The required parameter `VerifyEmailAddressOptions` missing when calling verifyEmailAddress." + } + + $LocalVarBodyParameter = $VerifyEmailAddressOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailVerificationResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/MissedEmailControllerApi.ps1 b/src/maislurp-client-powershell/Api/MissedEmailControllerApi.ps1 new file mode 100644 index 00000000..4c8be5b4 --- /dev/null +++ b/src/maislurp-client-powershell/Api/MissedEmailControllerApi.ps1 @@ -0,0 +1,548 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Get all MissedEmails in paginated format + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER InboxId +Optional inbox ID filter + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageMissedEmailProjection +#> +function Get-AllMissedEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllMissedEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/missed-emails' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageMissedEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all unknown missed emails in paginated format + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER InboxId +Optional inbox ID filter + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageUnknownMissedEmailProjection +#> +function Get-AllUnknownMissedEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllUnknownMissedEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/missed-emails/unknown' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageUnknownMissedEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get MissedEmail + +.DESCRIPTION + +No description available. + +.PARAMETER MissedEmailId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +MissedEmailDto +#> +function Get-MissedEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${MissedEmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-MissedEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/missed-emails/{missedEmailId}' + if (!$MissedEmailId) { + throw "Error! The required parameter `MissedEmailId` missing when calling getMissedEmail." + } + $LocalVarUri = $LocalVarUri.replace('{missedEmailId}', $MissedEmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "MissedEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Restore missed emails + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Restore-MissedEmails { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Restore-MissedEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/missed-emails/restore' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for Nth missed email + +.DESCRIPTION + +No description available. + +.PARAMETER Index +Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 + +.PARAMETER InboxId +Optional inbox ID filter + +.PARAMETER Timeout +Optional timeout milliseconds + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +MissedEmailDto +#> +function Wait-ForNthMissedEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int32] + ${Index}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForNthMissedEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/missed-emails/waitForNthMissedEmail' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if (!$Index) { + throw "Error! The required parameter `Index` missing when calling waitForNthMissedEmail." + } + $LocalVarQueryParameters['index'] = $Index + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "MissedEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/PhoneControllerApi.ps1 b/src/maislurp-client-powershell/Api/PhoneControllerApi.ps1 new file mode 100644 index 00000000..4a29b156 --- /dev/null +++ b/src/maislurp-client-powershell/Api/PhoneControllerApi.ps1 @@ -0,0 +1,766 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER CreateEmergencyAddressOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmergencyAddress +#> +function New-EmergencyAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateEmergencyAddressOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-EmergencyAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/phone/emergency-addresses' + + if (!$CreateEmergencyAddressOptions) { + throw "Error! The required parameter `CreateEmergencyAddressOptions` missing when calling createEmergencyAddress." + } + + $LocalVarBodyParameter = $CreateEmergencyAddressOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmergencyAddress" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER AddressId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmptyResponseDto +#> +function Invoke-DeleteEmergencyAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AddressId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteEmergencyAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/emergency-addresses/{addressId}' + if (!$AddressId) { + throw "Error! The required parameter `AddressId` missing when calling deleteEmergencyAddress." + } + $LocalVarUri = $LocalVarUri.replace('{addressId}', $AddressId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmptyResponseDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumberId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeletePhoneNumber { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneNumberId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeletePhoneNumber' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/phone/numbers/{phoneNumberId}' + if (!$PhoneNumberId) { + throw "Error! The required parameter `PhoneNumberId` missing when calling deletePhoneNumber." + } + $LocalVarUri = $LocalVarUri.replace('{phoneNumberId}', $PhoneNumberId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER AddressId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmergencyAddress +#> +function Get-EmergencyAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AddressId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmergencyAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/emergency-addresses/{addressId}' + if (!$AddressId) { + throw "Error! The required parameter `AddressId` missing when calling getEmergencyAddress." + } + $LocalVarUri = $LocalVarUri.replace('{addressId}', $AddressId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmergencyAddress" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmergencyAddressDto[] +#> +function Get-EmergencyAddresses { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-EmergencyAddresses' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/emergency-addresses' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmergencyAddressDto[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumberId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PhoneNumberDto +#> +function Get-PhoneNumber { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneNumberId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-PhoneNumber' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/numbers/{phoneNumberId}' + if (!$PhoneNumberId) { + throw "Error! The required parameter `PhoneNumberId` missing when calling getPhoneNumber." + } + $LocalVarUri = $LocalVarUri.replace('{phoneNumberId}', $PhoneNumberId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PhoneNumberDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneCountry +Optional phone country + +.PARAMETER Page +Optional page index for list pagination + +.PARAMETER Size +Optional page size for list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PagePhoneNumberProjection +#> +function Get-PhoneNumbers { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("US", "GB", "AU")] + [String] + ${PhoneCountry}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-PhoneNumbers' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/numbers' + + if ($PhoneCountry) { + $LocalVarQueryParameters['phoneCountry'] = $PhoneCountry + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PagePhoneNumberProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PhonePlanDto[] +#> +function Get-PhonePlans { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-PhonePlans' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/plans' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PhonePlanDto[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumberId +No description available. + +.PARAMETER TestPhoneNumberOptions +No description available. + +.PARAMETER XTestId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Test-PhoneNumberSendSms { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneNumberId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TestPhoneNumberOptions}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${XTestId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-PhoneNumberSendSms' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/phone/numbers/{phoneNumberId}/test' + if (!$PhoneNumberId) { + throw "Error! The required parameter `PhoneNumberId` missing when calling testPhoneNumberSendSms." + } + $LocalVarUri = $LocalVarUri.replace('{phoneNumberId}', $PhoneNumberId) + + if ($XTestId) { + $LocalVarHeaderParameters['x-test-id'] = $XTestId + } + + if (!$TestPhoneNumberOptions) { + throw "Error! The required parameter `TestPhoneNumberOptions` missing when calling testPhoneNumberSendSms." + } + + $LocalVarBodyParameter = $TestPhoneNumberOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/SentEmailsControllerApi.ps1 b/src/maislurp-client-powershell/Api/SentEmailsControllerApi.ps1 new file mode 100644 index 00000000..1918f8df --- /dev/null +++ b/src/maislurp-client-powershell/Api/SentEmailsControllerApi.ps1 @@ -0,0 +1,1654 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Delete all sent email receipts + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllSentEmails { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllSentEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/sent' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete sent email receipt + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteSentEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteSentEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/sent/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling deleteSentEmail." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in sent email tracking pixel list pagination + +.PARAMETER Size +Optional page size in sent email tracking pixel list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageTrackingPixelProjection +#> +function Get-AllSentTrackingPixels { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllSentTrackingPixels' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/tracking-pixels' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageTrackingPixelProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get raw sent email string. Returns unparsed raw SMTP message with headers and body. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Get-RawSentEmailContents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-RawSentEmailContents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/sent/{emailId}/raw' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getRawSentEmailContents." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailId +ID of email + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +RawEmailJson +#> +function Get-RawSentEmailJson { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-RawSentEmailJson' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/{emailId}/raw/json' + if (!$EmailId) { + throw "Error! The required parameter `EmailId` missing when calling getRawSentEmailJson." + } + $LocalVarUri = $LocalVarUri.replace('{emailId}', $EmailId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "RawEmailJson" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER DeliveryId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DeliveryStatusDto +#> +function Get-SentDeliveryStatus { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${DeliveryId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentDeliveryStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/delivery-status/{deliveryId}' + if (!$DeliveryId) { + throw "Error! The required parameter `DeliveryId` missing when calling getSentDeliveryStatus." + } + $LocalVarUri = $LocalVarUri.replace('{deliveryId}', $DeliveryId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DeliveryStatusDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in delivery status list pagination + +.PARAMETER Size +Optional page size in delivery status list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageDeliveryStatus +#> +function Get-SentDeliveryStatuses { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentDeliveryStatuses' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/delivery-status' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageDeliveryStatus" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER SentId +ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email + +.PARAMETER Page +Optional page index in delivery status list pagination + +.PARAMETER Size +Optional page size in delivery status list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageDeliveryStatus +#> +function Get-SentDeliveryStatusesBySentId { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SentId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentDeliveryStatusesBySentId' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/{sentId}/delivery-status' + if (!$SentId) { + throw "Error! The required parameter `SentId` missing when calling getSentDeliveryStatusesBySentId." + } + $LocalVarUri = $LocalVarUri.replace('{sentId}', $SentId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageDeliveryStatus" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get sent email receipt + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentEmailDto +#> +function Get-SentEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getSentEmail." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentEmailDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get sent email HTML content + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Get-SentEmailHTMLContent { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentEmailHTMLContent' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('text/html') + + $LocalVarUri = '/sent/{id}/html' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getSentEmailHTMLContent." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get sent email URL for viewing in browser or downloading + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreviewUrls +#> +function Get-SentEmailPreviewURLs { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentEmailPreviewURLs' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/{id}/urls' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getSentEmailPreviewURLs." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreviewUrls" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER Page +Optional page index in sent email tracking pixel list pagination + +.PARAMETER Size +Optional page size in sent email tracking pixel list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageTrackingPixelProjection +#> +function Get-SentEmailTrackingPixels { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentEmailTrackingPixels' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/{id}/tracking-pixels' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getSentEmailTrackingPixels." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageTrackingPixelProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all sent emails in paginated form + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inboxId to filter sender of sent emails by + +.PARAMETER Page +Optional page index in inbox sent email list pagination + +.PARAMETER Size +Optional page size in inbox sent email list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageSentEmailProjection +#> +function Get-SentEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageSentEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get results of email sent with queues in paginated form + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in inbox sent email list pagination + +.PARAMETER Size +Optional page size in inbox sent email list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageSentEmailWithQueueProjection +#> +function Get-SentEmailsWithQueueResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentEmailsWithQueueResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/queue-results' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageSentEmailWithQueueProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Optional inboxId to filter sender of sent emails by + +.PARAMETER Page +Optional page index in sent email list pagination + +.PARAMETER Size +Optional page size in sent email list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageSentEmailProjection +#> +function Get-SentOrganizationEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SentOrganizationEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/organization' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageSentEmailProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER SentId +Optional sent email ID filter + +.PARAMETER InboxId +Optional inbox ID filter + +.PARAMETER Timeout +Optional timeout milliseconds + +.PARAMETER Index +Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +DeliveryStatusDto +#> +function Wait-ForDeliveryStatuses { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SentId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Index}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForDeliveryStatuses' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sent/delivery-status/wait-for' + + if ($SentId) { + $LocalVarQueryParameters['sentId'] = $SentId + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if ($Index) { + $LocalVarQueryParameters['index'] = $Index + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "DeliveryStatusDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/SmsControllerApi.ps1 b/src/maislurp-client-powershell/Api/SmsControllerApi.ps1 new file mode 100644 index 00000000..e1707d5e --- /dev/null +++ b/src/maislurp-client-powershell/Api/SmsControllerApi.ps1 @@ -0,0 +1,682 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Delete SMS message. + +.DESCRIPTION + +No description available. + +.PARAMETER SmsId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteSmsMessage { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteSmsMessage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/sms/{smsId}' + if (!$SmsId) { + throw "Error! The required parameter `SmsId` missing when calling deleteSmsMessage." + } + $LocalVarUri = $LocalVarUri.replace('{smsId}', $SmsId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all SMS messages + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumberId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteSmsMessages { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneNumberId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteSmsMessages' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/sms' + + if ($PhoneNumberId) { + $LocalVarQueryParameters['phoneNumberId'] = $PhoneNumberId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get reply for an SMS message + +.DESCRIPTION + +No description available. + +.PARAMETER SmsId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +ReplyForSms +#> +function Get-ReplyForSmsMessage { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-ReplyForSmsMessage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sms/{smsId}/reply' + if (!$SmsId) { + throw "Error! The required parameter `SmsId` missing when calling getReplyForSmsMessage." + } + $LocalVarUri = $LocalVarUri.replace('{smsId}', $SmsId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "ReplyForSms" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get SMS count + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CountDto +#> +function Get-SmsCount { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SmsCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sms/count' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CountDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. + +.DESCRIPTION + +No description available. + +.PARAMETER SmsId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SmsDto +#> +function Get-SmsMessage { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SmsMessage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sms/{smsId}' + if (!$SmsId) { + throw "Error! The required parameter `SmsId` missing when calling getSmsMessage." + } + $LocalVarUri = $LocalVarUri.replace('{smsId}', $SmsId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SmsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all SMS messages in all phone numbers in paginated form. . + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumber +Optional receiving phone number to filter SMS messages for + +.PARAMETER Page +Optional page index in SMS list pagination + +.PARAMETER Size +Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER UnreadOnly +Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly + +.PARAMETER Since +Optional filter SMSs received after given date time + +.PARAMETER Before +Optional filter SMSs received before given date time + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageSmsProjection +#> +function Get-SmsMessagesPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneNumber}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-SmsMessagesPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sms' + + if ($PhoneNumber) { + $LocalVarQueryParameters['phoneNumber'] = $PhoneNumber + } + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageSmsProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get unread SMS count + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +UnreadCount +#> +function Get-UnreadSmsCount { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-UnreadSmsCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/sms/unreadCount' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "UnreadCount" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send a reply to a received SMS message. Replies are sent from the receiving number. + +.DESCRIPTION + +No description available. + +.PARAMETER SmsId +No description available. + +.PARAMETER SmsReplyOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SentSmsDto +#> +function Invoke-ReplyToSmsMessage { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsReplyOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-ReplyToSmsMessage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/sms/{smsId}/reply' + if (!$SmsId) { + throw "Error! The required parameter `SmsId` missing when calling replyToSmsMessage." + } + $LocalVarUri = $LocalVarUri.replace('{smsId}', $SmsId) + + if (!$SmsReplyOptions) { + throw "Error! The required parameter `SmsReplyOptions` missing when calling replyToSmsMessage." + } + + $LocalVarBodyParameter = $SmsReplyOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SentSmsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/TemplateControllerApi.ps1 b/src/maislurp-client-powershell/Api/TemplateControllerApi.ps1 new file mode 100644 index 00000000..a5c43da4 --- /dev/null +++ b/src/maislurp-client-powershell/Api/TemplateControllerApi.ps1 @@ -0,0 +1,692 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create a Template + +.DESCRIPTION + +No description available. + +.PARAMETER CreateTemplateOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TemplateDto +#> +function New-Template { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateTemplateOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Template' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/templates' + + if (!$CreateTemplateOptions) { + throw "Error! The required parameter `CreateTemplateOptions` missing when calling createTemplate." + } + + $LocalVarBodyParameter = $CreateTemplateOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TemplateDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete email template + +.DESCRIPTION + +No description available. + +.PARAMETER TemplateId +Template ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteTemplate { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TemplateId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteTemplate' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/templates/{templateId}' + if (!$TemplateId) { + throw "Error! The required parameter `TemplateId` missing when calling deleteTemplate." + } + $LocalVarUri = $LocalVarUri.replace('{templateId}', $TemplateId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List templates + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageTemplateProjection +#> +function Get-AllTemplates { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllTemplates' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/templates/paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageTemplateProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get template + +.DESCRIPTION + +No description available. + +.PARAMETER TemplateId +Template ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TemplateDto +#> +function Get-Template { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TemplateId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Template' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/templates/{templateId}' + if (!$TemplateId) { + throw "Error! The required parameter `TemplateId` missing when calling getTemplate." + } + $LocalVarUri = $LocalVarUri.replace('{templateId}', $TemplateId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TemplateDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get template preview HTML + +.DESCRIPTION + +No description available. + +.PARAMETER TemplateId +Template ID + +.PARAMETER ReturnType + +Select the return type (optional): text/html;charset=utf-8, text/html + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Get-TemplatePreviewHtml { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TemplateId}, + [String] + [ValidateSet("text/html;charset=utf-8", "text/html")] + $ReturnType, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TemplatePreviewHtml' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('text/html;charset=utf-8', 'text/html') + + if ($ReturnType) { + # use the return type (MIME) provided by the user + $LocalVarAccepts = @($ReturnType) + } + + $LocalVarUri = '/templates/{templateId}/preview/html' + if (!$TemplateId) { + throw "Error! The required parameter `TemplateId` missing when calling getTemplatePreviewHtml." + } + $LocalVarUri = $LocalVarUri.replace('{templateId}', $TemplateId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get template preview Json + +.DESCRIPTION + +No description available. + +.PARAMETER TemplateId +Template ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TemplatePreview +#> +function Get-TemplatePreviewJson { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TemplateId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TemplatePreviewJson' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/templates/{templateId}/preview/json' + if (!$TemplateId) { + throw "Error! The required parameter `TemplateId` missing when calling getTemplatePreviewJson." + } + $LocalVarUri = $LocalVarUri.replace('{templateId}', $TemplateId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TemplatePreview" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List templates + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TemplateProjection[] +#> +function Get-Templates { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Templates' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/templates' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TemplateProjection[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update template + +.DESCRIPTION + +No description available. + +.PARAMETER TemplateId +Template ID + +.PARAMETER CreateTemplateOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TemplateDto +#> +function Update-Template { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${TemplateId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateTemplateOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-Template' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/templates/{templateId}' + if (!$TemplateId) { + throw "Error! The required parameter `TemplateId` missing when calling updateTemplate." + } + $LocalVarUri = $LocalVarUri.replace('{templateId}', $TemplateId) + + if (!$CreateTemplateOptions) { + throw "Error! The required parameter `CreateTemplateOptions` missing when calling updateTemplate." + } + + $LocalVarBodyParameter = $CreateTemplateOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TemplateDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/ToolsControllerApi.ps1 b/src/maislurp-client-powershell/Api/ToolsControllerApi.ps1 new file mode 100644 index 00000000..969aa119 --- /dev/null +++ b/src/maislurp-client-powershell/Api/ToolsControllerApi.ps1 @@ -0,0 +1,991 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Check email client support for email HTML and CSS features + +.DESCRIPTION + +No description available. + +.PARAMETER CheckEmailFeaturesClientSupportOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CheckEmailFeaturesClientSupportResults +#> +function Invoke-CheckEmailFeaturesClientSupport { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CheckEmailFeaturesClientSupportOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-CheckEmailFeaturesClientSupport' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/check-email-features-client-support' + + if (!$CheckEmailFeaturesClientSupportOptions) { + throw "Error! The required parameter `CheckEmailFeaturesClientSupportOptions` missing when calling checkEmailFeaturesClientSupport." + } + + $LocalVarBodyParameter = $CheckEmailFeaturesClientSupportOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CheckEmailFeaturesClientSupportResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create a new email address using the fake email domains + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +NewFakeEmailAddressResult +#> +function New-NewFakeEmailAddress { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-NewFakeEmailAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/tools/fake-email' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "NewFakeEmailAddressResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create a BIMI record policy + +.DESCRIPTION + +No description available. + +.PARAMETER GenerateBimiRecordOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GenerateBimiRecordResults +#> +function New-BimiRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GenerateBimiRecordOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-BimiRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/generate-bimi-record' + + if (!$GenerateBimiRecordOptions) { + throw "Error! The required parameter `GenerateBimiRecordOptions` missing when calling generateBimiRecord." + } + + $LocalVarBodyParameter = $GenerateBimiRecordOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GenerateBimiRecordResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create a DMARC record policy + +.DESCRIPTION + +No description available. + +.PARAMETER GenerateDmarcRecordOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GenerateDmarcRecordResults +#> +function New-DmarcRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GenerateDmarcRecordOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-DmarcRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/generate-dmarc-record' + + if (!$GenerateDmarcRecordOptions) { + throw "Error! The required parameter `GenerateDmarcRecordOptions` missing when calling generateDmarcRecord." + } + + $LocalVarBodyParameter = $GenerateDmarcRecordOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GenerateDmarcRecordResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create a TLS reporting record policy + +.DESCRIPTION + +No description available. + +.PARAMETER GenerateMtaStsRecordOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GenerateMtaStsRecordResults +#> +function New-MtaStsRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GenerateMtaStsRecordOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-MtaStsRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/generate-mta-sts-record' + + if (!$GenerateMtaStsRecordOptions) { + throw "Error! The required parameter `GenerateMtaStsRecordOptions` missing when calling generateMtaStsRecord." + } + + $LocalVarBodyParameter = $GenerateMtaStsRecordOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GenerateMtaStsRecordResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Create a TLS reporting record policy + +.DESCRIPTION + +No description available. + +.PARAMETER GenerateTlsReportingRecordOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +GenerateTlsReportingRecordResults +#> +function New-TlsReportingRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${GenerateTlsReportingRecordOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-TlsReportingRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/generate-tls-reporting-record' + + if (!$GenerateTlsReportingRecordOptions) { + throw "Error! The required parameter `GenerateTlsReportingRecordOptions` missing when calling generateTlsReportingRecord." + } + + $LocalVarBodyParameter = $GenerateTlsReportingRecordOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "GenerateTlsReportingRecordResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +FakeEmailResult +#> +function Get-FakeEmailById { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-FakeEmailById' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/tools/fake-email' + + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getFakeEmailById." + } + $LocalVarQueryParameters['id'] = $Id + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "FakeEmailResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailAddress +No description available. + +.PARAMETER Page +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +FakeEmailPreview[] +#> +function Get-FakeEmailsForAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-FakeEmailsForAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/tools/fake-emails' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if (!$EmailAddress) { + throw "Error! The required parameter `EmailAddress` missing when calling getFakeEmailsForAddress." + } + $LocalVarQueryParameters['emailAddress'] = $EmailAddress + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "FakeEmailPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Lookup a BIMI record policy + +.DESCRIPTION + +No description available. + +.PARAMETER LookupBimiDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +LookupBimiDomainResults +#> +function Invoke-LookupBimiDomain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${LookupBimiDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-LookupBimiDomain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/lookup-bimi-domain' + + if (!$LookupBimiDomainOptions) { + throw "Error! The required parameter `LookupBimiDomainOptions` missing when calling lookupBimiDomain." + } + + $LocalVarBodyParameter = $LookupBimiDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "LookupBimiDomainResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Lookup a DMARC record policy + +.DESCRIPTION + +No description available. + +.PARAMETER LookupDmarcDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +LookupDmarcDomainResults +#> +function Invoke-LookupDmarcDomain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${LookupDmarcDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-LookupDmarcDomain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/lookup-dmarc-domain' + + if (!$LookupDmarcDomainOptions) { + throw "Error! The required parameter `LookupDmarcDomainOptions` missing when calling lookupDmarcDomain." + } + + $LocalVarBodyParameter = $LookupDmarcDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "LookupDmarcDomainResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Lookup a MTA-STS domain policy + +.DESCRIPTION + +No description available. + +.PARAMETER LookupMtaStsDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +LookupMtaStsDomainResults +#> +function Invoke-LookupMtaStsDomain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${LookupMtaStsDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-LookupMtaStsDomain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/lookup-mta-sts-domain' + + if (!$LookupMtaStsDomainOptions) { + throw "Error! The required parameter `LookupMtaStsDomainOptions` missing when calling lookupMtaStsDomain." + } + + $LocalVarBodyParameter = $LookupMtaStsDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "LookupMtaStsDomainResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Lookup a TLS reporting domain policy + +.DESCRIPTION + +No description available. + +.PARAMETER LookupTlsReportingDomainOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +LookupTlsReportingDomainResults +#> +function Invoke-LookupTlsReportingDomain { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${LookupTlsReportingDomainOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-LookupTlsReportingDomain' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tools/lookup-tls-reporting-domain' + + if (!$LookupTlsReportingDomainOptions) { + throw "Error! The required parameter `LookupTlsReportingDomainOptions` missing when calling lookupTlsReportingDomain." + } + + $LocalVarBodyParameter = $LookupTlsReportingDomainOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "LookupTlsReportingDomainResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/TrackingControllerApi.ps1 b/src/maislurp-client-powershell/Api/TrackingControllerApi.ps1 new file mode 100644 index 00000000..c81dcd29 --- /dev/null +++ b/src/maislurp-client-powershell/Api/TrackingControllerApi.ps1 @@ -0,0 +1,298 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Create tracking pixel + +.DESCRIPTION + +No description available. + +.PARAMETER CreateTrackingPixelOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TrackingPixelDto +#> +function New-TrackingPixel { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateTrackingPixelOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-TrackingPixel' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/tracking/pixels' + + if (!$CreateTrackingPixelOptions) { + throw "Error! The required parameter `CreateTrackingPixelOptions` missing when calling createTrackingPixel." + } + + $LocalVarBodyParameter = $CreateTrackingPixelOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TrackingPixelDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get tracking pixels + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageTrackingPixelProjection +#> +function Get-AllTrackingPixels { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllTrackingPixels' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/tracking/pixels' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageTrackingPixelProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get pixel + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +TrackingPixelDto +#> +function Get-TrackingPixel { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TrackingPixel' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/tracking/pixels/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getTrackingPixel." + } + $LocalVarUri = $LocalVarUri.replace('{id}', $Id) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "TrackingPixelDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/UserControllerApi.ps1 b/src/maislurp-client-powershell/Api/UserControllerApi.ps1 new file mode 100644 index 00000000..1d1285ae --- /dev/null +++ b/src/maislurp-client-powershell/Api/UserControllerApi.ps1 @@ -0,0 +1,166 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Property +JSON property name or dot separated path selector such as `a.b.c` + +.PARAMETER Body +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Get-JsonPropertyAsString { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Property}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[SystemCollectionsHashtable]] + ${Body}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-JsonPropertyAsString' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/user/json/pluck' + + if (!$Property) { + throw "Error! The required parameter `Property` missing when calling getJsonPropertyAsString." + } + $LocalVarQueryParameters['property'] = $Property + + $LocalVarBodyParameter = $Body | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $true + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +UserInfoDto +#> +function Get-UserInfo { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-UserInfo' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/user/info' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "UserInfoDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/WaitForControllerApi.ps1 b/src/maislurp-client-powershell/Api/WaitForControllerApi.ps1 new file mode 100644 index 00000000..e9a714f0 --- /dev/null +++ b/src/maislurp-client-powershell/Api/WaitForControllerApi.ps1 @@ -0,0 +1,1017 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Wait for an email to match the provided filter conditions such as subject contains keyword. + +.DESCRIPTION + +No description available. + +.PARAMETER WaitForConditions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreview[] +#> +function Wait-For { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WaitForConditions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-For' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/waitFor' + + if (!$WaitForConditions) { + throw "Error! The required parameter `WaitForConditions` missing when calling waitFor." + } + + $LocalVarBodyParameter = $WaitForConditions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of the inbox we are fetching emails from + +.PARAMETER Count +Number of emails to wait for. Must be greater that 1 + +.PARAMETER Timeout +Max milliseconds to wait + +.PARAMETER UnreadOnly +Optional filter for unread only + +.PARAMETER Before +Filter for emails that were received before the given timestamp + +.PARAMETER Since +Filter for emails that were received after the given timestamp + +.PARAMETER Sort +Sort direction + +.PARAMETER Delay +Max milliseconds delay between calls + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreview[] +#> +function Wait-ForEmailCount { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int32] + ${Count}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Delay}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForEmailCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/waitForEmailCount' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling waitForEmailCount." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$Count) { + throw "Error! The required parameter `Count` missing when calling waitForEmailCount." + } + $LocalVarQueryParameters['count'] = $Count + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Delay) { + $LocalVarQueryParameters['delay'] = $Delay + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Fetch inbox's latest email or if empty wait for an email to arrive + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of the inbox we are fetching emails from + +.PARAMETER Timeout +Max milliseconds to wait + +.PARAMETER UnreadOnly +Optional filter for unread only. + +.PARAMETER Before +Filter for emails that were before after the given timestamp + +.PARAMETER Since +Filter for emails that were received after the given timestamp + +.PARAMETER Sort +Sort direction + +.PARAMETER Delay +Max milliseconds delay between calls + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Wait-ForLatestEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Delay}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForLatestEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/waitForLatestEmail' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Delay) { + $LocalVarQueryParameters['delay'] = $Delay + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. + +.DESCRIPTION + +No description available. + +.PARAMETER WaitForSingleSmsOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SmsDto +#> +function Wait-ForLatestSms { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WaitForSingleSmsOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForLatestSms' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/waitForLatestSms' + + if (!$WaitForSingleSmsOptions) { + throw "Error! The required parameter `WaitForSingleSmsOptions` missing when calling waitForLatestSms." + } + + $LocalVarBodyParameter = $WaitForSingleSmsOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SmsDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait or return list of emails that match simple matching patterns + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of the inbox we are fetching emails from + +.PARAMETER Count +Number of emails to wait for. Must be greater or equal to 1 + +.PARAMETER MatchOptions +No description available. + +.PARAMETER Before +Filter for emails that were received before the given timestamp + +.PARAMETER Since +Filter for emails that were received after the given timestamp + +.PARAMETER Sort +Sort direction + +.PARAMETER Delay +Max milliseconds delay between calls + +.PARAMETER Timeout +Max milliseconds to wait + +.PARAMETER UnreadOnly +Optional filter for unread only + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +EmailPreview[] +#> +function Wait-ForMatchingEmails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int32] + ${Count}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${MatchOptions}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Delay}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForMatchingEmails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/waitForMatchingEmails' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling waitForMatchingEmails." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if (!$Count) { + throw "Error! The required parameter `Count` missing when calling waitForMatchingEmails." + } + $LocalVarQueryParameters['count'] = $Count + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Delay) { + $LocalVarQueryParameters['delay'] = $Delay + } + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if (!$MatchOptions) { + throw "Error! The required parameter `MatchOptions` missing when calling waitForMatchingEmails." + } + + $LocalVarBodyParameter = $MatchOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "EmailPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for or return the first email that matches provided MatchOptions array + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of the inbox we are matching an email for + +.PARAMETER MatchOptions +No description available. + +.PARAMETER Timeout +Max milliseconds to wait + +.PARAMETER UnreadOnly +Optional filter for unread only + +.PARAMETER Since +Filter for emails that were received after the given timestamp + +.PARAMETER Before +Filter for emails that were received before the given timestamp + +.PARAMETER Sort +Sort direction + +.PARAMETER Delay +Max milliseconds delay between calls + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Wait-ForMatchingFirstEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${MatchOptions}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Delay}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForMatchingFirstEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/waitForMatchingFirstEmail' + + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling waitForMatchingFirstEmail." + } + $LocalVarQueryParameters['inboxId'] = $InboxId + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Delay) { + $LocalVarQueryParameters['delay'] = $Delay + } + + if (!$MatchOptions) { + throw "Error! The required parameter `MatchOptions` missing when calling waitForMatchingFirstEmail." + } + + $LocalVarBodyParameter = $MatchOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +Id of the inbox you are fetching emails from + +.PARAMETER Index +Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 + +.PARAMETER Timeout +Max milliseconds to wait for the nth email if not already present + +.PARAMETER UnreadOnly +Optional filter for unread only + +.PARAMETER Since +Filter for emails that were received after the given timestamp + +.PARAMETER Before +Filter for emails that were received before the given timestamp + +.PARAMETER Sort +Sort direction + +.PARAMETER Delay +Max milliseconds delay between calls + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +Email +#> +function Wait-ForNthEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Index}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Timeout}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int64]] + ${Delay}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForNthEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/waitForNthEmail' + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($Index) { + $LocalVarQueryParameters['index'] = $Index + } + + if ($Timeout) { + $LocalVarQueryParameters['timeout'] = $Timeout + } + + if ($UnreadOnly) { + $LocalVarQueryParameters['unreadOnly'] = $UnreadOnly + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Delay) { + $LocalVarQueryParameters['delay'] = $Delay + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "Email" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for an SMS message to match the provided filter conditions such as body contains keyword. + +.DESCRIPTION + +No description available. + +.PARAMETER WaitForSmsConditions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +SmsPreview[] +#> +function Wait-ForSms { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WaitForSmsConditions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForSms' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/waitForSms' + + if (!$WaitForSmsConditions) { + throw "Error! The required parameter `WaitForSmsConditions` missing when calling waitForSms." + } + + $LocalVarBodyParameter = $WaitForSmsConditions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "SmsPreview[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Api/WebhookControllerApi.ps1 b/src/maislurp-client-powershell/Api/WebhookControllerApi.ps1 new file mode 100644 index 00000000..00b26f1a --- /dev/null +++ b/src/maislurp-client-powershell/Api/WebhookControllerApi.ps1 @@ -0,0 +1,3338 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Attach a WebHook URL to an inbox + +.DESCRIPTION + +No description available. + +.PARAMETER CreateWebhookOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDto +#> +function New-AccountWebhook { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateWebhookOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-AccountWebhook' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/webhooks' + + if (!$CreateWebhookOptions) { + throw "Error! The required parameter `CreateWebhookOptions` missing when calling createAccountWebhook." + } + + $LocalVarBodyParameter = $CreateWebhookOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Attach a WebHook URL to an inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER CreateWebhookOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDto +#> +function New-Webhook { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateWebhookOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-Webhook' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/inboxes/{inboxId}/webhooks' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling createWebhook." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if (!$CreateWebhookOptions) { + throw "Error! The required parameter `CreateWebhookOptions` missing when calling createWebhook." + } + + $LocalVarBodyParameter = $CreateWebhookOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Attach a WebHook URL to a phone number + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumberId +No description available. + +.PARAMETER CreateWebhookOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDto +#> +function New-WebhookForPhoneNumber { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneNumberId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${CreateWebhookOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: New-WebhookForPhoneNumber' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/phone/numbers/{phoneNumberId}/webhooks' + if (!$PhoneNumberId) { + throw "Error! The required parameter `PhoneNumberId` missing when calling createWebhookForPhoneNumber." + } + $LocalVarUri = $LocalVarUri.replace('{phoneNumberId}', $PhoneNumberId) + + if (!$CreateWebhookOptions) { + throw "Error! The required parameter `CreateWebhookOptions` missing when calling createWebhookForPhoneNumber." + } + + $LocalVarBodyParameter = $CreateWebhookOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete all webhooks + +.DESCRIPTION + +No description available. + +.PARAMETER Before +before + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteAllWebhooks { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteAllWebhooks' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/webhooks' + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete and disable a Webhook for an Inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteWebhook { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteWebhook' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/inboxes/{inboxId}/webhooks/{webhookId}' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling deleteWebhook." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling deleteWebhook." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Delete a webhook + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +None +#> +function Invoke-DeleteWebhookById { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-DeleteWebhookById' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + $LocalVarUri = '/webhooks/{webhookId}' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling deleteWebhookById." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List account webhooks Paginated + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size for paginated result list. + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER EventType +Optional event type + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageWebhookProjection +#> +function Get-AllAccountWebhooks { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventType}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllAccountWebhooks' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/account/paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($EventType) { + $LocalVarQueryParameters['eventType'] = $EventType + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageWebhookProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get results for all webhooks + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER UnseenOnly +Filter for unseen exceptions only + +.PARAMETER ResultType +Filter by result type + +.PARAMETER EventName +Filter by event name + +.PARAMETER MinStatusCode +Minimum response status + +.PARAMETER MaxStatusCode +Maximum response status + +.PARAMETER InboxId +Inbox ID + +.PARAMETER SmsId +Sms ID + +.PARAMETER AttachmentId +Attachment ID + +.PARAMETER EmailId +Email ID + +.PARAMETER PhoneId +Phone ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageWebhookResult +#> +function Get-AllWebhookResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnseenOnly}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("BAD_RESPONSE", "EXCEPTION", "SUCCESS", "REDRIVEN")] + [String] + ${ResultType}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${MinStatusCode}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${MaxStatusCode}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsId}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AttachmentId}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllWebhookResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/results' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($UnseenOnly) { + $LocalVarQueryParameters['unseenOnly'] = $UnseenOnly + } + + if ($ResultType) { + $LocalVarQueryParameters['resultType'] = $ResultType + } + + if ($EventName) { + $LocalVarQueryParameters['eventName'] = $EventName + } + + if ($MinStatusCode) { + $LocalVarQueryParameters['minStatusCode'] = $MinStatusCode + } + + if ($MaxStatusCode) { + $LocalVarQueryParameters['maxStatusCode'] = $MaxStatusCode + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($SmsId) { + $LocalVarQueryParameters['smsId'] = $SmsId + } + + if ($AttachmentId) { + $LocalVarQueryParameters['attachmentId'] = $AttachmentId + } + + if ($EmailId) { + $LocalVarQueryParameters['emailId'] = $EmailId + } + + if ($PhoneId) { + $LocalVarQueryParameters['phoneId'] = $PhoneId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageWebhookResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List Webhooks Paginated + +.DESCRIPTION + +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size for paginated result list. + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER InboxId +Filter by inboxId + +.PARAMETER PhoneId +Filter by phoneId + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageWebhookProjection +#> +function Get-AllWebhooks { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneId}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-AllWebhooks' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/paginated' + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($PhoneId) { + $LocalVarQueryParameters['phoneId'] = $PhoneId + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageWebhookProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get paginated webhooks for an Inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageWebhookProjection +#> +function Get-InboxWebhooksPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-InboxWebhooksPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/webhooks/paginated' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getInboxWebhooksPaginated." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageWebhookProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Event +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +JSONSchemaDto +#> +function Get-JsonSchemaForWebhookEvent { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${Event}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-JsonSchemaForWebhookEvent' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/schema' + + if (!$Event) { + throw "Error! The required parameter `Event` missing when calling getJsonSchemaForWebhookEvent." + } + $LocalVarQueryParameters['event'] = $Event + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "JSONSchemaDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +JSONSchemaDto +#> +function Get-JsonSchemaForWebhookPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-JsonSchemaForWebhookPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}/schema' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling getJsonSchemaForWebhookPayload." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "JSONSchemaDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get paginated webhooks for a phone number + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneId +No description available. + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageWebhookProjection +#> +function Get-PhoneNumberWebhooksPaginated { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-PhoneNumberWebhooksPaginated' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/phone/numbers/{phoneId}/webhooks/paginated' + if (!$PhoneId) { + throw "Error! The required parameter `PhoneId` missing when calling getPhoneNumberWebhooksPaginated." + } + $LocalVarUri = $LocalVarUri.replace('{phoneId}', $PhoneId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageWebhookProjection" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER EventName +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AbstractWebhookPayload +#> +function Get-TestWebhookPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test' + + if ($EventName) { + $LocalVarQueryParameters['eventName'] = $EventName + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AbstractWebhookPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookBouncePayload +#> +function Get-TestWebhookPayloadBounce { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadBounce' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/email-bounce-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookBouncePayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookBounceRecipientPayload +#> +function Get-TestWebhookPayloadBounceRecipient { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadBounceRecipient' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/email-bounce-recipient-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookBounceRecipientPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get webhook test payload for delivery status event + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDeliveryStatusPayload +#> +function Get-TestWebhookPayloadDeliveryStatus { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadDeliveryStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/delivery-status-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDeliveryStatusPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookEmailOpenedPayload +#> +function Get-TestWebhookPayloadEmailOpened { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadEmailOpened' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/email-opened-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookEmailOpenedPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookEmailReadPayload +#> +function Get-TestWebhookPayloadEmailRead { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadEmailRead' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/email-read-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookEmailReadPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +AbstractWebhookPayload +#> +function Get-TestWebhookPayloadForWebhook { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadForWebhook' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}/example' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling getTestWebhookPayloadForWebhook." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "AbstractWebhookPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get webhook test payload for new attachment event + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookNewAttachmentPayload +#> +function Get-TestWebhookPayloadNewAttachment { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadNewAttachment' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/new-attachment-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookNewAttachmentPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get webhook test payload for new contact event + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookNewContactPayload +#> +function Get-TestWebhookPayloadNewContact { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadNewContact' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/new-contact-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookNewContactPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get webhook test payload for new email event + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookNewEmailPayload +#> +function Get-TestWebhookPayloadNewEmail { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadNewEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/new-email-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookNewEmailPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get webhook test payload for new sms event + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookNewSmsPayload +#> +function Get-TestWebhookPayloadNewSms { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-TestWebhookPayloadNewSms' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/test/new-sms-payload' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookNewSmsPayload" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a webhook + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDto +#> +function Get-Webhook { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Webhook' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling getWebhook." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a webhook result for a webhook + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookResultId +Webhook Result ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookResultDto +#> +function Get-WebhookResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookResultId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-WebhookResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/results/{webhookResultId}' + if (!$WebhookResultId) { + throw "Error! The required parameter `WebhookResultId` missing when calling getWebhookResult." + } + $LocalVarUri = $LocalVarUri.replace('{webhookResultId}', $WebhookResultId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookResultDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a webhook results for a webhook + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +ID of webhook to get results for + +.PARAMETER Page +Optional page index in list pagination + +.PARAMETER Size +Optional page size in list pagination + +.PARAMETER Sort +Optional createdAt sort direction ASC or DESC + +.PARAMETER SearchFilter +Optional search filter + +.PARAMETER Since +Filter by created at after the given timestamp + +.PARAMETER Before +Filter by created at before the given timestamp + +.PARAMETER UnseenOnly +Filter for unseen exceptions only + +.PARAMETER ResultType +Filter by result type + +.PARAMETER EventName +Filter by event name + +.PARAMETER MinStatusCode +Minimum response status + +.PARAMETER MaxStatusCode +Maximum response status + +.PARAMETER InboxId +Inbox ID + +.PARAMETER SmsId +Sms ID + +.PARAMETER AttachmentId +Attachment ID + +.PARAMETER EmailId +Email ID + +.PARAMETER PhoneId +Phone ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +PageWebhookResult +#> +function Get-WebhookResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Page}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("ASC", "DESC")] + [String] + ${Sort}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${SearchFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${UnseenOnly}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("BAD_RESPONSE", "EXCEPTION", "SUCCESS", "REDRIVEN")] + [String] + ${ResultType}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${MinStatusCode}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${MaxStatusCode}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${SmsId}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${AttachmentId}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${EmailId}, + [Parameter(Position = 16, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${PhoneId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-WebhookResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}/results' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling getWebhookResults." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Page) { + $LocalVarQueryParameters['page'] = $Page + } + + if ($Size) { + $LocalVarQueryParameters['size'] = $Size + } + + if ($Sort) { + $LocalVarQueryParameters['sort'] = $Sort + } + + if ($SearchFilter) { + $LocalVarQueryParameters['searchFilter'] = $SearchFilter + } + + if ($Since) { + $LocalVarQueryParameters['since'] = $Since + } + + if ($Before) { + $LocalVarQueryParameters['before'] = $Before + } + + if ($UnseenOnly) { + $LocalVarQueryParameters['unseenOnly'] = $UnseenOnly + } + + if ($ResultType) { + $LocalVarQueryParameters['resultType'] = $ResultType + } + + if ($EventName) { + $LocalVarQueryParameters['eventName'] = $EventName + } + + if ($MinStatusCode) { + $LocalVarQueryParameters['minStatusCode'] = $MinStatusCode + } + + if ($MaxStatusCode) { + $LocalVarQueryParameters['maxStatusCode'] = $MaxStatusCode + } + + if ($InboxId) { + $LocalVarQueryParameters['inboxId'] = $InboxId + } + + if ($SmsId) { + $LocalVarQueryParameters['smsId'] = $SmsId + } + + if ($AttachmentId) { + $LocalVarQueryParameters['attachmentId'] = $AttachmentId + } + + if ($EmailId) { + $LocalVarQueryParameters['emailId'] = $EmailId + } + + if ($PhoneId) { + $LocalVarQueryParameters['phoneId'] = $PhoneId + } + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "PageWebhookResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a webhook results count for a webhook + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +ID of webhook to get results for + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CountDto +#> +function Get-WebhookResultsCount { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-WebhookResultsCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}/results/count' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling getWebhookResultsCount." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CountDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get count of unseen webhook results with error status + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +UnseenErrorCountDto +#> +function Get-WebhookResultsUnseenErrorCount { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-WebhookResultsUnseenErrorCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/results/unseen-count' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "UnseenErrorCountDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get all webhooks for an Inbox + +.DESCRIPTION + +No description available. + +.PARAMETER InboxId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDto[] +#> +function Get-Webhooks { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${InboxId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-Webhooks' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/inboxes/{inboxId}/webhooks' + if (!$InboxId) { + throw "Error! The required parameter `InboxId` missing when calling getWebhooks." + } + $LocalVarUri = $LocalVarUri.replace('{inboxId}', $InboxId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDto[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Redrive all webhook results that have failed status + +.DESCRIPTION + +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookRedriveAllResult +#> +function Invoke-RedriveAllWebhookResults { + [CmdletBinding()] + Param ( + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-RedriveAllWebhookResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/results/redrive' + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookRedriveAllResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Get a webhook result and try to resend the original webhook payload + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookResultId +Webhook Result ID + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookRedriveResult +#> +function Invoke-RedriveWebhookResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookResultId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Invoke-RedriveWebhookResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/results/{webhookResultId}/redrive' + if (!$WebhookResultId) { + throw "Error! The required parameter `WebhookResultId` missing when calling redriveWebhookResult." + } + $LocalVarUri = $LocalVarUri.replace('{webhookResultId}', $WebhookResultId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookRedriveResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Send webhook test data + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookTestResult +#> +function Send-TestData { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Send-TestData' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}/test' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling sendTestData." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookTestResult" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Update a webhook request headers + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +No description available. + +.PARAMETER WebhookHeaders +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookDto +#> +function Update-WebhookHeaders { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookHeaders}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Update-WebhookHeaders' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/webhooks/{webhookId}/headers' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling updateWebhookHeaders." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if (!$WebhookHeaders) { + throw "Error! The required parameter `WebhookHeaders` missing when calling updateWebhookHeaders." + } + + $LocalVarBodyParameter = $WebhookHeaders | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookDto" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Verify a webhook payload signature + +.DESCRIPTION + +No description available. + +.PARAMETER VerifyWebhookSignatureOptions +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +VerifyWebhookSignatureResults +#> +function Test-WebhookSignature { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${VerifyWebhookSignatureOptions}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-WebhookSignature' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + # HTTP header 'Content-Type' + $LocalVarContentTypes = @('application/json') + + $LocalVarUri = '/webhooks/verify' + + if (!$VerifyWebhookSignatureOptions) { + throw "Error! The required parameter `VerifyWebhookSignatureOptions` missing when calling verifyWebhookSignature." + } + + $LocalVarBodyParameter = $VerifyWebhookSignatureOptions | ConvertTo-Json -Depth 100 + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'POST' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "VerifyWebhookSignatureResults" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Wait for webhook results for a webhook + +.DESCRIPTION + +No description available. + +.PARAMETER WebhookId +ID of webhook to get results for + +.PARAMETER ExpectedCount +Expected result count + +.PARAMETER Timeout +Max time to wait in milliseconds + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +WebhookResultDto[] +#> +function Wait-ForWebhookResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [PSCustomObject] + ${WebhookId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int32] + ${ExpectedCount}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [Int32] + ${Timeout}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Wait-ForWebhookResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('*/*') + + $LocalVarUri = '/webhooks/{webhookId}/wait' + if (!$WebhookId) { + throw "Error! The required parameter `WebhookId` missing when calling waitForWebhookResults." + } + $LocalVarUri = $LocalVarUri.replace('{webhookId}', $WebhookId) + + if (!$ExpectedCount) { + throw "Error! The required parameter `ExpectedCount` missing when calling waitForWebhookResults." + } + $LocalVarQueryParameters['expectedCount'] = $ExpectedCount + + if (!$Timeout) { + throw "Error! The required parameter `Timeout` missing when calling waitForWebhookResults." + } + $LocalVarQueryParameters['timeout'] = $Timeout + + if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["API_KEY"]) { + $LocalVarHeaderParameters['API_KEY'] = $Configuration["ApiKey"]["API_KEY"] + Write-Verbose ("Using API key 'API_KEY' in the header for authentication in {0}" -f $MyInvocation.MyCommand) + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "WebhookResultDto[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + diff --git a/src/maislurp-client-powershell/Client/Configuration.ps1 b/src/maislurp-client-powershell/Client/Configuration.ps1 new file mode 100644 index 00000000..3c77b418 --- /dev/null +++ b/src/maislurp-client-powershell/Client/Configuration.ps1 @@ -0,0 +1,515 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +Get the configuration object 'Configuration'. + +.DESCRIPTION + +Get the configuration object 'Configuration'. + +.OUTPUTS + +System.Collections.Hashtable +#> +function Get-Configuration { + + $Configuration = $Script:Configuration + + if ([string]::IsNullOrEmpty($Configuration["BaseUrl"])) { + $Configuration["BaseUrl"] = "https://api.mailslurp.com"; + } + + if (!$Configuration.containsKey("Username")) { + $Configuration["Username"] = $null + } + if (!$Configuration.containsKey("Password")) { + $Configuration["Password"] = $null + } + if (!$Configuration.containsKey("AccessToken")) { + $Configuration["AccessToken"] = $null + } + if (!$Configuration.containsKey("Cookie")) { + $Configuration["Cookie"] = $null + } + + if (!$Configuration["DefaultHeaders"]) { + $Configuration["DefaultHeaders"] = @{} + } + + if (!$Configuration["ApiKey"]) { + $Configuration["ApiKey"] = @{} + } + + if (!$Configuration["ApiKeyPrefix"]) { + $Configuration["ApiKeyPrefix"] = @{} + } + + if (!$Configuration.containsKey("SkipCertificateCheck")) { + $Configuration["SkipCertificateCheck"] = $false + } + + if (!$Configuration.containsKey("Proxy")) { + $Configuration["Proxy"] = $null + } + + Return $Configuration + +} + +<# +.SYNOPSIS + +Set the configuration. + +.DESCRIPTION + +Set the configuration. + +.PARAMETER BaseUrl +Base URL of the HTTP endpoints + +.PARAMETER Username +Username in HTTP basic authentication + +.PARAMETER Passowrd +Password in HTTP basic authentication + +.PARAMETER ApiKey +API Keys for authentication/authorization + +.PARAMETER ApiKeyPrefix +Prefix in the API Keys + +.PARAMETER Cookie +Cookie for authentication/authorization + +.PARAMETER AccessToken +Access token for authentication/authorization + +.PARAMETER SkipCertificateCheck +Skip certificate verification + +.PARAMETER DefaultHeaders +Default HTTP headers to be included in the HTTP request + +.PARAMETER Proxy +Proxy setting in the HTTP request, e.g. + +$proxy = [System.Net.WebRequest]::GetSystemWebProxy() +$proxy.Credentials = [System.Net.CredentialCache]::DefaultCredentials + +.PARAMETER PassThru +Return an object of the Configuration + +.OUTPUTS + +System.Collections.Hashtable +#> +function Set-Configuration { + + [CmdletBinding()] + Param( + [string]$BaseUrl, + [AllowEmptyString()] + [string]$Username, + [AllowEmptyString()] + [string]$Password, + [hashtable]$ApiKey, + [hashtable]$ApiKeyPrefix, + [AllowEmptyString()] + [string]$Cookie, + [AllowEmptyString()] + [string]$AccessToken, + [switch]$SkipCertificateCheck, + [hashtable]$DefaultHeaders, + [System.Object]$Proxy, + [switch]$PassThru + ) + + Process { + + If ($BaseUrl) { + # validate URL + $URL = $BaseUrl -as [System.URI] + if (!($null -ne $URL.AbsoluteURI -and $URL.Scheme -match '[http|https]')) { + throw "Invalid URL '$($BaseUrl)' cannot be used in the base URL." + } + $Script:Configuration["BaseUrl"] = $BaseUrl + } + + If ($Username) { + $Script:Configuration['Username'] = $Username + } + + If ($Password) { + $Script:Configuration['Password'] = $Password + } + + If ($ApiKey) { + $Script:Configuration['ApiKey'] = $ApiKey + } + + If ($ApiKeyPrefix) { + $Script:Configuration['ApiKeyPrefix'] = $ApiKeyPrefix + } + + If ($Cookie) { + $Script:Configuration['Cookie'] = $Cookie + } + + If ($AccessToken) { + $Script:Configuration['AccessToken'] = $AccessToken + } + + If ($SkipCertificateCheck.IsPresent) { + $Script:Configuration['SkipCertificateCheck'] = $true + } else { + $Script:Configuration['SkipCertificateCheck'] = $false + } + + If ($DefaultHeaders) { + $Script:Configuration['DefaultHeaders'] = $DefaultHeaders + } + + If ($Proxy -ne $null) { + If ($Proxy.GetType().FullName -ne "System.Net.SystemWebProxy" -and $Proxy.GetType().FullName -ne "System.Net.WebRequest+WebProxyWrapperOpaque") { + throw "Incorrect Proxy type '$($Proxy.GetType().FullName)'. Must be System.Net.SystemWebProxy or System.Net.WebRequest+WebProxyWrapperOpaque." + } + $Script:Configuration['Proxy'] = $Proxy + } else { + $Script:Configuration['Proxy'] = $null + } + + If ($PassThru.IsPresent) { + $Script:Configuration + } + } +} + +<# +.SYNOPSIS + +Set the API Key. + +.DESCRIPTION + +Set the API Key. + +.PARAMETER Id +ID of the security schema + +.PARAMETER ApiKey +API Key + +.OUTPUTS + +None +#> +function Set-ConfigurationApiKey { + [CmdletBinding()] + Param( + [string]$Id, + [AllowEmptyString()] + [string]$ApiKey + ) + Process { + if (!$Script:Configuration["ApiKey"]) { + $Script:Configuration["ApiKey"] = @{} + } + $Script:Configuration["ApiKey"][$Id] = $ApiKey + } +} + +<# +.SYNOPSIS + +Set the API Key prefix. + +.DESCRIPTION + +Set the API Key prefix. + +.PARAMETER Id +ID of the security schema + +.PARAMETER ApiKey +API Key prefix + +.OUTPUTS + +None +#> +function Set-ConfigurationApiKeyPrefix { + [CmdletBinding()] + Param( + [string]$Id, + [AllowEmptyString()] + [string]$ApiKeyPrefix + ) + Process { + if (!$Script:Configuration["ApiKeyPrefix"]) { + $Script:Configuration["ApiKeyPrefix"] = @{} + } + $Script:Configuration["ApiKeyPrefix"][$Id] = $ApiKeyPrefix + } +} + +<# +.SYNOPSIS + +Set the default header. + +.DESCRIPTION + +Set the default header. + +.PARAMETER Key +Key of the HTTP header + +.PARAMETER Value +Value of the HTTP header + +.OUTPUTS + +None +#> +function Set-ConfigurationDefaultHeader { + [CmdletBinding()] + Param( + [string]$Key, + [AllowEmptyString()] + [string]$Value + ) + Process { + if (!$Script:Configuration["DefaultHeaders"]) { + $Script:Configuration["DefaultHeaders"] = @{} + } + $Script:Configuration["DefaultHeaders"][$Key] = $Value + } +} + + +<# +.SYNOPSIS + +Get the host setting. + +.DESCRIPTION + +Get the host setting in the form of array of hashtables. + +.OUTPUTS + +System.Collections.Hashtable[] +#> +function Get-HostSetting { + return ,@( + @{ + "Url" = "https://api.mailslurp.com"; + "Description" = "MailSlurp API Server"; + } + ) + +} + +<# +.SYNOPSIS + +Get the URL from the host settings. + +.PARAMETER Index +Index of the host settings (array) + +.PARAMETER Variables +Names and values of the variables (hashtable) + +.DESCRIPTION + +Get the URL from the host settings. + +.OUTPUTS + +String +#> +function Get-UrlFromHostSetting { + + [CmdletBinding()] + Param( + [Parameter(ValueFromPipeline = $true)] + [Int]$Index, + [Hashtable]$Variables = @{} + ) + + Process { + $Hosts = Get-HostSetting + + # check array index out of bound + if ($Index -lt 0 -or $Index -ge $Hosts.Length) { + throw "Invalid index $index when selecting the host. Must be less than $($Hosts.Length)" + } + + $MyHost = $Hosts[$Index]; + $Url = $MyHost["Url"]; + + # go through variable and assign a value + foreach ($h in $MyHost["Variables"].GetEnumerator()) { + if ($Variables.containsKey($h.Name)) { # check to see if it's in the variables provided by the user + if ($h.Value["EnumValues"] -Contains $Variables[$h.Name]) { + $Url = $Url.replace("{$($h.Name)}", $Variables[$h.Name]) + } else { + throw "The variable '$($h.Name)' in the host URL has invalid value $($Variables[$h.Name]). Must be $($h.Value["EnumValues"] -join ",")" + } + } else { + $Url = $Url.replace("{$($h.Name)}", $h.Value["DefaultValue"]) + } + } + + return $Url; + + } +} + +<# +.SYNOPSIS +Sets the configuration for http signing. +.DESCRIPTION + +Sets the configuration for the HTTP signature security scheme. +The HTTP signature security scheme is used to sign HTTP requests with a key +which is in possession of the API client. +An 'Authorization' header is calculated by creating a hash of select headers, +and optionally the body of the HTTP request, then signing the hash value using +a key. The 'Authorization' header is added to outbound HTTP requests. + +Ref: https://openapi-generator.tech + +.PARAMETER KeyId +KeyId for HTTP signing + +.PARAMETER KeyFilePath +KeyFilePath for HTTP signing + +.PARAMETER KeyPassPhrase +KeyPassPhrase, if the HTTP signing key is protected + +.PARAMETER HttpSigningHeader +HttpSigningHeader list of HTTP headers used to calculate the signature. The two special signature headers '(request-target)' and '(created)' +SHOULD be included. + The '(created)' header expresses when the signature was created. + The '(request-target)' header is a concatenation of the lowercased :method, an + ASCII space, and the :path pseudo-headers. +If no headers are specified then '(created)' sets as default. + +.PARAMETER HashAlgorithm +HashAlgrithm to calculate the hash, Supported values are "sha256" and "sha512" + +.PARAMETER SigningAlgorithm +SigningAlgorithm specifies the signature algorithm, supported values are "RSASSA-PKCS1-v1_5" and "RSASSA-PSS" +RSA key : Supported values "RSASSA-PKCS1-v1_5" and "RSASSA-PSS", for ECDSA key this parameter is not applicable + +.PARAMETER SignatureValidityPeriod +SignatureValidityPeriod specifies the signature maximum validity time in seconds. It accepts integer value + +.OUTPUTS + +System.Collections.Hashtable +#> +function Set-ConfigurationHttpSigning { + [CmdletBinding()] + param( + [Parameter(Mandatory = $true)] + [ValidateNotNullOrEmpty()] + [string]$KeyId, + [Parameter(Mandatory = $true)] + [string]$KeyFilePath, + [Parameter(Mandatory = $false)] + [securestring]$KeyPassPhrase, + [Parameter(Mandatory = $false)] + [ValidateNotNullOrEmpty()] + [string[]] $HttpSigningHeader = @("(created)"), + [Parameter(Mandatory = $false)] + [ValidateSet("sha256", "sha512")] + [string] $HashAlgorithm = "sha256", + [Parameter(Mandatory = $false)] + [ValidateSet("RSASSA-PKCS1-v1_5", "RSASSA-PSS")] + [string]$SigningAlgorithm , + [Parameter(Mandatory = $false)] + [int]$SignatureValidityPeriod + ) + + Process { + $httpSignatureConfiguration = @{ } + + if (Test-Path -Path $KeyFilePath) { + $httpSignatureConfiguration["KeyId"] = $KeyId + $httpSignatureConfiguration["KeyFilePath"] = $KeyFilePath + } + else { + throw "Private key file path does not exist" + } + + $keyType = Get-KeyTypeFromFile -KeyFilePath $KeyFilePath + if ([String]::IsNullOrEmpty($SigningAlgorithm)) { + if ($keyType -eq "RSA") { + $SigningAlgorithm = "RSASSA-PKCS1-v1_5" + } + } + + if ($keyType -eq "RSA" -and + ($SigningAlgorithm -ne "RSASSA-PKCS1-v1_5" -and $SigningAlgorithm -ne "RSASSA-PSS" )) { + throw "Provided Key and SigningAlgorithm : $SigningAlgorithm is not compatible." + } + + if ($HttpSigningHeader -contains "(expires)" -and $SignatureValidityPeriod -le 0) { + throw "SignatureValidityPeriod must be greater than 0 seconds." + } + + if ($HttpSigningHeader -contains "(expires)") { + $httpSignatureConfiguration["SignatureValidityPeriod"] = $SignatureValidityPeriod + } + if ($null -ne $HttpSigningHeader -and $HttpSigningHeader.Length -gt 0) { + $httpSignatureConfiguration["HttpSigningHeader"] = $HttpSigningHeader + } + + if ($null -ne $HashAlgorithm ) { + $httpSignatureConfiguration["HashAlgorithm"] = $HashAlgorithm + } + + if ($null -ne $SigningAlgorithm) { + $httpSignatureConfiguration["SigningAlgorithm"] = $SigningAlgorithm + } + + if ($null -ne $KeyPassPhrase) { + $httpSignatureConfiguration["KeyPassPhrase"] = $KeyPassPhrase + } + + $Script:Configuration["HttpSigning"] = New-Object -TypeName PSCustomObject -Property $httpSignatureConfiguration + } +} + +<# +.SYNOPSIS + +Get the configuration object 'ConfigurationHttpSigning'. + +.DESCRIPTION + +Get the configuration object 'ConfigurationHttpSigning'. + +.OUTPUTS + +[PSCustomObject] +#> +function Get-ConfigurationHttpSigning{ + + $httpSignatureConfiguration = $Script:Configuration["HttpSigning"] + return $httpSignatureConfiguration +} diff --git a/src/maislurp-client-powershell/Model/AbstractWebhookPayload.ps1 b/src/maislurp-client-powershell/Model/AbstractWebhookPayload.ps1 new file mode 100644 index 00000000..3a05be89 --- /dev/null +++ b/src/maislurp-client-powershell/Model/AbstractWebhookPayload.ps1 @@ -0,0 +1,154 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT`, `NEW_ATTACHMENT` and `EMAIL_OPENED` payloads for the properties available for those events. + +.PARAMETER EventName +No description available. +.PARAMETER MessageId +No description available. +.PARAMETER WebhookId +No description available. +.PARAMETER WebhookName +No description available. +.OUTPUTS + +AbstractWebhookPayload +#> + +function Initialize-AbstractWebhookPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AbstractWebhookPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "eventName" = ${EventName} + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "webhookName" = ${WebhookName} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AbstractWebhookPayload + +.DESCRIPTION + +Convert from JSON to AbstractWebhookPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +AbstractWebhookPayload +#> +function ConvertFrom-JsonToAbstractWebhookPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AbstractWebhookPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AbstractWebhookPayload + $AllProperties = ("eventName", "messageId", "webhookId", "webhookName") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'eventName' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + $PSO = [PSCustomObject]@{ + "eventName" = ${EventName} + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "webhookName" = ${WebhookName} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/AccountBounceBlockDto.ps1 b/src/maislurp-client-powershell/Model/AccountBounceBlockDto.ps1 new file mode 100644 index 00000000..c5f6370c --- /dev/null +++ b/src/maislurp-client-powershell/Model/AccountBounceBlockDto.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER IsSendingBlocked +No description available. +.PARAMETER BounceCount +No description available. +.PARAMETER BounceCountToday +No description available. +.PARAMETER MaximumDailyBounces +No description available. +.PARAMETER MaximumAccountBounces +No description available. +.OUTPUTS + +AccountBounceBlockDto +#> + +function Initialize-AccountBounceBlockDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsSendingBlocked}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${BounceCount}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${BounceCountToday}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${MaximumDailyBounces}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${MaximumAccountBounces} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AccountBounceBlockDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($IsSendingBlocked -eq $null) { + throw "invalid value for 'IsSendingBlocked', 'IsSendingBlocked' cannot be null." + } + + if ($BounceCount -eq $null) { + throw "invalid value for 'BounceCount', 'BounceCount' cannot be null." + } + + if ($BounceCountToday -eq $null) { + throw "invalid value for 'BounceCountToday', 'BounceCountToday' cannot be null." + } + + if ($MaximumDailyBounces -eq $null) { + throw "invalid value for 'MaximumDailyBounces', 'MaximumDailyBounces' cannot be null." + } + + if ($MaximumAccountBounces -eq $null) { + throw "invalid value for 'MaximumAccountBounces', 'MaximumAccountBounces' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "isSendingBlocked" = ${IsSendingBlocked} + "bounceCount" = ${BounceCount} + "bounceCountToday" = ${BounceCountToday} + "maximumDailyBounces" = ${MaximumDailyBounces} + "maximumAccountBounces" = ${MaximumAccountBounces} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AccountBounceBlockDto + +.DESCRIPTION + +Convert from JSON to AccountBounceBlockDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +AccountBounceBlockDto +#> +function ConvertFrom-JsonToAccountBounceBlockDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AccountBounceBlockDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AccountBounceBlockDto + $AllProperties = ("isSendingBlocked", "bounceCount", "bounceCountToday", "maximumDailyBounces", "maximumAccountBounces") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'isSendingBlocked' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isSendingBlocked"))) { + throw "Error! JSON cannot be serialized due to the required property 'isSendingBlocked' missing." + } else { + $IsSendingBlocked = $JsonParameters.PSobject.Properties["isSendingBlocked"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceCount"))) { + throw "Error! JSON cannot be serialized due to the required property 'bounceCount' missing." + } else { + $BounceCount = $JsonParameters.PSobject.Properties["bounceCount"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceCountToday"))) { + throw "Error! JSON cannot be serialized due to the required property 'bounceCountToday' missing." + } else { + $BounceCountToday = $JsonParameters.PSobject.Properties["bounceCountToday"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "maximumDailyBounces"))) { + throw "Error! JSON cannot be serialized due to the required property 'maximumDailyBounces' missing." + } else { + $MaximumDailyBounces = $JsonParameters.PSobject.Properties["maximumDailyBounces"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "maximumAccountBounces"))) { + throw "Error! JSON cannot be serialized due to the required property 'maximumAccountBounces' missing." + } else { + $MaximumAccountBounces = $JsonParameters.PSobject.Properties["maximumAccountBounces"].value + } + + $PSO = [PSCustomObject]@{ + "isSendingBlocked" = ${IsSendingBlocked} + "bounceCount" = ${BounceCount} + "bounceCountToday" = ${BounceCountToday} + "maximumDailyBounces" = ${MaximumDailyBounces} + "maximumAccountBounces" = ${MaximumAccountBounces} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/AliasDto.ps1 b/src/maislurp-client-powershell/Model/AliasDto.ps1 new file mode 100644 index 00000000..cc830dcb --- /dev/null +++ b/src/maislurp-client-powershell/Model/AliasDto.ps1 @@ -0,0 +1,252 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email alias representation + +.PARAMETER Id +No description available. +.PARAMETER EmailAddress +The alias's email address for receiving email +.PARAMETER MaskedEmailAddress +The underlying email address that is hidden and will received forwarded email +.PARAMETER UserId +No description available. +.PARAMETER InboxId +Inbox that is associated with the alias +.PARAMETER Name +No description available. +.PARAMETER UseThreads +If alias will generate response threads or not when email are received by it +.PARAMETER IsVerified +Has the alias been verified. You must verify an alias if the masked email address has not yet been verified by your account +.PARAMETER DomainId +Domain ID associated with the alias +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +AliasDto +#> + +function Initialize-AliasDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${MaskedEmailAddress}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseThreads}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsVerified}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${CreatedAt}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AliasDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($IsVerified -eq $null) { + throw "invalid value for 'IsVerified', 'IsVerified' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "maskedEmailAddress" = ${MaskedEmailAddress} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "name" = ${Name} + "useThreads" = ${UseThreads} + "isVerified" = ${IsVerified} + "domainId" = ${DomainId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AliasDto + +.DESCRIPTION + +Convert from JSON to AliasDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +AliasDto +#> +function ConvertFrom-JsonToAliasDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AliasDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AliasDto + $AllProperties = ("id", "emailAddress", "maskedEmailAddress", "userId", "inboxId", "name", "useThreads", "isVerified", "domainId", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isVerified"))) { + throw "Error! JSON cannot be serialized due to the required property 'isVerified' missing." + } else { + $IsVerified = $JsonParameters.PSobject.Properties["isVerified"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "maskedEmailAddress"))) { #optional property not found + $MaskedEmailAddress = $null + } else { + $MaskedEmailAddress = $JsonParameters.PSobject.Properties["maskedEmailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useThreads"))) { #optional property not found + $UseThreads = $null + } else { + $UseThreads = $JsonParameters.PSobject.Properties["useThreads"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { #optional property not found + $CreatedAt = $null + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { #optional property not found + $UpdatedAt = $null + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "maskedEmailAddress" = ${MaskedEmailAddress} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "name" = ${Name} + "useThreads" = ${UseThreads} + "isVerified" = ${IsVerified} + "domainId" = ${DomainId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/AliasProjection.ps1 b/src/maislurp-client-powershell/Model/AliasProjection.ps1 new file mode 100644 index 00000000..e99b61af --- /dev/null +++ b/src/maislurp-client-powershell/Model/AliasProjection.ps1 @@ -0,0 +1,217 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Representation of a alias + +.PARAMETER EmailAddress +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER UseThreads +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +AliasProjection +#> + +function Initialize-AliasProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseThreads}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AliasProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "useThreads" = ${UseThreads} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AliasProjection + +.DESCRIPTION + +Convert from JSON to AliasProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +AliasProjection +#> +function ConvertFrom-JsonToAliasProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AliasProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AliasProjection + $AllProperties = ("emailAddress", "inboxId", "userId", "useThreads", "createdAt", "updatedAt", "name", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddress' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useThreads"))) { #optional property not found + $UseThreads = $null + } else { + $UseThreads = $JsonParameters.PSobject.Properties["useThreads"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "useThreads" = ${UseThreads} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/AttachmentEntity.ps1 b/src/maislurp-client-powershell/Model/AttachmentEntity.ps1 new file mode 100644 index 00000000..c67b5f34 --- /dev/null +++ b/src/maislurp-client-powershell/Model/AttachmentEntity.ps1 @@ -0,0 +1,248 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER AttachmentId +No description available. +.PARAMETER Bucket +No description available. +.PARAMETER UserId +No description available. +.PARAMETER ContentType +No description available. +.PARAMETER ContentLength +No description available. +.PARAMETER ContentId +No description available. +.PARAMETER Name +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +AttachmentEntity +#> + +function Initialize-AttachmentEntity { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${AttachmentId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Bucket}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${ContentLength}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentId}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AttachmentEntity' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($AttachmentId -eq $null) { + throw "invalid value for 'AttachmentId', 'AttachmentId' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "attachmentId" = ${AttachmentId} + "bucket" = ${Bucket} + "userId" = ${UserId} + "contentType" = ${ContentType} + "contentLength" = ${ContentLength} + "contentId" = ${ContentId} + "name" = ${Name} + "inboxId" = ${InboxId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AttachmentEntity + +.DESCRIPTION + +Convert from JSON to AttachmentEntity + +.PARAMETER Json + +Json object + +.OUTPUTS + +AttachmentEntity +#> +function ConvertFrom-JsonToAttachmentEntity { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AttachmentEntity' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AttachmentEntity + $AllProperties = ("id", "attachmentId", "bucket", "userId", "contentType", "contentLength", "contentId", "name", "inboxId", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'attachmentId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachmentId"))) { + throw "Error! JSON cannot be serialized due to the required property 'attachmentId' missing." + } else { + $AttachmentId = $JsonParameters.PSobject.Properties["attachmentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bucket"))) { #optional property not found + $Bucket = $null + } else { + $Bucket = $JsonParameters.PSobject.Properties["bucket"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { #optional property not found + $ContentType = $null + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentLength"))) { #optional property not found + $ContentLength = $null + } else { + $ContentLength = $JsonParameters.PSobject.Properties["contentLength"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentId"))) { #optional property not found + $ContentId = $null + } else { + $ContentId = $JsonParameters.PSobject.Properties["contentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "attachmentId" = ${AttachmentId} + "bucket" = ${Bucket} + "userId" = ${UserId} + "contentType" = ${ContentType} + "contentLength" = ${ContentLength} + "contentId" = ${ContentId} + "name" = ${Name} + "inboxId" = ${InboxId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/AttachmentMetaData.ps1 b/src/maislurp-client-powershell/Model/AttachmentMetaData.ps1 new file mode 100644 index 00000000..1ba4b43d --- /dev/null +++ b/src/maislurp-client-powershell/Model/AttachmentMetaData.ps1 @@ -0,0 +1,170 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Meta data associated with an attachment. Attachments are stored as byte blobs so the meta data is stored separately. + +.PARAMETER Name +Name of attachment if given +.PARAMETER ContentType +Content type of attachment such as `image/png` +.PARAMETER ContentLength +Size of attachment in bytes +.PARAMETER Id +ID of attachment. Can be used to with attachment controller endpoints to download attachment or with sending methods to attach to an email. +.PARAMETER ContentId +CID of attachment +.OUTPUTS + +AttachmentMetaData +#> + +function Initialize-AttachmentMetaData { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${ContentLength}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentId} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AttachmentMetaData' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($ContentType -eq $null) { + throw "invalid value for 'ContentType', 'ContentType' cannot be null." + } + + if ($ContentLength -eq $null) { + throw "invalid value for 'ContentLength', 'ContentLength' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "contentType" = ${ContentType} + "contentLength" = ${ContentLength} + "id" = ${Id} + "contentId" = ${ContentId} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AttachmentMetaData + +.DESCRIPTION + +Convert from JSON to AttachmentMetaData + +.PARAMETER Json + +Json object + +.OUTPUTS + +AttachmentMetaData +#> +function ConvertFrom-JsonToAttachmentMetaData { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AttachmentMetaData' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AttachmentMetaData + $AllProperties = ("name", "contentType", "contentLength", "id", "contentId") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentType' missing." + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentLength"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentLength' missing." + } else { + $ContentLength = $JsonParameters.PSobject.Properties["contentLength"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentId"))) { #optional property not found + $ContentId = $null + } else { + $ContentId = $JsonParameters.PSobject.Properties["contentId"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "contentType" = ${ContentType} + "contentLength" = ${ContentLength} + "id" = ${Id} + "contentId" = ${ContentId} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/AttachmentProjection.ps1 b/src/maislurp-client-powershell/Model/AttachmentProjection.ps1 new file mode 100644 index 00000000..7bbc0d8d --- /dev/null +++ b/src/maislurp-client-powershell/Model/AttachmentProjection.ps1 @@ -0,0 +1,209 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email attachment data + +.PARAMETER UserId +No description available. +.PARAMETER ContentId +Content ID of attachment. +.PARAMETER AttachmentId +Attachment ID +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER ContentLength +Content length of attachment in bytes +.PARAMETER ContentType +Content type of attachment. +.OUTPUTS + +AttachmentProjection +#> + +function Initialize-AttachmentProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${AttachmentId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${ContentLength}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => AttachmentProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($AttachmentId -eq $null) { + throw "invalid value for 'AttachmentId', 'AttachmentId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "contentId" = ${ContentId} + "attachmentId" = ${AttachmentId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "contentLength" = ${ContentLength} + "contentType" = ${ContentType} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to AttachmentProjection + +.DESCRIPTION + +Convert from JSON to AttachmentProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +AttachmentProjection +#> +function ConvertFrom-JsonToAttachmentProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => AttachmentProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in AttachmentProjection + $AllProperties = ("userId", "contentId", "attachmentId", "createdAt", "updatedAt", "name", "contentLength", "contentType") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'userId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachmentId"))) { + throw "Error! JSON cannot be serialized due to the required property 'attachmentId' missing." + } else { + $AttachmentId = $JsonParameters.PSobject.Properties["attachmentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentId"))) { #optional property not found + $ContentId = $null + } else { + $ContentId = $JsonParameters.PSobject.Properties["contentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentLength"))) { #optional property not found + $ContentLength = $null + } else { + $ContentLength = $JsonParameters.PSobject.Properties["contentLength"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { #optional property not found + $ContentType = $null + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "contentId" = ${ContentId} + "attachmentId" = ${AttachmentId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "contentLength" = ${ContentLength} + "contentType" = ${ContentType} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/BasicAuthOptions.ps1 b/src/maislurp-client-powershell/Model/BasicAuthOptions.ps1 new file mode 100644 index 00000000..fc884b71 --- /dev/null +++ b/src/maislurp-client-powershell/Model/BasicAuthOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Basic Authentication options for webhooks. Will be used is present when calling webhook endpoints. + +.PARAMETER Username +No description available. +.PARAMETER Password +No description available. +.OUTPUTS + +BasicAuthOptions +#> + +function Initialize-BasicAuthOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Username}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Password} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => BasicAuthOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Username -eq $null) { + throw "invalid value for 'Username', 'Username' cannot be null." + } + + if ($Password -eq $null) { + throw "invalid value for 'Password', 'Password' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "username" = ${Username} + "password" = ${Password} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to BasicAuthOptions + +.DESCRIPTION + +Convert from JSON to BasicAuthOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +BasicAuthOptions +#> +function ConvertFrom-JsonToBasicAuthOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => BasicAuthOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in BasicAuthOptions + $AllProperties = ("username", "password") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'username' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "username"))) { + throw "Error! JSON cannot be serialized due to the required property 'username' missing." + } else { + $Username = $JsonParameters.PSobject.Properties["username"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "password"))) { + throw "Error! JSON cannot be serialized due to the required property 'password' missing." + } else { + $Password = $JsonParameters.PSobject.Properties["password"].value + } + + $PSO = [PSCustomObject]@{ + "username" = ${Username} + "password" = ${Password} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/BounceProjection.ps1 b/src/maislurp-client-powershell/Model/BounceProjection.ps1 new file mode 100644 index 00000000..65562c7d --- /dev/null +++ b/src/maislurp-client-powershell/Model/BounceProjection.ps1 @@ -0,0 +1,175 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Bounced email event + +.PARAMETER VarSender +No description available. +.PARAMETER BounceMta +No description available. +.PARAMETER BounceType +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +BounceProjection +#> + +function Initialize-BounceProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarSender}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceMta}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceType}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => BounceProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarSender -eq $null) { + throw "invalid value for 'VarSender', 'VarSender' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "sender" = ${VarSender} + "bounceMta" = ${BounceMta} + "bounceType" = ${BounceType} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to BounceProjection + +.DESCRIPTION + +Convert from JSON to BounceProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +BounceProjection +#> +function ConvertFrom-JsonToBounceProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => BounceProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in BounceProjection + $AllProperties = ("sender", "bounceMta", "bounceType", "createdAt", "subject", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'sender' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sender"))) { + throw "Error! JSON cannot be serialized due to the required property 'sender' missing." + } else { + $VarSender = $JsonParameters.PSobject.Properties["sender"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceMta"))) { #optional property not found + $BounceMta = $null + } else { + $BounceMta = $JsonParameters.PSobject.Properties["bounceMta"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceType"))) { #optional property not found + $BounceType = $null + } else { + $BounceType = $JsonParameters.PSobject.Properties["bounceType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "sender" = ${VarSender} + "bounceMta" = ${BounceMta} + "bounceType" = ${BounceType} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/BounceRecipientProjection.ps1 b/src/maislurp-client-powershell/Model/BounceRecipientProjection.ps1 new file mode 100644 index 00000000..f8366312 --- /dev/null +++ b/src/maislurp-client-powershell/Model/BounceRecipientProjection.ps1 @@ -0,0 +1,188 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Bounced recipient + +.PARAMETER SentEmailId +No description available. +.PARAMETER Recipient +No description available. +.PARAMETER Action +No description available. +.PARAMETER BounceType +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.PARAMETER Status +No description available. +.OUTPUTS + +BounceRecipientProjection +#> + +function Initialize-BounceRecipientProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentEmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Action}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceType}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Status} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => BounceRecipientProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Recipient -eq $null) { + throw "invalid value for 'Recipient', 'Recipient' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "action" = ${Action} + "bounceType" = ${BounceType} + "createdAt" = ${CreatedAt} + "id" = ${Id} + "status" = ${Status} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to BounceRecipientProjection + +.DESCRIPTION + +Convert from JSON to BounceRecipientProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +BounceRecipientProjection +#> +function ConvertFrom-JsonToBounceRecipientProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => BounceRecipientProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in BounceRecipientProjection + $AllProperties = ("sentEmailId", "recipient", "action", "bounceType", "createdAt", "id", "status") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'recipient' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { + throw "Error! JSON cannot be serialized due to the required property 'recipient' missing." + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentEmailId"))) { #optional property not found + $SentEmailId = $null + } else { + $SentEmailId = $JsonParameters.PSobject.Properties["sentEmailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "action"))) { #optional property not found + $Action = $null + } else { + $Action = $JsonParameters.PSobject.Properties["action"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceType"))) { #optional property not found + $BounceType = $null + } else { + $BounceType = $JsonParameters.PSobject.Properties["bounceType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { #optional property not found + $Status = $null + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + $PSO = [PSCustomObject]@{ + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "action" = ${Action} + "bounceType" = ${BounceType} + "createdAt" = ${CreatedAt} + "id" = ${Id} + "status" = ${Status} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/BouncedEmailDto.ps1 b/src/maislurp-client-powershell/Model/BouncedEmailDto.ps1 new file mode 100644 index 00000000..890eea06 --- /dev/null +++ b/src/maislurp-client-powershell/Model/BouncedEmailDto.ps1 @@ -0,0 +1,265 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Bounced email + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER NotificationType +No description available. +.PARAMETER SentToRecipients +No description available. +.PARAMETER VarSender +No description available. +.PARAMETER BounceMta +No description available. +.PARAMETER BounceType +No description available. +.PARAMETER BounceRecipients +No description available. +.PARAMETER BounceSubType +No description available. +.PARAMETER SentEmailId +No description available. +.PARAMETER Subject +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +BouncedEmailDto +#> + +function Initialize-BouncedEmailDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${NotificationType}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${SentToRecipients}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarSender}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceMta}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceType}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${BounceRecipients}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceSubType}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentEmailId}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => BouncedEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($NotificationType -eq $null) { + throw "invalid value for 'NotificationType', 'NotificationType' cannot be null." + } + + if ($VarSender -eq $null) { + throw "invalid value for 'VarSender', 'VarSender' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "notificationType" = ${NotificationType} + "sentToRecipients" = ${SentToRecipients} + "sender" = ${VarSender} + "bounceMta" = ${BounceMta} + "bounceType" = ${BounceType} + "bounceRecipients" = ${BounceRecipients} + "bounceSubType" = ${BounceSubType} + "sentEmailId" = ${SentEmailId} + "subject" = ${Subject} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to BouncedEmailDto + +.DESCRIPTION + +Convert from JSON to BouncedEmailDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +BouncedEmailDto +#> +function ConvertFrom-JsonToBouncedEmailDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => BouncedEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in BouncedEmailDto + $AllProperties = ("id", "userId", "notificationType", "sentToRecipients", "sender", "bounceMta", "bounceType", "bounceRecipients", "bounceSubType", "sentEmailId", "subject", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "notificationType"))) { + throw "Error! JSON cannot be serialized due to the required property 'notificationType' missing." + } else { + $NotificationType = $JsonParameters.PSobject.Properties["notificationType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sender"))) { + throw "Error! JSON cannot be serialized due to the required property 'sender' missing." + } else { + $VarSender = $JsonParameters.PSobject.Properties["sender"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentToRecipients"))) { #optional property not found + $SentToRecipients = $null + } else { + $SentToRecipients = $JsonParameters.PSobject.Properties["sentToRecipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceMta"))) { #optional property not found + $BounceMta = $null + } else { + $BounceMta = $JsonParameters.PSobject.Properties["bounceMta"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceType"))) { #optional property not found + $BounceType = $null + } else { + $BounceType = $JsonParameters.PSobject.Properties["bounceType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceRecipients"))) { #optional property not found + $BounceRecipients = $null + } else { + $BounceRecipients = $JsonParameters.PSobject.Properties["bounceRecipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceSubType"))) { #optional property not found + $BounceSubType = $null + } else { + $BounceSubType = $JsonParameters.PSobject.Properties["bounceSubType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentEmailId"))) { #optional property not found + $SentEmailId = $null + } else { + $SentEmailId = $JsonParameters.PSobject.Properties["sentEmailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "notificationType" = ${NotificationType} + "sentToRecipients" = ${SentToRecipients} + "sender" = ${VarSender} + "bounceMta" = ${BounceMta} + "bounceType" = ${BounceType} + "bounceRecipients" = ${BounceRecipients} + "bounceSubType" = ${BounceSubType} + "sentEmailId" = ${SentEmailId} + "subject" = ${Subject} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/BouncedRecipientDto.ps1 b/src/maislurp-client-powershell/Model/BouncedRecipientDto.ps1 new file mode 100644 index 00000000..7b9064dc --- /dev/null +++ b/src/maislurp-client-powershell/Model/BouncedRecipientDto.ps1 @@ -0,0 +1,218 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Bounced recipient + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER SentEmailId +No description available. +.PARAMETER Recipient +No description available. +.PARAMETER DiagnosticCode +No description available. +.PARAMETER Action +No description available. +.PARAMETER BounceType +No description available. +.PARAMETER Status +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +BouncedRecipientDto +#> + +function Initialize-BouncedRecipientDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentEmailId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${DiagnosticCode}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Action}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceType}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Status}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => BouncedRecipientDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Recipient -eq $null) { + throw "invalid value for 'Recipient', 'Recipient' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "diagnosticCode" = ${DiagnosticCode} + "action" = ${Action} + "bounceType" = ${BounceType} + "status" = ${Status} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to BouncedRecipientDto + +.DESCRIPTION + +Convert from JSON to BouncedRecipientDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +BouncedRecipientDto +#> +function ConvertFrom-JsonToBouncedRecipientDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => BouncedRecipientDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in BouncedRecipientDto + $AllProperties = ("id", "userId", "sentEmailId", "recipient", "diagnosticCode", "action", "bounceType", "status", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { + throw "Error! JSON cannot be serialized due to the required property 'recipient' missing." + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentEmailId"))) { #optional property not found + $SentEmailId = $null + } else { + $SentEmailId = $JsonParameters.PSobject.Properties["sentEmailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "diagnosticCode"))) { #optional property not found + $DiagnosticCode = $null + } else { + $DiagnosticCode = $JsonParameters.PSobject.Properties["diagnosticCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "action"))) { #optional property not found + $Action = $null + } else { + $Action = $JsonParameters.PSobject.Properties["action"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceType"))) { #optional property not found + $BounceType = $null + } else { + $BounceType = $JsonParameters.PSobject.Properties["bounceType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { #optional property not found + $Status = $null + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "diagnosticCode" = ${DiagnosticCode} + "action" = ${Action} + "bounceType" = ${BounceType} + "status" = ${Status} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/BulkSendEmailOptions.ps1 b/src/maislurp-client-powershell/Model/BulkSendEmailOptions.ps1 new file mode 100644 index 00000000..e1290086 --- /dev/null +++ b/src/maislurp-client-powershell/Model/BulkSendEmailOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for bulk sending an email from multiple addresses. See regular `sendEmail` methods for more information. + +.PARAMETER InboxIds +Inboxes to send the email from +.PARAMETER SendEmailOptions +No description available. +.OUTPUTS + +BulkSendEmailOptions +#> + +function Initialize-BulkSendEmailOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${InboxIds}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${SendEmailOptions} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => BulkSendEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxIds -eq $null) { + throw "invalid value for 'InboxIds', 'InboxIds' cannot be null." + } + + if ($SendEmailOptions -eq $null) { + throw "invalid value for 'SendEmailOptions', 'SendEmailOptions' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + "sendEmailOptions" = ${SendEmailOptions} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to BulkSendEmailOptions + +.DESCRIPTION + +Convert from JSON to BulkSendEmailOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +BulkSendEmailOptions +#> +function ConvertFrom-JsonToBulkSendEmailOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => BulkSendEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in BulkSendEmailOptions + $AllProperties = ("inboxIds", "sendEmailOptions") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxIds' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxIds"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxIds' missing." + } else { + $InboxIds = $JsonParameters.PSobject.Properties["inboxIds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sendEmailOptions"))) { + throw "Error! JSON cannot be serialized due to the required property 'sendEmailOptions' missing." + } else { + $SendEmailOptions = $JsonParameters.PSobject.Properties["sendEmailOptions"].value + } + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + "sendEmailOptions" = ${SendEmailOptions} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CanSendEmailResults.ps1 b/src/maislurp-client-powershell/Model/CanSendEmailResults.ps1 new file mode 100644 index 00000000..e311f4be --- /dev/null +++ b/src/maislurp-client-powershell/Model/CanSendEmailResults.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER IsSendingPermitted +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +CanSendEmailResults +#> + +function Initialize-CanSendEmailResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsSendingPermitted}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CanSendEmailResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($IsSendingPermitted -eq $null) { + throw "invalid value for 'IsSendingPermitted', 'IsSendingPermitted' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "isSendingPermitted" = ${IsSendingPermitted} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CanSendEmailResults + +.DESCRIPTION + +Convert from JSON to CanSendEmailResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +CanSendEmailResults +#> +function ConvertFrom-JsonToCanSendEmailResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CanSendEmailResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CanSendEmailResults + $AllProperties = ("isSendingPermitted", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'isSendingPermitted' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isSendingPermitted"))) { + throw "Error! JSON cannot be serialized due to the required property 'isSendingPermitted' missing." + } else { + $IsSendingPermitted = $JsonParameters.PSobject.Properties["isSendingPermitted"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "isSendingPermitted" = ${IsSendingPermitted} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CheckEmailBodyFeatureSupportResults.ps1 b/src/maislurp-client-powershell/Model/CheckEmailBodyFeatureSupportResults.ps1 new file mode 100644 index 00000000..d28f73ff --- /dev/null +++ b/src/maislurp-client-powershell/Model/CheckEmailBodyFeatureSupportResults.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Result +No description available. +.OUTPUTS + +CheckEmailBodyFeatureSupportResults +#> + +function Initialize-CheckEmailBodyFeatureSupportResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Result} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CheckEmailBodyFeatureSupportResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Result -eq $null) { + throw "invalid value for 'Result', 'Result' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CheckEmailBodyFeatureSupportResults + +.DESCRIPTION + +Convert from JSON to CheckEmailBodyFeatureSupportResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +CheckEmailBodyFeatureSupportResults +#> +function ConvertFrom-JsonToCheckEmailBodyFeatureSupportResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CheckEmailBodyFeatureSupportResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CheckEmailBodyFeatureSupportResults + $AllProperties = ("result") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'result' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "result"))) { + throw "Error! JSON cannot be serialized due to the required property 'result' missing." + } else { + $Result = $JsonParameters.PSobject.Properties["result"].value + } + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CheckEmailBodyResults.ps1 b/src/maislurp-client-powershell/Model/CheckEmailBodyResults.ps1 new file mode 100644 index 00000000..f3c886ea --- /dev/null +++ b/src/maislurp-client-powershell/Model/CheckEmailBodyResults.ps1 @@ -0,0 +1,157 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER HasIssues +No description available. +.PARAMETER LinkIssues +No description available. +.PARAMETER ImageIssues +No description available. +.PARAMETER SpellingIssues +No description available. +.OUTPUTS + +CheckEmailBodyResults +#> + +function Initialize-CheckEmailBodyResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${HasIssues}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${LinkIssues}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${ImageIssues}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${SpellingIssues} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CheckEmailBodyResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($HasIssues -eq $null) { + throw "invalid value for 'HasIssues', 'HasIssues' cannot be null." + } + + if ($LinkIssues -eq $null) { + throw "invalid value for 'LinkIssues', 'LinkIssues' cannot be null." + } + + if ($ImageIssues -eq $null) { + throw "invalid value for 'ImageIssues', 'ImageIssues' cannot be null." + } + + if ($SpellingIssues -eq $null) { + throw "invalid value for 'SpellingIssues', 'SpellingIssues' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "hasIssues" = ${HasIssues} + "linkIssues" = ${LinkIssues} + "imageIssues" = ${ImageIssues} + "spellingIssues" = ${SpellingIssues} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CheckEmailBodyResults + +.DESCRIPTION + +Convert from JSON to CheckEmailBodyResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +CheckEmailBodyResults +#> +function ConvertFrom-JsonToCheckEmailBodyResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CheckEmailBodyResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CheckEmailBodyResults + $AllProperties = ("hasIssues", "linkIssues", "imageIssues", "spellingIssues") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'hasIssues' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hasIssues"))) { + throw "Error! JSON cannot be serialized due to the required property 'hasIssues' missing." + } else { + $HasIssues = $JsonParameters.PSobject.Properties["hasIssues"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "linkIssues"))) { + throw "Error! JSON cannot be serialized due to the required property 'linkIssues' missing." + } else { + $LinkIssues = $JsonParameters.PSobject.Properties["linkIssues"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imageIssues"))) { + throw "Error! JSON cannot be serialized due to the required property 'imageIssues' missing." + } else { + $ImageIssues = $JsonParameters.PSobject.Properties["imageIssues"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "spellingIssues"))) { + throw "Error! JSON cannot be serialized due to the required property 'spellingIssues' missing." + } else { + $SpellingIssues = $JsonParameters.PSobject.Properties["spellingIssues"].value + } + + $PSO = [PSCustomObject]@{ + "hasIssues" = ${HasIssues} + "linkIssues" = ${LinkIssues} + "imageIssues" = ${ImageIssues} + "spellingIssues" = ${SpellingIssues} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CheckEmailClientSupportOptions.ps1 b/src/maislurp-client-powershell/Model/CheckEmailClientSupportOptions.ps1 new file mode 100644 index 00000000..a82bebeb --- /dev/null +++ b/src/maislurp-client-powershell/Model/CheckEmailClientSupportOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for the email to be validated + +.PARAMETER EmailBody +No description available. +.OUTPUTS + +CheckEmailClientSupportOptions +#> + +function Initialize-CheckEmailClientSupportOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailBody} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CheckEmailClientSupportOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailBody -eq $null) { + throw "invalid value for 'EmailBody', 'EmailBody' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailBody" = ${EmailBody} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CheckEmailClientSupportOptions + +.DESCRIPTION + +Convert from JSON to CheckEmailClientSupportOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CheckEmailClientSupportOptions +#> +function ConvertFrom-JsonToCheckEmailClientSupportOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CheckEmailClientSupportOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CheckEmailClientSupportOptions + $AllProperties = ("emailBody") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailBody' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailBody"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailBody' missing." + } else { + $EmailBody = $JsonParameters.PSobject.Properties["emailBody"].value + } + + $PSO = [PSCustomObject]@{ + "emailBody" = ${EmailBody} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CheckEmailClientSupportResults.ps1 b/src/maislurp-client-powershell/Model/CheckEmailClientSupportResults.ps1 new file mode 100644 index 00000000..48b734da --- /dev/null +++ b/src/maislurp-client-powershell/Model/CheckEmailClientSupportResults.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Result +No description available. +.OUTPUTS + +CheckEmailClientSupportResults +#> + +function Initialize-CheckEmailClientSupportResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Result} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CheckEmailClientSupportResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Result -eq $null) { + throw "invalid value for 'Result', 'Result' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CheckEmailClientSupportResults + +.DESCRIPTION + +Convert from JSON to CheckEmailClientSupportResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +CheckEmailClientSupportResults +#> +function ConvertFrom-JsonToCheckEmailClientSupportResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CheckEmailClientSupportResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CheckEmailClientSupportResults + $AllProperties = ("result") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'result' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "result"))) { + throw "Error! JSON cannot be serialized due to the required property 'result' missing." + } else { + $Result = $JsonParameters.PSobject.Properties["result"].value + } + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportOptions.ps1 b/src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportOptions.ps1 new file mode 100644 index 00000000..be0a82d9 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailBody +No description available. +.OUTPUTS + +CheckEmailFeaturesClientSupportOptions +#> + +function Initialize-CheckEmailFeaturesClientSupportOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailBody} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CheckEmailFeaturesClientSupportOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailBody -eq $null) { + throw "invalid value for 'EmailBody', 'EmailBody' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailBody" = ${EmailBody} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CheckEmailFeaturesClientSupportOptions + +.DESCRIPTION + +Convert from JSON to CheckEmailFeaturesClientSupportOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CheckEmailFeaturesClientSupportOptions +#> +function ConvertFrom-JsonToCheckEmailFeaturesClientSupportOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CheckEmailFeaturesClientSupportOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CheckEmailFeaturesClientSupportOptions + $AllProperties = ("emailBody") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailBody' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailBody"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailBody' missing." + } else { + $EmailBody = $JsonParameters.PSobject.Properties["emailBody"].value + } + + $PSO = [PSCustomObject]@{ + "emailBody" = ${EmailBody} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportResults.ps1 b/src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportResults.ps1 new file mode 100644 index 00000000..4440218e --- /dev/null +++ b/src/maislurp-client-powershell/Model/CheckEmailFeaturesClientSupportResults.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Result +No description available. +.OUTPUTS + +CheckEmailFeaturesClientSupportResults +#> + +function Initialize-CheckEmailFeaturesClientSupportResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Result} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CheckEmailFeaturesClientSupportResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Result -eq $null) { + throw "invalid value for 'Result', 'Result' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CheckEmailFeaturesClientSupportResults + +.DESCRIPTION + +Convert from JSON to CheckEmailFeaturesClientSupportResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +CheckEmailFeaturesClientSupportResults +#> +function ConvertFrom-JsonToCheckEmailFeaturesClientSupportResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CheckEmailFeaturesClientSupportResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CheckEmailFeaturesClientSupportResults + $AllProperties = ("result") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'result' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "result"))) { + throw "Error! JSON cannot be serialized due to the required property 'result' missing." + } else { + $Result = $JsonParameters.PSobject.Properties["result"].value + } + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/Complaint.ps1 b/src/maislurp-client-powershell/Model/Complaint.ps1 new file mode 100644 index 00000000..fac5b190 --- /dev/null +++ b/src/maislurp-client-powershell/Model/Complaint.ps1 @@ -0,0 +1,209 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER EventType +No description available. +.PARAMETER MailSource +No description available. +.PARAMETER MailMessageId +No description available. +.PARAMETER ComplaintRecipient +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +Complaint +#> + +function Initialize-Complaint { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EventType}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${MailSource}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${MailMessageId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${ComplaintRecipient}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => Complaint' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($ComplaintRecipient -eq $null) { + throw "invalid value for 'ComplaintRecipient', 'ComplaintRecipient' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "eventType" = ${EventType} + "mailSource" = ${MailSource} + "mailMessageId" = ${MailMessageId} + "complaintRecipient" = ${ComplaintRecipient} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to Complaint + +.DESCRIPTION + +Convert from JSON to Complaint + +.PARAMETER Json + +Json object + +.OUTPUTS + +Complaint +#> +function ConvertFrom-JsonToComplaint { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => Complaint' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in Complaint + $AllProperties = ("id", "userId", "eventType", "mailSource", "mailMessageId", "complaintRecipient", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "complaintRecipient"))) { + throw "Error! JSON cannot be serialized due to the required property 'complaintRecipient' missing." + } else { + $ComplaintRecipient = $JsonParameters.PSobject.Properties["complaintRecipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventType"))) { #optional property not found + $EventType = $null + } else { + $EventType = $JsonParameters.PSobject.Properties["eventType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mailSource"))) { #optional property not found + $MailSource = $null + } else { + $MailSource = $JsonParameters.PSobject.Properties["mailSource"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mailMessageId"))) { #optional property not found + $MailMessageId = $null + } else { + $MailMessageId = $JsonParameters.PSobject.Properties["mailMessageId"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "eventType" = ${EventType} + "mailSource" = ${MailSource} + "mailMessageId" = ${MailMessageId} + "complaintRecipient" = ${ComplaintRecipient} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConditionOption.ps1 b/src/maislurp-client-powershell/Model/ConditionOption.ps1 new file mode 100644 index 00000000..3da29348 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConditionOption.ps1 @@ -0,0 +1,125 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for matching emails in an inbox based on a condition such as `HAS_ATTACHMENTS=TRUE` + +.PARAMETER Condition +Condition of an email object that can be used to filter results +.PARAMETER Value +Expected condition value +.OUTPUTS + +ConditionOption +#> + +function Initialize-ConditionOption { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HAS_ATTACHMENTS")] + [String] + ${Condition}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("TRUE", "FALSE")] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConditionOption' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Condition -eq $null) { + throw "invalid value for 'Condition', 'Condition' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "condition" = ${Condition} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConditionOption + +.DESCRIPTION + +Convert from JSON to ConditionOption + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConditionOption +#> +function ConvertFrom-JsonToConditionOption { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConditionOption' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConditionOption + $AllProperties = ("condition", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'condition' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "condition"))) { + throw "Error! JSON cannot be serialized due to the required property 'condition' missing." + } else { + $Condition = $JsonParameters.PSobject.Properties["condition"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "condition" = ${Condition} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorDto.ps1 b/src/maislurp-client-powershell/Model/ConnectorDto.ps1 new file mode 100644 index 00000000..ac746971 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorDto.ps1 @@ -0,0 +1,265 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER Name +No description available. +.PARAMETER Enabled +No description available. +.PARAMETER UserId +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER SyncEnabled +No description available. +.PARAMETER SyncScheduleType +No description available. +.PARAMETER SyncInterval +No description available. +.PARAMETER HasImapConnection +No description available. +.PARAMETER HasSmtpConnection +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +ConnectorDto +#> + +function Initialize-ConnectorDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Enabled}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${SyncEnabled}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("INTERVAL")] + [String] + ${SyncScheduleType}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SyncInterval}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${HasImapConnection}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${HasSmtpConnection}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Enabled -eq $null) { + throw "invalid value for 'Enabled', 'Enabled' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($SyncEnabled -eq $null) { + throw "invalid value for 'SyncEnabled', 'SyncEnabled' cannot be null." + } + + if ($HasImapConnection -eq $null) { + throw "invalid value for 'HasImapConnection', 'HasImapConnection' cannot be null." + } + + if ($HasSmtpConnection -eq $null) { + throw "invalid value for 'HasSmtpConnection', 'HasSmtpConnection' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "name" = ${Name} + "enabled" = ${Enabled} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "syncEnabled" = ${SyncEnabled} + "syncScheduleType" = ${SyncScheduleType} + "syncInterval" = ${SyncInterval} + "hasImapConnection" = ${HasImapConnection} + "hasSmtpConnection" = ${HasSmtpConnection} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorDto + +.DESCRIPTION + +Convert from JSON to ConnectorDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorDto +#> +function ConvertFrom-JsonToConnectorDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorDto + $AllProperties = ("id", "name", "enabled", "userId", "inboxId", "syncEnabled", "syncScheduleType", "syncInterval", "hasImapConnection", "hasSmtpConnection", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { + throw "Error! JSON cannot be serialized due to the required property 'enabled' missing." + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncEnabled"))) { + throw "Error! JSON cannot be serialized due to the required property 'syncEnabled' missing." + } else { + $SyncEnabled = $JsonParameters.PSobject.Properties["syncEnabled"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hasImapConnection"))) { + throw "Error! JSON cannot be serialized due to the required property 'hasImapConnection' missing." + } else { + $HasImapConnection = $JsonParameters.PSobject.Properties["hasImapConnection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hasSmtpConnection"))) { + throw "Error! JSON cannot be serialized due to the required property 'hasSmtpConnection' missing." + } else { + $HasSmtpConnection = $JsonParameters.PSobject.Properties["hasSmtpConnection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncScheduleType"))) { #optional property not found + $SyncScheduleType = $null + } else { + $SyncScheduleType = $JsonParameters.PSobject.Properties["syncScheduleType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncInterval"))) { #optional property not found + $SyncInterval = $null + } else { + $SyncInterval = $JsonParameters.PSobject.Properties["syncInterval"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "name" = ${Name} + "enabled" = ${Enabled} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "syncEnabled" = ${SyncEnabled} + "syncScheduleType" = ${SyncScheduleType} + "syncInterval" = ${SyncInterval} + "hasImapConnection" = ${HasImapConnection} + "hasSmtpConnection" = ${HasSmtpConnection} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorImapConnectionDto.ps1 b/src/maislurp-client-powershell/Model/ConnectorImapConnectionDto.ps1 new file mode 100644 index 00000000..43bfc3c0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorImapConnectionDto.ps1 @@ -0,0 +1,244 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER ConnectorId +No description available. +.PARAMETER ImapHost +No description available. +.PARAMETER ImapPort +No description available. +.PARAMETER ImapUsername +No description available. +.PARAMETER ImapPassword +No description available. +.PARAMETER ImapSsl +No description available. +.PARAMETER SelectFolder +No description available. +.PARAMETER SearchTerms +No description available. +.PARAMETER Enabled +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ConnectorImapConnectionDto +#> + +function Initialize-ConnectorImapConnectionDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ConnectorId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapHost}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${ImapPort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapUsername}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapPassword}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${ImapSsl}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${SelectFolder}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${SearchTerms}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Enabled}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorImapConnectionDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ConnectorId -eq $null) { + throw "invalid value for 'ConnectorId', 'ConnectorId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "connectorId" = ${ConnectorId} + "imapHost" = ${ImapHost} + "imapPort" = ${ImapPort} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "imapSsl" = ${ImapSsl} + "selectFolder" = ${SelectFolder} + "searchTerms" = ${SearchTerms} + "enabled" = ${Enabled} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorImapConnectionDto + +.DESCRIPTION + +Convert from JSON to ConnectorImapConnectionDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorImapConnectionDto +#> +function ConvertFrom-JsonToConnectorImapConnectionDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorImapConnectionDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorImapConnectionDto + $AllProperties = ("connectorId", "imapHost", "imapPort", "imapUsername", "imapPassword", "imapSsl", "selectFolder", "searchTerms", "enabled", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'connectorId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorId"))) { + throw "Error! JSON cannot be serialized due to the required property 'connectorId' missing." + } else { + $ConnectorId = $JsonParameters.PSobject.Properties["connectorId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapHost"))) { #optional property not found + $ImapHost = $null + } else { + $ImapHost = $JsonParameters.PSobject.Properties["imapHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPort"))) { #optional property not found + $ImapPort = $null + } else { + $ImapPort = $JsonParameters.PSobject.Properties["imapPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapUsername"))) { #optional property not found + $ImapUsername = $null + } else { + $ImapUsername = $JsonParameters.PSobject.Properties["imapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPassword"))) { #optional property not found + $ImapPassword = $null + } else { + $ImapPassword = $JsonParameters.PSobject.Properties["imapPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapSsl"))) { #optional property not found + $ImapSsl = $null + } else { + $ImapSsl = $JsonParameters.PSobject.Properties["imapSsl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "selectFolder"))) { #optional property not found + $SelectFolder = $null + } else { + $SelectFolder = $JsonParameters.PSobject.Properties["selectFolder"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "searchTerms"))) { #optional property not found + $SearchTerms = $null + } else { + $SearchTerms = $JsonParameters.PSobject.Properties["searchTerms"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { #optional property not found + $Enabled = $null + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + $PSO = [PSCustomObject]@{ + "connectorId" = ${ConnectorId} + "imapHost" = ${ImapHost} + "imapPort" = ${ImapPort} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "imapSsl" = ${ImapSsl} + "selectFolder" = ${SelectFolder} + "searchTerms" = ${SearchTerms} + "enabled" = ${Enabled} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorProjection.ps1 b/src/maislurp-client-powershell/Model/ConnectorProjection.ps1 new file mode 100644 index 00000000..57598e61 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorProjection.ps1 @@ -0,0 +1,236 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Connector + +.PARAMETER Enabled +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER SyncEnabled +No description available. +.PARAMETER SyncScheduleType +No description available. +.PARAMETER SyncInterval +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ConnectorProjection +#> + +function Initialize-ConnectorProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Enabled}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${SyncEnabled}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("INTERVAL")] + [String] + ${SyncScheduleType}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SyncInterval}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($SyncScheduleType -eq $null) { + throw "invalid value for 'SyncScheduleType', 'SyncScheduleType' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "enabled" = ${Enabled} + "emailAddress" = ${EmailAddress} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "syncEnabled" = ${SyncEnabled} + "syncScheduleType" = ${SyncScheduleType} + "syncInterval" = ${SyncInterval} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorProjection + +.DESCRIPTION + +Convert from JSON to ConnectorProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorProjection +#> +function ConvertFrom-JsonToConnectorProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorProjection + $AllProperties = ("enabled", "emailAddress", "inboxId", "userId", "syncEnabled", "syncScheduleType", "syncInterval", "createdAt", "name", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncScheduleType"))) { + throw "Error! JSON cannot be serialized due to the required property 'syncScheduleType' missing." + } else { + $SyncScheduleType = $JsonParameters.PSobject.Properties["syncScheduleType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { #optional property not found + $Enabled = $null + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { #optional property not found + $EmailAddress = $null + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncEnabled"))) { #optional property not found + $SyncEnabled = $null + } else { + $SyncEnabled = $JsonParameters.PSobject.Properties["syncEnabled"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncInterval"))) { #optional property not found + $SyncInterval = $null + } else { + $SyncInterval = $JsonParameters.PSobject.Properties["syncInterval"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "enabled" = ${Enabled} + "emailAddress" = ${EmailAddress} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "syncEnabled" = ${SyncEnabled} + "syncScheduleType" = ${SyncScheduleType} + "syncInterval" = ${SyncInterval} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSmtpConnectionDto.ps1 b/src/maislurp-client-powershell/Model/ConnectorSmtpConnectionDto.ps1 new file mode 100644 index 00000000..789cb840 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSmtpConnectionDto.ps1 @@ -0,0 +1,218 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER ConnectorId +No description available. +.PARAMETER SmtpHost +No description available. +.PARAMETER SmtpPort +No description available. +.PARAMETER SmtpUsername +No description available. +.PARAMETER SmtpPassword +No description available. +.PARAMETER SmtpSsl +No description available. +.PARAMETER Enabled +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ConnectorSmtpConnectionDto +#> + +function Initialize-ConnectorSmtpConnectionDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ConnectorId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpHost}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SmtpPort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpUsername}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpPassword}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${SmtpSsl}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Enabled}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSmtpConnectionDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ConnectorId -eq $null) { + throw "invalid value for 'ConnectorId', 'ConnectorId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "connectorId" = ${ConnectorId} + "smtpHost" = ${SmtpHost} + "smtpPort" = ${SmtpPort} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + "smtpSsl" = ${SmtpSsl} + "enabled" = ${Enabled} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSmtpConnectionDto + +.DESCRIPTION + +Convert from JSON to ConnectorSmtpConnectionDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSmtpConnectionDto +#> +function ConvertFrom-JsonToConnectorSmtpConnectionDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSmtpConnectionDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSmtpConnectionDto + $AllProperties = ("connectorId", "smtpHost", "smtpPort", "smtpUsername", "smtpPassword", "smtpSsl", "enabled", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'connectorId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorId"))) { + throw "Error! JSON cannot be serialized due to the required property 'connectorId' missing." + } else { + $ConnectorId = $JsonParameters.PSobject.Properties["connectorId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpHost"))) { #optional property not found + $SmtpHost = $null + } else { + $SmtpHost = $JsonParameters.PSobject.Properties["smtpHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPort"))) { #optional property not found + $SmtpPort = $null + } else { + $SmtpPort = $JsonParameters.PSobject.Properties["smtpPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpUsername"))) { #optional property not found + $SmtpUsername = $null + } else { + $SmtpUsername = $JsonParameters.PSobject.Properties["smtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPassword"))) { #optional property not found + $SmtpPassword = $null + } else { + $SmtpPassword = $JsonParameters.PSobject.Properties["smtpPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpSsl"))) { #optional property not found + $SmtpSsl = $null + } else { + $SmtpSsl = $JsonParameters.PSobject.Properties["smtpSsl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { #optional property not found + $Enabled = $null + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + $PSO = [PSCustomObject]@{ + "connectorId" = ${ConnectorId} + "smtpHost" = ${SmtpHost} + "smtpPort" = ${SmtpPort} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + "smtpSsl" = ${SmtpSsl} + "enabled" = ${Enabled} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncEventDto.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncEventDto.ps1 new file mode 100644 index 00000000..b6731d75 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncEventDto.ps1 @@ -0,0 +1,188 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER ConnectorId +No description available. +.PARAMETER SyncStatus +No description available. +.PARAMETER SyncCount +No description available. +.PARAMETER Message +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +ConnectorSyncEventDto +#> + +function Initialize-ConnectorSyncEventDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ConnectorId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUCCESS", "INTERNAL_ERROR", "SUBSCRIPTION_ERROR", "CONNECTION_ERROR", "NOT_FOUND")] + [String] + ${SyncStatus}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${SyncCount}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncEventDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($ConnectorId -eq $null) { + throw "invalid value for 'ConnectorId', 'ConnectorId' cannot be null." + } + + if ($SyncStatus -eq $null) { + throw "invalid value for 'SyncStatus', 'SyncStatus' cannot be null." + } + + if ($SyncCount -eq $null) { + throw "invalid value for 'SyncCount', 'SyncCount' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "connectorId" = ${ConnectorId} + "syncStatus" = ${SyncStatus} + "syncCount" = ${SyncCount} + "message" = ${Message} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncEventDto + +.DESCRIPTION + +Convert from JSON to ConnectorSyncEventDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncEventDto +#> +function ConvertFrom-JsonToConnectorSyncEventDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncEventDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncEventDto + $AllProperties = ("id", "connectorId", "syncStatus", "syncCount", "message", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorId"))) { + throw "Error! JSON cannot be serialized due to the required property 'connectorId' missing." + } else { + $ConnectorId = $JsonParameters.PSobject.Properties["connectorId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncStatus"))) { + throw "Error! JSON cannot be serialized due to the required property 'syncStatus' missing." + } else { + $SyncStatus = $JsonParameters.PSobject.Properties["syncStatus"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncCount"))) { + throw "Error! JSON cannot be serialized due to the required property 'syncCount' missing." + } else { + $SyncCount = $JsonParameters.PSobject.Properties["syncCount"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "connectorId" = ${ConnectorId} + "syncStatus" = ${SyncStatus} + "syncCount" = ${SyncCount} + "message" = ${Message} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncEventProjection.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncEventProjection.ps1 new file mode 100644 index 00000000..c608a68e --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncEventProjection.ps1 @@ -0,0 +1,184 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +ConnectorSyncEventProjection + +.PARAMETER ConnectorId +No description available. +.PARAMETER SyncCount +No description available. +.PARAMETER SyncStatus +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Message +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ConnectorSyncEventProjection +#> + +function Initialize-ConnectorSyncEventProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ConnectorId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${SyncCount}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUCCESS", "INTERNAL_ERROR", "SUBSCRIPTION_ERROR", "CONNECTION_ERROR", "NOT_FOUND")] + [String] + ${SyncStatus}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncEventProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ConnectorId -eq $null) { + throw "invalid value for 'ConnectorId', 'ConnectorId' cannot be null." + } + + if ($SyncCount -eq $null) { + throw "invalid value for 'SyncCount', 'SyncCount' cannot be null." + } + + if ($SyncStatus -eq $null) { + throw "invalid value for 'SyncStatus', 'SyncStatus' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "connectorId" = ${ConnectorId} + "syncCount" = ${SyncCount} + "syncStatus" = ${SyncStatus} + "createdAt" = ${CreatedAt} + "message" = ${Message} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncEventProjection + +.DESCRIPTION + +Convert from JSON to ConnectorSyncEventProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncEventProjection +#> +function ConvertFrom-JsonToConnectorSyncEventProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncEventProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncEventProjection + $AllProperties = ("connectorId", "syncCount", "syncStatus", "createdAt", "message", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'connectorId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorId"))) { + throw "Error! JSON cannot be serialized due to the required property 'connectorId' missing." + } else { + $ConnectorId = $JsonParameters.PSobject.Properties["connectorId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncCount"))) { + throw "Error! JSON cannot be serialized due to the required property 'syncCount' missing." + } else { + $SyncCount = $JsonParameters.PSobject.Properties["syncCount"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncStatus"))) { + throw "Error! JSON cannot be serialized due to the required property 'syncStatus' missing." + } else { + $SyncStatus = $JsonParameters.PSobject.Properties["syncStatus"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "connectorId" = ${ConnectorId} + "syncCount" = ${SyncCount} + "syncStatus" = ${SyncStatus} + "createdAt" = ${CreatedAt} + "message" = ${Message} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncRequestResult.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResult.ps1 new file mode 100644 index 00000000..74378c8f --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResult.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER SyncResult +No description available. +.PARAMETER Exception +No description available. +.PARAMETER EventId +No description available. +.OUTPUTS + +ConnectorSyncRequestResult +#> + +function Initialize-ConnectorSyncRequestResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${SyncResult}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Exception}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EventId} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "syncResult" = ${SyncResult} + "exception" = ${Exception} + "eventId" = ${EventId} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncRequestResult + +.DESCRIPTION + +Convert from JSON to ConnectorSyncRequestResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncRequestResult +#> +function ConvertFrom-JsonToConnectorSyncRequestResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncRequestResult + $AllProperties = ("syncResult", "exception", "eventId") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncResult"))) { #optional property not found + $SyncResult = $null + } else { + $SyncResult = $JsonParameters.PSobject.Properties["syncResult"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "exception"))) { #optional property not found + $Exception = $null + } else { + $Exception = $JsonParameters.PSobject.Properties["exception"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventId"))) { #optional property not found + $EventId = $null + } else { + $EventId = $JsonParameters.PSobject.Properties["eventId"].value + } + + $PSO = [PSCustomObject]@{ + "syncResult" = ${SyncResult} + "exception" = ${Exception} + "eventId" = ${EventId} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultException.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultException.ps1 new file mode 100644 index 00000000..470bdb18 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultException.ps1 @@ -0,0 +1,150 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Cause +No description available. +.PARAMETER VarStackTrace +No description available. +.PARAMETER Message +No description available. +.PARAMETER Suppressed +No description available. +.PARAMETER LocalizedMessage +No description available. +.OUTPUTS + +ConnectorSyncRequestResultException +#> + +function Initialize-ConnectorSyncRequestResultException { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Cause}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${VarStackTrace}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Suppressed}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${LocalizedMessage} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResultException' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "cause" = ${Cause} + "stackTrace" = ${VarStackTrace} + "message" = ${Message} + "suppressed" = ${Suppressed} + "localizedMessage" = ${LocalizedMessage} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncRequestResultException + +.DESCRIPTION + +Convert from JSON to ConnectorSyncRequestResultException + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncRequestResultException +#> +function ConvertFrom-JsonToConnectorSyncRequestResultException { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResultException' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncRequestResultException + $AllProperties = ("cause", "stackTrace", "message", "suppressed", "localizedMessage") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cause"))) { #optional property not found + $Cause = $null + } else { + $Cause = $JsonParameters.PSobject.Properties["cause"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "stackTrace"))) { #optional property not found + $VarStackTrace = $null + } else { + $VarStackTrace = $JsonParameters.PSobject.Properties["stackTrace"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "suppressed"))) { #optional property not found + $Suppressed = $null + } else { + $Suppressed = $JsonParameters.PSobject.Properties["suppressed"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "localizedMessage"))) { #optional property not found + $LocalizedMessage = $null + } else { + $LocalizedMessage = $JsonParameters.PSobject.Properties["localizedMessage"].value + } + + $PSO = [PSCustomObject]@{ + "cause" = ${Cause} + "stackTrace" = ${VarStackTrace} + "message" = ${Message} + "suppressed" = ${Suppressed} + "localizedMessage" = ${LocalizedMessage} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCause.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCause.ps1 new file mode 100644 index 00000000..a765673e --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCause.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarStackTrace +No description available. +.PARAMETER Message +No description available. +.PARAMETER LocalizedMessage +No description available. +.OUTPUTS + +ConnectorSyncRequestResultExceptionCause +#> + +function Initialize-ConnectorSyncRequestResultExceptionCause { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${VarStackTrace}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${LocalizedMessage} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResultExceptionCause' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "stackTrace" = ${VarStackTrace} + "message" = ${Message} + "localizedMessage" = ${LocalizedMessage} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncRequestResultExceptionCause + +.DESCRIPTION + +Convert from JSON to ConnectorSyncRequestResultExceptionCause + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncRequestResultExceptionCause +#> +function ConvertFrom-JsonToConnectorSyncRequestResultExceptionCause { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResultExceptionCause' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncRequestResultExceptionCause + $AllProperties = ("stackTrace", "message", "localizedMessage") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "stackTrace"))) { #optional property not found + $VarStackTrace = $null + } else { + $VarStackTrace = $JsonParameters.PSobject.Properties["stackTrace"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "localizedMessage"))) { #optional property not found + $LocalizedMessage = $null + } else { + $LocalizedMessage = $JsonParameters.PSobject.Properties["localizedMessage"].value + } + + $PSO = [PSCustomObject]@{ + "stackTrace" = ${VarStackTrace} + "message" = ${Message} + "localizedMessage" = ${LocalizedMessage} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.ps1 new file mode 100644 index 00000000..54b43213 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.ps1 @@ -0,0 +1,189 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER ClassLoaderName +No description available. +.PARAMETER ModuleName +No description available. +.PARAMETER ModuleVersion +No description available. +.PARAMETER MethodName +No description available. +.PARAMETER FileName +No description available. +.PARAMETER LineNumber +No description available. +.PARAMETER ClassName +No description available. +.PARAMETER NativeMethod +No description available. +.OUTPUTS + +ConnectorSyncRequestResultExceptionCauseStackTrace +#> + +function Initialize-ConnectorSyncRequestResultExceptionCauseStackTrace { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ClassLoaderName}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ModuleName}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${ModuleVersion}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${MethodName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${FileName}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${LineNumber}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ClassName}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${NativeMethod} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResultExceptionCauseStackTrace' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "classLoaderName" = ${ClassLoaderName} + "moduleName" = ${ModuleName} + "moduleVersion" = ${ModuleVersion} + "methodName" = ${MethodName} + "fileName" = ${FileName} + "lineNumber" = ${LineNumber} + "className" = ${ClassName} + "nativeMethod" = ${NativeMethod} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncRequestResultExceptionCauseStackTrace + +.DESCRIPTION + +Convert from JSON to ConnectorSyncRequestResultExceptionCauseStackTrace + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncRequestResultExceptionCauseStackTrace +#> +function ConvertFrom-JsonToConnectorSyncRequestResultExceptionCauseStackTrace { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncRequestResultExceptionCauseStackTrace' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncRequestResultExceptionCauseStackTrace + $AllProperties = ("classLoaderName", "moduleName", "moduleVersion", "methodName", "fileName", "lineNumber", "className", "nativeMethod") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "classLoaderName"))) { #optional property not found + $ClassLoaderName = $null + } else { + $ClassLoaderName = $JsonParameters.PSobject.Properties["classLoaderName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "moduleName"))) { #optional property not found + $ModuleName = $null + } else { + $ModuleName = $JsonParameters.PSobject.Properties["moduleName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "moduleVersion"))) { #optional property not found + $ModuleVersion = $null + } else { + $ModuleVersion = $JsonParameters.PSobject.Properties["moduleVersion"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "methodName"))) { #optional property not found + $MethodName = $null + } else { + $MethodName = $JsonParameters.PSobject.Properties["methodName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fileName"))) { #optional property not found + $FileName = $null + } else { + $FileName = $JsonParameters.PSobject.Properties["fileName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lineNumber"))) { #optional property not found + $LineNumber = $null + } else { + $LineNumber = $JsonParameters.PSobject.Properties["lineNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "className"))) { #optional property not found + $ClassName = $null + } else { + $ClassName = $JsonParameters.PSobject.Properties["className"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "nativeMethod"))) { #optional property not found + $NativeMethod = $null + } else { + $NativeMethod = $JsonParameters.PSobject.Properties["nativeMethod"].value + } + + $PSO = [PSCustomObject]@{ + "classLoaderName" = ${ClassLoaderName} + "moduleName" = ${ModuleName} + "moduleVersion" = ${ModuleVersion} + "methodName" = ${MethodName} + "fileName" = ${FileName} + "lineNumber" = ${LineNumber} + "className" = ${ClassName} + "nativeMethod" = ${NativeMethod} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ConnectorSyncResult.ps1 b/src/maislurp-client-powershell/Model/ConnectorSyncResult.ps1 new file mode 100644 index 00000000..0a575d04 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ConnectorSyncResult.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailSyncCount +No description available. +.PARAMETER LogLines +No description available. +.OUTPUTS + +ConnectorSyncResult +#> + +function Initialize-ConnectorSyncResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${EmailSyncCount}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${LogLines} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ConnectorSyncResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailSyncCount -eq $null) { + throw "invalid value for 'EmailSyncCount', 'EmailSyncCount' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailSyncCount" = ${EmailSyncCount} + "logLines" = ${LogLines} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ConnectorSyncResult + +.DESCRIPTION + +Convert from JSON to ConnectorSyncResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ConnectorSyncResult +#> +function ConvertFrom-JsonToConnectorSyncResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ConnectorSyncResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ConnectorSyncResult + $AllProperties = ("emailSyncCount", "logLines") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailSyncCount' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailSyncCount"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailSyncCount' missing." + } else { + $EmailSyncCount = $JsonParameters.PSobject.Properties["emailSyncCount"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "logLines"))) { #optional property not found + $LogLines = $null + } else { + $LogLines = $JsonParameters.PSobject.Properties["logLines"].value + } + + $PSO = [PSCustomObject]@{ + "emailSyncCount" = ${EmailSyncCount} + "logLines" = ${LogLines} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ContactDto.ps1 b/src/maislurp-client-powershell/Model/ContactDto.ps1 new file mode 100644 index 00000000..8e1baa18 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ContactDto.ps1 @@ -0,0 +1,248 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Contact object. For saving a user in contact book. + +.PARAMETER Id +No description available. +.PARAMETER GroupId +No description available. +.PARAMETER FirstName +No description available. +.PARAMETER LastName +No description available. +.PARAMETER Company +No description available. +.PARAMETER EmailAddresses +No description available. +.PARAMETER PrimaryEmailAddress +No description available. +.PARAMETER Tags +No description available. +.PARAMETER MetaData +No description available. +.PARAMETER OptOut +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +ContactDto +#> + +function Initialize-ContactDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${GroupId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${FirstName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${LastName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Company}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${EmailAddresses}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${PrimaryEmailAddress}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${MetaData}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${OptOut}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ContactDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($EmailAddresses -eq $null) { + throw "invalid value for 'EmailAddresses', 'EmailAddresses' cannot be null." + } + + if ($Tags -eq $null) { + throw "invalid value for 'Tags', 'Tags' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "groupId" = ${GroupId} + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "emailAddresses" = ${EmailAddresses} + "primaryEmailAddress" = ${PrimaryEmailAddress} + "tags" = ${Tags} + "metaData" = ${MetaData} + "optOut" = ${OptOut} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ContactDto + +.DESCRIPTION + +Convert from JSON to ContactDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ContactDto +#> +function ConvertFrom-JsonToContactDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ContactDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ContactDto + $AllProperties = ("id", "groupId", "firstName", "lastName", "company", "emailAddresses", "primaryEmailAddress", "tags", "metaData", "optOut", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddresses"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddresses' missing." + } else { + $EmailAddresses = $JsonParameters.PSobject.Properties["emailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { + throw "Error! JSON cannot be serialized due to the required property 'tags' missing." + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "groupId"))) { #optional property not found + $GroupId = $null + } else { + $GroupId = $JsonParameters.PSobject.Properties["groupId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "firstName"))) { #optional property not found + $FirstName = $null + } else { + $FirstName = $JsonParameters.PSobject.Properties["firstName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lastName"))) { #optional property not found + $LastName = $null + } else { + $LastName = $JsonParameters.PSobject.Properties["lastName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "company"))) { #optional property not found + $Company = $null + } else { + $Company = $JsonParameters.PSobject.Properties["company"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "primaryEmailAddress"))) { #optional property not found + $PrimaryEmailAddress = $null + } else { + $PrimaryEmailAddress = $JsonParameters.PSobject.Properties["primaryEmailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "metaData"))) { #optional property not found + $MetaData = $null + } else { + $MetaData = $JsonParameters.PSobject.Properties["metaData"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "optOut"))) { #optional property not found + $OptOut = $null + } else { + $OptOut = $JsonParameters.PSobject.Properties["optOut"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "groupId" = ${GroupId} + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "emailAddresses" = ${EmailAddresses} + "primaryEmailAddress" = ${PrimaryEmailAddress} + "tags" = ${Tags} + "metaData" = ${MetaData} + "optOut" = ${OptOut} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ContactProjection.ps1 b/src/maislurp-client-powershell/Model/ContactProjection.ps1 new file mode 100644 index 00000000..7e79e8d7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ContactProjection.ps1 @@ -0,0 +1,214 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email contact for address book + +.PARAMETER EmailAddress +No description available. +.PARAMETER EmailAddresses +No description available. +.PARAMETER FirstName +No description available. +.PARAMETER LastName +No description available. +.PARAMETER Company +No description available. +.PARAMETER OptOut +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.PARAMETER GroupId +No description available. +.OUTPUTS + +ContactProjection +#> + +function Initialize-ContactProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${EmailAddresses}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${FirstName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${LastName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Company}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${OptOut}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${GroupId} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ContactProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "emailAddresses" = ${EmailAddresses} + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "optOut" = ${OptOut} + "createdAt" = ${CreatedAt} + "id" = ${Id} + "groupId" = ${GroupId} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ContactProjection + +.DESCRIPTION + +Convert from JSON to ContactProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ContactProjection +#> +function ConvertFrom-JsonToContactProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ContactProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ContactProjection + $AllProperties = ("emailAddress", "emailAddresses", "firstName", "lastName", "company", "optOut", "createdAt", "id", "groupId") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { #optional property not found + $EmailAddress = $null + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddresses"))) { #optional property not found + $EmailAddresses = $null + } else { + $EmailAddresses = $JsonParameters.PSobject.Properties["emailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "firstName"))) { #optional property not found + $FirstName = $null + } else { + $FirstName = $JsonParameters.PSobject.Properties["firstName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lastName"))) { #optional property not found + $LastName = $null + } else { + $LastName = $JsonParameters.PSobject.Properties["lastName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "company"))) { #optional property not found + $Company = $null + } else { + $Company = $JsonParameters.PSobject.Properties["company"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "optOut"))) { #optional property not found + $OptOut = $null + } else { + $OptOut = $JsonParameters.PSobject.Properties["optOut"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "groupId"))) { #optional property not found + $GroupId = $null + } else { + $GroupId = $JsonParameters.PSobject.Properties["groupId"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "emailAddresses" = ${EmailAddresses} + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "optOut" = ${OptOut} + "createdAt" = ${CreatedAt} + "id" = ${Id} + "groupId" = ${GroupId} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ContentMatchOptions.ps1 b/src/maislurp-client-powershell/Model/ContentMatchOptions.ps1 new file mode 100644 index 00000000..6b8e07c0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ContentMatchOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for matching content using regex patterns based on Java Pattern syntax + +.PARAMETER Pattern +Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. +.OUTPUTS + +ContentMatchOptions +#> + +function Initialize-ContentMatchOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Pattern} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ContentMatchOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Pattern -eq $null) { + throw "invalid value for 'Pattern', 'Pattern' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "pattern" = ${Pattern} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ContentMatchOptions + +.DESCRIPTION + +Convert from JSON to ContentMatchOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ContentMatchOptions +#> +function ConvertFrom-JsonToContentMatchOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ContentMatchOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ContentMatchOptions + $AllProperties = ("pattern") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'pattern' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pattern"))) { + throw "Error! JSON cannot be serialized due to the required property 'pattern' missing." + } else { + $Pattern = $JsonParameters.PSobject.Properties["pattern"].value + } + + $PSO = [PSCustomObject]@{ + "pattern" = ${Pattern} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CountDto.ps1 b/src/maislurp-client-powershell/Model/CountDto.ps1 new file mode 100644 index 00000000..23501840 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CountDto.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Number of elements + +.PARAMETER TotalElements +No description available. +.OUTPUTS + +CountDto +#> + +function Initialize-CountDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CountDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "totalElements" = ${TotalElements} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CountDto + +.DESCRIPTION + +Convert from JSON to CountDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +CountDto +#> +function ConvertFrom-JsonToCountDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CountDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CountDto + $AllProperties = ("totalElements") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalElements' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + $PSO = [PSCustomObject]@{ + "totalElements" = ${TotalElements} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateAliasOptions.ps1 b/src/maislurp-client-powershell/Model/CreateAliasOptions.ps1 new file mode 100644 index 00000000..bedcd4b1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateAliasOptions.ps1 @@ -0,0 +1,175 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Create email alias options. Email aliases can be used to mask real email addresses behind an ID. You can also attach an inbox to an alias so that any email received by the inbox email address if forwarded to the alias email address. + +.PARAMETER EmailAddress +Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. +.PARAMETER InboxId +Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address +.PARAMETER Name +Optional name for alias +.PARAMETER UseThreads +Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. +.PARAMETER DomainId +Custom domain ID to use when generating alias email addresses +.PARAMETER VerifyEmailAddress +Whether to verify the masked email address exists before sending an email to it +.OUTPUTS + +CreateAliasOptions +#> + +function Initialize-CreateAliasOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${UseThreads}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${VerifyEmailAddress} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateAliasOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($UseThreads -eq $null) { + throw "invalid value for 'UseThreads', 'UseThreads' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "inboxId" = ${InboxId} + "name" = ${Name} + "useThreads" = ${UseThreads} + "domainId" = ${DomainId} + "verifyEmailAddress" = ${VerifyEmailAddress} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateAliasOptions + +.DESCRIPTION + +Convert from JSON to CreateAliasOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateAliasOptions +#> +function ConvertFrom-JsonToCreateAliasOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateAliasOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateAliasOptions + $AllProperties = ("emailAddress", "inboxId", "name", "useThreads", "domainId", "verifyEmailAddress") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddress' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useThreads"))) { + throw "Error! JSON cannot be serialized due to the required property 'useThreads' missing." + } else { + $UseThreads = $JsonParameters.PSobject.Properties["useThreads"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "verifyEmailAddress"))) { #optional property not found + $VerifyEmailAddress = $null + } else { + $VerifyEmailAddress = $JsonParameters.PSobject.Properties["verifyEmailAddress"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "inboxId" = ${InboxId} + "name" = ${Name} + "useThreads" = ${UseThreads} + "domainId" = ${DomainId} + "verifyEmailAddress" = ${VerifyEmailAddress} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateConnectorImapConnectionOptions.ps1 b/src/maislurp-client-powershell/Model/CreateConnectorImapConnectionOptions.ps1 new file mode 100644 index 00000000..af0c5b32 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateConnectorImapConnectionOptions.ps1 @@ -0,0 +1,197 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for IMAP connection to external email inbox. Allows syncing emails iva IMAP. + +.PARAMETER ImapSsl +No description available. +.PARAMETER ImapUsername +No description available. +.PARAMETER ImapPassword +No description available. +.PARAMETER SelectFolder +Optional folder to select during IMAP connection +.PARAMETER SearchTerms +No description available. +.PARAMETER ImapPort +IMAP server port +.PARAMETER ImapHost +IMAP server host +.PARAMETER Enabled +IMAP server enabled +.OUTPUTS + +CreateConnectorImapConnectionOptions +#> + +function Initialize-CreateConnectorImapConnectionOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${ImapSsl}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapUsername}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapPassword}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${SelectFolder}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SearchTerms}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${ImapPort}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapHost}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Enabled} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateConnectorImapConnectionOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ImapHost -eq $null) { + throw "invalid value for 'ImapHost', 'ImapHost' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "imapSsl" = ${ImapSsl} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "selectFolder" = ${SelectFolder} + "searchTerms" = ${SearchTerms} + "imapPort" = ${ImapPort} + "imapHost" = ${ImapHost} + "enabled" = ${Enabled} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateConnectorImapConnectionOptions + +.DESCRIPTION + +Convert from JSON to CreateConnectorImapConnectionOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateConnectorImapConnectionOptions +#> +function ConvertFrom-JsonToCreateConnectorImapConnectionOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateConnectorImapConnectionOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateConnectorImapConnectionOptions + $AllProperties = ("imapSsl", "imapUsername", "imapPassword", "selectFolder", "searchTerms", "imapPort", "imapHost", "enabled") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'imapHost' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapHost' missing." + } else { + $ImapHost = $JsonParameters.PSobject.Properties["imapHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapSsl"))) { #optional property not found + $ImapSsl = $null + } else { + $ImapSsl = $JsonParameters.PSobject.Properties["imapSsl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapUsername"))) { #optional property not found + $ImapUsername = $null + } else { + $ImapUsername = $JsonParameters.PSobject.Properties["imapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPassword"))) { #optional property not found + $ImapPassword = $null + } else { + $ImapPassword = $JsonParameters.PSobject.Properties["imapPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "selectFolder"))) { #optional property not found + $SelectFolder = $null + } else { + $SelectFolder = $JsonParameters.PSobject.Properties["selectFolder"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "searchTerms"))) { #optional property not found + $SearchTerms = $null + } else { + $SearchTerms = $JsonParameters.PSobject.Properties["searchTerms"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPort"))) { #optional property not found + $ImapPort = $null + } else { + $ImapPort = $JsonParameters.PSobject.Properties["imapPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { #optional property not found + $Enabled = $null + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + $PSO = [PSCustomObject]@{ + "imapSsl" = ${ImapSsl} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "selectFolder" = ${SelectFolder} + "searchTerms" = ${SearchTerms} + "imapPort" = ${ImapPort} + "imapHost" = ${ImapHost} + "enabled" = ${Enabled} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateConnectorOptions.ps1 b/src/maislurp-client-powershell/Model/CreateConnectorOptions.ps1 new file mode 100644 index 00000000..d87a3b3c --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateConnectorOptions.ps1 @@ -0,0 +1,164 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating an inbox connection with an external mail provider + +.PARAMETER SyncEnabled +Enable automatic background sync +.PARAMETER SyncScheduleType +Sync schedule type +.PARAMETER SyncInterval +Sync interval in minutes +.PARAMETER Name +Name of connector +.PARAMETER EmailAddress +Email address of external inbox +.PARAMETER Enabled +Is connector enabled +.OUTPUTS + +CreateConnectorOptions +#> + +function Initialize-CreateConnectorOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${SyncEnabled}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("INTERVAL")] + [String] + ${SyncScheduleType}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SyncInterval}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Enabled} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateConnectorOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "syncEnabled" = ${SyncEnabled} + "syncScheduleType" = ${SyncScheduleType} + "syncInterval" = ${SyncInterval} + "name" = ${Name} + "emailAddress" = ${EmailAddress} + "enabled" = ${Enabled} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateConnectorOptions + +.DESCRIPTION + +Convert from JSON to CreateConnectorOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateConnectorOptions +#> +function ConvertFrom-JsonToCreateConnectorOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateConnectorOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateConnectorOptions + $AllProperties = ("syncEnabled", "syncScheduleType", "syncInterval", "name", "emailAddress", "enabled") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncEnabled"))) { #optional property not found + $SyncEnabled = $null + } else { + $SyncEnabled = $JsonParameters.PSobject.Properties["syncEnabled"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncScheduleType"))) { #optional property not found + $SyncScheduleType = $null + } else { + $SyncScheduleType = $JsonParameters.PSobject.Properties["syncScheduleType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "syncInterval"))) { #optional property not found + $SyncInterval = $null + } else { + $SyncInterval = $JsonParameters.PSobject.Properties["syncInterval"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { #optional property not found + $EmailAddress = $null + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { #optional property not found + $Enabled = $null + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + $PSO = [PSCustomObject]@{ + "syncEnabled" = ${SyncEnabled} + "syncScheduleType" = ${SyncScheduleType} + "syncInterval" = ${SyncInterval} + "name" = ${Name} + "emailAddress" = ${EmailAddress} + "enabled" = ${Enabled} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateConnectorSmtpConnectionOptions.ps1 b/src/maislurp-client-powershell/Model/CreateConnectorSmtpConnectionOptions.ps1 new file mode 100644 index 00000000..e1b2c12b --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateConnectorSmtpConnectionOptions.ps1 @@ -0,0 +1,171 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Enabled +No description available. +.PARAMETER SmtpHost +No description available. +.PARAMETER SmtpPort +No description available. +.PARAMETER SmtpSsl +No description available. +.PARAMETER SmtpUsername +No description available. +.PARAMETER SmtpPassword +No description available. +.OUTPUTS + +CreateConnectorSmtpConnectionOptions +#> + +function Initialize-CreateConnectorSmtpConnectionOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Enabled}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpHost}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SmtpPort}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${SmtpSsl}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpUsername}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpPassword} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateConnectorSmtpConnectionOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($SmtpHost -eq $null) { + throw "invalid value for 'SmtpHost', 'SmtpHost' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "enabled" = ${Enabled} + "smtpHost" = ${SmtpHost} + "smtpPort" = ${SmtpPort} + "smtpSsl" = ${SmtpSsl} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateConnectorSmtpConnectionOptions + +.DESCRIPTION + +Convert from JSON to CreateConnectorSmtpConnectionOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateConnectorSmtpConnectionOptions +#> +function ConvertFrom-JsonToCreateConnectorSmtpConnectionOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateConnectorSmtpConnectionOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateConnectorSmtpConnectionOptions + $AllProperties = ("enabled", "smtpHost", "smtpPort", "smtpSsl", "smtpUsername", "smtpPassword") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'smtpHost' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpHost' missing." + } else { + $SmtpHost = $JsonParameters.PSobject.Properties["smtpHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "enabled"))) { #optional property not found + $Enabled = $null + } else { + $Enabled = $JsonParameters.PSobject.Properties["enabled"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPort"))) { #optional property not found + $SmtpPort = $null + } else { + $SmtpPort = $JsonParameters.PSobject.Properties["smtpPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpSsl"))) { #optional property not found + $SmtpSsl = $null + } else { + $SmtpSsl = $JsonParameters.PSobject.Properties["smtpSsl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpUsername"))) { #optional property not found + $SmtpUsername = $null + } else { + $SmtpUsername = $JsonParameters.PSobject.Properties["smtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPassword"))) { #optional property not found + $SmtpPassword = $null + } else { + $SmtpPassword = $JsonParameters.PSobject.Properties["smtpPassword"].value + } + + $PSO = [PSCustomObject]@{ + "enabled" = ${Enabled} + "smtpHost" = ${SmtpHost} + "smtpPort" = ${SmtpPort} + "smtpSsl" = ${SmtpSsl} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateContactOptions.ps1 b/src/maislurp-client-powershell/Model/CreateContactOptions.ps1 new file mode 100644 index 00000000..0a160bca --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateContactOptions.ps1 @@ -0,0 +1,210 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating an email contact in address book + +.PARAMETER FirstName +No description available. +.PARAMETER LastName +No description available. +.PARAMETER Company +No description available. +.PARAMETER EmailAddresses +Set of email addresses belonging to the contact +.PARAMETER Tags +Tags that can be used to search and group contacts +.PARAMETER MetaData +No description available. +.PARAMETER OptOut +Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions. +.PARAMETER GroupId +Group IDs that contact belongs to +.PARAMETER VerifyEmailAddresses +Whether to validate contact email address exists +.OUTPUTS + +CreateContactOptions +#> + +function Initialize-CreateContactOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${FirstName}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${LastName}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Company}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${EmailAddresses}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${MetaData}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${OptOut}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${GroupId}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${VerifyEmailAddresses} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateContactOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if (!$EmailAddresses -and $EmailAddresses.length -gt 1) { + throw "invalid value for 'EmailAddresses', number of items must be less than or equal to 1." + } + + if (!$EmailAddresses -and $EmailAddresses.length -lt 0) { + throw "invalid value for 'EmailAddresses', number of items must be greater than or equal to 0." + } + + + $PSO = [PSCustomObject]@{ + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "emailAddresses" = ${EmailAddresses} + "tags" = ${Tags} + "metaData" = ${MetaData} + "optOut" = ${OptOut} + "groupId" = ${GroupId} + "verifyEmailAddresses" = ${VerifyEmailAddresses} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateContactOptions + +.DESCRIPTION + +Convert from JSON to CreateContactOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateContactOptions +#> +function ConvertFrom-JsonToCreateContactOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateContactOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateContactOptions + $AllProperties = ("firstName", "lastName", "company", "emailAddresses", "tags", "metaData", "optOut", "groupId", "verifyEmailAddresses") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "firstName"))) { #optional property not found + $FirstName = $null + } else { + $FirstName = $JsonParameters.PSobject.Properties["firstName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lastName"))) { #optional property not found + $LastName = $null + } else { + $LastName = $JsonParameters.PSobject.Properties["lastName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "company"))) { #optional property not found + $Company = $null + } else { + $Company = $JsonParameters.PSobject.Properties["company"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddresses"))) { #optional property not found + $EmailAddresses = $null + } else { + $EmailAddresses = $JsonParameters.PSobject.Properties["emailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { #optional property not found + $Tags = $null + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "metaData"))) { #optional property not found + $MetaData = $null + } else { + $MetaData = $JsonParameters.PSobject.Properties["metaData"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "optOut"))) { #optional property not found + $OptOut = $null + } else { + $OptOut = $JsonParameters.PSobject.Properties["optOut"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "groupId"))) { #optional property not found + $GroupId = $null + } else { + $GroupId = $JsonParameters.PSobject.Properties["groupId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "verifyEmailAddresses"))) { #optional property not found + $VerifyEmailAddresses = $null + } else { + $VerifyEmailAddresses = $JsonParameters.PSobject.Properties["verifyEmailAddresses"].value + } + + $PSO = [PSCustomObject]@{ + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "emailAddresses" = ${EmailAddresses} + "tags" = ${Tags} + "metaData" = ${MetaData} + "optOut" = ${OptOut} + "groupId" = ${GroupId} + "verifyEmailAddresses" = ${VerifyEmailAddresses} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateDomainOptions.ps1 b/src/maislurp-client-powershell/Model/CreateDomainOptions.ps1 new file mode 100644 index 00000000..578b3fdc --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateDomainOptions.ps1 @@ -0,0 +1,146 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `mxslurp.click` while `HTTP` inboxes are handled by AWS SES. + +.PARAMETER Domain +The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. +.PARAMETER Description +Optional description of the domain. +.PARAMETER CreatedCatchAllInbox +Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. +.PARAMETER DomainType +Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. +.OUTPUTS + +CreateDomainOptions +#> + +function Initialize-CreateDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${CreatedCatchAllInbox}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_DOMAIN")] + [String] + ${DomainType} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + "description" = ${Description} + "createdCatchAllInbox" = ${CreatedCatchAllInbox} + "domainType" = ${DomainType} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateDomainOptions + +.DESCRIPTION + +Convert from JSON to CreateDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateDomainOptions +#> +function ConvertFrom-JsonToCreateDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateDomainOptions + $AllProperties = ("domain", "description", "createdCatchAllInbox", "domainType") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domain' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdCatchAllInbox"))) { #optional property not found + $CreatedCatchAllInbox = $null + } else { + $CreatedCatchAllInbox = $JsonParameters.PSobject.Properties["createdCatchAllInbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainType"))) { #optional property not found + $DomainType = $null + } else { + $DomainType = $JsonParameters.PSobject.Properties["domainType"].value + } + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + "description" = ${Description} + "createdCatchAllInbox" = ${CreatedCatchAllInbox} + "domainType" = ${DomainType} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateEmergencyAddressOptions.ps1 b/src/maislurp-client-powershell/Model/CreateEmergencyAddressOptions.ps1 new file mode 100644 index 00000000..f5355f0e --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateEmergencyAddressOptions.ps1 @@ -0,0 +1,205 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER CustomerName +No description available. +.PARAMETER Address1 +No description available. +.PARAMETER City +No description available. +.PARAMETER Region +No description available. +.PARAMETER PostalCode +No description available. +.PARAMETER IsoCountryCode +No description available. +.PARAMETER DisplayName +No description available. +.OUTPUTS + +CreateEmergencyAddressOptions +#> + +function Initialize-CreateEmergencyAddressOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${CustomerName}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Address1}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${City}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Region}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${PostalCode}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("US", "GB", "AU")] + [String] + ${IsoCountryCode}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${DisplayName} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateEmergencyAddressOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CustomerName -eq $null) { + throw "invalid value for 'CustomerName', 'CustomerName' cannot be null." + } + + if ($Address1 -eq $null) { + throw "invalid value for 'Address1', 'Address1' cannot be null." + } + + if ($City -eq $null) { + throw "invalid value for 'City', 'City' cannot be null." + } + + if ($Region -eq $null) { + throw "invalid value for 'Region', 'Region' cannot be null." + } + + if ($PostalCode -eq $null) { + throw "invalid value for 'PostalCode', 'PostalCode' cannot be null." + } + + if ($IsoCountryCode -eq $null) { + throw "invalid value for 'IsoCountryCode', 'IsoCountryCode' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "customerName" = ${CustomerName} + "address1" = ${Address1} + "city" = ${City} + "region" = ${Region} + "postalCode" = ${PostalCode} + "isoCountryCode" = ${IsoCountryCode} + "displayName" = ${DisplayName} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateEmergencyAddressOptions + +.DESCRIPTION + +Convert from JSON to CreateEmergencyAddressOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateEmergencyAddressOptions +#> +function ConvertFrom-JsonToCreateEmergencyAddressOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateEmergencyAddressOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateEmergencyAddressOptions + $AllProperties = ("customerName", "address1", "city", "region", "postalCode", "isoCountryCode", "displayName") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'customerName' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "customerName"))) { + throw "Error! JSON cannot be serialized due to the required property 'customerName' missing." + } else { + $CustomerName = $JsonParameters.PSobject.Properties["customerName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "address1"))) { + throw "Error! JSON cannot be serialized due to the required property 'address1' missing." + } else { + $Address1 = $JsonParameters.PSobject.Properties["address1"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "city"))) { + throw "Error! JSON cannot be serialized due to the required property 'city' missing." + } else { + $City = $JsonParameters.PSobject.Properties["city"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "region"))) { + throw "Error! JSON cannot be serialized due to the required property 'region' missing." + } else { + $Region = $JsonParameters.PSobject.Properties["region"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "postalCode"))) { + throw "Error! JSON cannot be serialized due to the required property 'postalCode' missing." + } else { + $PostalCode = $JsonParameters.PSobject.Properties["postalCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isoCountryCode"))) { + throw "Error! JSON cannot be serialized due to the required property 'isoCountryCode' missing." + } else { + $IsoCountryCode = $JsonParameters.PSobject.Properties["isoCountryCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "displayName"))) { #optional property not found + $DisplayName = $null + } else { + $DisplayName = $JsonParameters.PSobject.Properties["displayName"].value + } + + $PSO = [PSCustomObject]@{ + "customerName" = ${CustomerName} + "address1" = ${Address1} + "city" = ${City} + "region" = ${Region} + "postalCode" = ${PostalCode} + "isoCountryCode" = ${IsoCountryCode} + "displayName" = ${DisplayName} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateGroupOptions.ps1 b/src/maislurp-client-powershell/Model/CreateGroupOptions.ps1 new file mode 100644 index 00000000..f6babab9 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateGroupOptions.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Create contact group options + +.PARAMETER Name +No description available. +.PARAMETER Description +No description available. +.OUTPUTS + +CreateGroupOptions +#> + +function Initialize-CreateGroupOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateGroupOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "description" = ${Description} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateGroupOptions + +.DESCRIPTION + +Convert from JSON to CreateGroupOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateGroupOptions +#> +function ConvertFrom-JsonToCreateGroupOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateGroupOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateGroupOptions + $AllProperties = ("name", "description") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "description" = ${Description} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateInboxDto.ps1 b/src/maislurp-client-powershell/Model/CreateInboxDto.ps1 new file mode 100644 index 00000000..9afa6df9 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateInboxDto.ps1 @@ -0,0 +1,281 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are processed by a mail server running at `mailslurp.mx` while `HTTP` inboxes are processed by AWS SES backed mailservers. An inbox email address is randomly assigned by default ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). To specify an address use a custom domain: either pass the `emailAddress` options with `@`. To create a randomized address for your domain set the `domainName` to the domain you have verified or pass the `domainId`. Virtual inboxes prevent outbound sending and instead trap mail. + +.PARAMETER EmailAddress +A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. +.PARAMETER DomainName +FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. +.PARAMETER DomainId +ID of custom domain to use for email address. +.PARAMETER Name +Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. +.PARAMETER Description +Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with +.PARAMETER UseDomainPool +Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. +.PARAMETER Tags +Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. +.PARAMETER ExpiresAt +Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. +.PARAMETER Favourite +Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering +.PARAMETER ExpiresIn +Number of milliseconds that inbox should exist for +.PARAMETER AllowTeamAccess +DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. +.PARAMETER InboxType +Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). +.PARAMETER VirtualInbox +Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. +.PARAMETER UseShortAddress +Use a shorter email address under 31 characters +.PARAMETER Prefix +Prefix to add before the email address for easier labelling or identification. +.OUTPUTS + +CreateInboxDto +#> + +function Initialize-CreateInboxDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainName}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseDomainPool}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${ExpiresAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${ExpiresIn}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${AllowTeamAccess}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${VirtualInbox}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseShortAddress}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [String] + ${Prefix} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateInboxDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "domainName" = ${DomainName} + "domainId" = ${DomainId} + "name" = ${Name} + "description" = ${Description} + "useDomainPool" = ${UseDomainPool} + "tags" = ${Tags} + "expiresAt" = ${ExpiresAt} + "favourite" = ${Favourite} + "expiresIn" = ${ExpiresIn} + "allowTeamAccess" = ${AllowTeamAccess} + "inboxType" = ${InboxType} + "virtualInbox" = ${VirtualInbox} + "useShortAddress" = ${UseShortAddress} + "prefix" = ${Prefix} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateInboxDto + +.DESCRIPTION + +Convert from JSON to CreateInboxDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateInboxDto +#> +function ConvertFrom-JsonToCreateInboxDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateInboxDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateInboxDto + $AllProperties = ("emailAddress", "domainName", "domainId", "name", "description", "useDomainPool", "tags", "expiresAt", "favourite", "expiresIn", "allowTeamAccess", "inboxType", "virtualInbox", "useShortAddress", "prefix") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { #optional property not found + $EmailAddress = $null + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainName"))) { #optional property not found + $DomainName = $null + } else { + $DomainName = $JsonParameters.PSobject.Properties["domainName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useDomainPool"))) { #optional property not found + $UseDomainPool = $null + } else { + $UseDomainPool = $JsonParameters.PSobject.Properties["useDomainPool"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { #optional property not found + $Tags = $null + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "expiresAt"))) { #optional property not found + $ExpiresAt = $null + } else { + $ExpiresAt = $JsonParameters.PSobject.Properties["expiresAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "favourite"))) { #optional property not found + $Favourite = $null + } else { + $Favourite = $JsonParameters.PSobject.Properties["favourite"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "expiresIn"))) { #optional property not found + $ExpiresIn = $null + } else { + $ExpiresIn = $JsonParameters.PSobject.Properties["expiresIn"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "allowTeamAccess"))) { #optional property not found + $AllowTeamAccess = $null + } else { + $AllowTeamAccess = $JsonParameters.PSobject.Properties["allowTeamAccess"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxType"))) { #optional property not found + $InboxType = $null + } else { + $InboxType = $JsonParameters.PSobject.Properties["inboxType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virtualInbox"))) { #optional property not found + $VirtualInbox = $null + } else { + $VirtualInbox = $JsonParameters.PSobject.Properties["virtualInbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useShortAddress"))) { #optional property not found + $UseShortAddress = $null + } else { + $UseShortAddress = $JsonParameters.PSobject.Properties["useShortAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "prefix"))) { #optional property not found + $Prefix = $null + } else { + $Prefix = $JsonParameters.PSobject.Properties["prefix"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "domainName" = ${DomainName} + "domainId" = ${DomainId} + "name" = ${Name} + "description" = ${Description} + "useDomainPool" = ${UseDomainPool} + "tags" = ${Tags} + "expiresAt" = ${ExpiresAt} + "favourite" = ${Favourite} + "expiresIn" = ${ExpiresIn} + "allowTeamAccess" = ${AllowTeamAccess} + "inboxType" = ${InboxType} + "virtualInbox" = ${VirtualInbox} + "useShortAddress" = ${UseShortAddress} + "prefix" = ${Prefix} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateInboxForwarderOptions.ps1 b/src/maislurp-client-powershell/Model/CreateInboxForwarderOptions.ps1 new file mode 100644 index 00000000..8562ca8c --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateInboxForwarderOptions.ps1 @@ -0,0 +1,141 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating an inbox forwarder + +.PARAMETER Field +Field to match against to trigger inbox forwarding for inbound email +.PARAMETER Match +String or wildcard style match for field specified when evaluating forwarding rules +.PARAMETER ForwardToRecipients +Email addresses to forward an email to if it matches the field and match criteria of the forwarder +.OUTPUTS + +CreateInboxForwarderOptions +#> + +function Initialize-CreateInboxForwarderOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS")] + [String] + ${Field}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Match}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ForwardToRecipients} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateInboxForwarderOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Match -eq $null) { + throw "invalid value for 'Match', 'Match' cannot be null." + } + + if ($ForwardToRecipients -eq $null) { + throw "invalid value for 'ForwardToRecipients', 'ForwardToRecipients' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "field" = ${Field} + "match" = ${Match} + "forwardToRecipients" = ${ForwardToRecipients} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateInboxForwarderOptions + +.DESCRIPTION + +Convert from JSON to CreateInboxForwarderOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateInboxForwarderOptions +#> +function ConvertFrom-JsonToCreateInboxForwarderOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateInboxForwarderOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateInboxForwarderOptions + $AllProperties = ("field", "match", "forwardToRecipients") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'field' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "match"))) { + throw "Error! JSON cannot be serialized due to the required property 'match' missing." + } else { + $Match = $JsonParameters.PSobject.Properties["match"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "forwardToRecipients"))) { + throw "Error! JSON cannot be serialized due to the required property 'forwardToRecipients' missing." + } else { + $ForwardToRecipients = $JsonParameters.PSobject.Properties["forwardToRecipients"].value + } + + $PSO = [PSCustomObject]@{ + "field" = ${Field} + "match" = ${Match} + "forwardToRecipients" = ${ForwardToRecipients} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateInboxReplierOptions.ps1 b/src/maislurp-client-powershell/Model/CreateInboxReplierOptions.ps1 new file mode 100644 index 00000000..e7364bb2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateInboxReplierOptions.ps1 @@ -0,0 +1,271 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating an inbox replier. Repliers can be attached to inboxes and send automated responses when an inbound email matches given criteria. + +.PARAMETER InboxId +Inbox ID to attach replier to +.PARAMETER Name +Name for replier +.PARAMETER Field +Field to match against to trigger inbox replier for inbound email +.PARAMETER Match +String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything. +.PARAMETER ReplyTo +Reply-to email address when sending replying +.PARAMETER Subject +Subject override when replying to email +.PARAMETER VarFrom +Send email from address +.PARAMETER Charset +Email reply charset +.PARAMETER IgnoreReplyTo +Ignore sender replyTo when responding. Send directly to the sender if enabled. +.PARAMETER IsHTML +Send HTML email +.PARAMETER Body +Email body for reply +.PARAMETER TemplateId +ID of template to use when sending a reply +.PARAMETER TemplateVariables +Template variable values +.OUTPUTS + +CreateInboxReplierOptions +#> + +function Initialize-CreateInboxReplierOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS")] + [String] + ${Field}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Match}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IgnoreReplyTo}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsHTML}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String] + ${TemplateId}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateInboxReplierOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Match -eq $null) { + throw "invalid value for 'Match', 'Match' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "replyTo" = ${ReplyTo} + "subject" = ${Subject} + "from" = ${VarFrom} + "charset" = ${Charset} + "ignoreReplyTo" = ${IgnoreReplyTo} + "isHTML" = ${IsHTML} + "body" = ${Body} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateInboxReplierOptions + +.DESCRIPTION + +Convert from JSON to CreateInboxReplierOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateInboxReplierOptions +#> +function ConvertFrom-JsonToCreateInboxReplierOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateInboxReplierOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateInboxReplierOptions + $AllProperties = ("inboxId", "name", "field", "match", "replyTo", "subject", "from", "charset", "ignoreReplyTo", "isHTML", "body", "templateId", "templateVariables") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "match"))) { + throw "Error! JSON cannot be serialized due to the required property 'match' missing." + } else { + $Match = $JsonParameters.PSobject.Properties["match"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreReplyTo"))) { #optional property not found + $IgnoreReplyTo = $null + } else { + $IgnoreReplyTo = $JsonParameters.PSobject.Properties["ignoreReplyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { #optional property not found + $IsHTML = $null + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateId"))) { #optional property not found + $TemplateId = $null + } else { + $TemplateId = $JsonParameters.PSobject.Properties["templateId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "replyTo" = ${ReplyTo} + "subject" = ${Subject} + "from" = ${VarFrom} + "charset" = ${Charset} + "ignoreReplyTo" = ${IgnoreReplyTo} + "isHTML" = ${IsHTML} + "body" = ${Body} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateInboxRulesetOptions.ps1 b/src/maislurp-client-powershell/Model/CreateInboxRulesetOptions.ps1 new file mode 100644 index 00000000..71d54038 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateInboxRulesetOptions.ps1 @@ -0,0 +1,142 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or forward emails when sending or receiving using the inbox. + +.PARAMETER Scope +What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. +.PARAMETER Action +Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. +.PARAMETER Target +Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. +.OUTPUTS + +CreateInboxRulesetOptions +#> + +function Initialize-CreateInboxRulesetOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECEIVING_EMAILS", "SENDING_EMAILS")] + [String] + ${Scope}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("BLOCK", "ALLOW", "FILTER_REMOVE")] + [String] + ${Action}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Target} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateInboxRulesetOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Scope -eq $null) { + throw "invalid value for 'Scope', 'Scope' cannot be null." + } + + if ($Action -eq $null) { + throw "invalid value for 'Action', 'Action' cannot be null." + } + + if ($Target -eq $null) { + throw "invalid value for 'Target', 'Target' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "scope" = ${Scope} + "action" = ${Action} + "target" = ${Target} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateInboxRulesetOptions + +.DESCRIPTION + +Convert from JSON to CreateInboxRulesetOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateInboxRulesetOptions +#> +function ConvertFrom-JsonToCreateInboxRulesetOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateInboxRulesetOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateInboxRulesetOptions + $AllProperties = ("scope", "action", "target") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'scope' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "scope"))) { + throw "Error! JSON cannot be serialized due to the required property 'scope' missing." + } else { + $Scope = $JsonParameters.PSobject.Properties["scope"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "action"))) { + throw "Error! JSON cannot be serialized due to the required property 'action' missing." + } else { + $Action = $JsonParameters.PSobject.Properties["action"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "target"))) { + throw "Error! JSON cannot be serialized due to the required property 'target' missing." + } else { + $Target = $JsonParameters.PSobject.Properties["target"].value + } + + $PSO = [PSCustomObject]@{ + "scope" = ${Scope} + "action" = ${Action} + "target" = ${Target} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateTemplateOptions.ps1 b/src/maislurp-client-powershell/Model/CreateTemplateOptions.ps1 new file mode 100644 index 00000000..8b780fad --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateTemplateOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Create template options + +.PARAMETER Name +Name of template +.PARAMETER Content +Template content. Can include moustache style variables such as {{var_name}} +.OUTPUTS + +CreateTemplateOptions +#> + +function Initialize-CreateTemplateOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Content} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateTemplateOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Content -eq $null) { + throw "invalid value for 'Content', 'Content' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "content" = ${Content} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateTemplateOptions + +.DESCRIPTION + +Convert from JSON to CreateTemplateOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateTemplateOptions +#> +function ConvertFrom-JsonToCreateTemplateOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateTemplateOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateTemplateOptions + $AllProperties = ("name", "content") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { + throw "Error! JSON cannot be serialized due to the required property 'content' missing." + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "content" = ${Content} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateTrackingPixelOptions.ps1 b/src/maislurp-client-powershell/Model/CreateTrackingPixelOptions.ps1 new file mode 100644 index 00000000..9d573781 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateTrackingPixelOptions.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating a tracking pixel for email open tracking + +.PARAMETER Name +No description available. +.PARAMETER Recipient +No description available. +.OUTPUTS + +CreateTrackingPixelOptions +#> + +function Initialize-CreateTrackingPixelOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateTrackingPixelOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "recipient" = ${Recipient} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateTrackingPixelOptions + +.DESCRIPTION + +Convert from JSON to CreateTrackingPixelOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateTrackingPixelOptions +#> +function ConvertFrom-JsonToCreateTrackingPixelOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateTrackingPixelOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateTrackingPixelOptions + $AllProperties = ("name", "recipient") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { #optional property not found + $Recipient = $null + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "recipient" = ${Recipient} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/CreateWebhookOptions.ps1 b/src/maislurp-client-powershell/Model/CreateWebhookOptions.ps1 new file mode 100644 index 00000000..f74f39c1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/CreateWebhookOptions.ps1 @@ -0,0 +1,198 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale. Customize the payload sent to your endpoint by setting the `requestBodyTemplate` property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables. + +.PARAMETER Url +Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation. +.PARAMETER BasicAuth +No description available. +.PARAMETER Name +Optional name for the webhook +.PARAMETER EventName +Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. +.PARAMETER IncludeHeaders +No description available. +.PARAMETER RequestBodyTemplate +Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style `{{variableName}}` templating to use parts of the standard webhook payload for the given event. +.PARAMETER UseStaticIpRange +Use static IP range when calling webhook endpoint +.PARAMETER IgnoreInsecureSslCertificates +Ignore insecure SSL certificates when sending request. Useful for self-signed certs. +.OUTPUTS + +CreateWebhookOptions +#> + +function Initialize-CreateWebhookOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${BasicAuth}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${IncludeHeaders}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${RequestBodyTemplate}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseStaticIpRange} = $false, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IgnoreInsecureSslCertificates} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => CreateWebhookOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "basicAuth" = ${BasicAuth} + "name" = ${Name} + "eventName" = ${EventName} + "includeHeaders" = ${IncludeHeaders} + "requestBodyTemplate" = ${RequestBodyTemplate} + "useStaticIpRange" = ${UseStaticIpRange} + "ignoreInsecureSslCertificates" = ${IgnoreInsecureSslCertificates} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to CreateWebhookOptions + +.DESCRIPTION + +Convert from JSON to CreateWebhookOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +CreateWebhookOptions +#> +function ConvertFrom-JsonToCreateWebhookOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => CreateWebhookOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in CreateWebhookOptions + $AllProperties = ("url", "basicAuth", "name", "eventName", "includeHeaders", "requestBodyTemplate", "useStaticIpRange", "ignoreInsecureSslCertificates") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'url' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "basicAuth"))) { #optional property not found + $BasicAuth = $null + } else { + $BasicAuth = $JsonParameters.PSobject.Properties["basicAuth"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { #optional property not found + $EventName = $null + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "includeHeaders"))) { #optional property not found + $IncludeHeaders = $null + } else { + $IncludeHeaders = $JsonParameters.PSobject.Properties["includeHeaders"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "requestBodyTemplate"))) { #optional property not found + $RequestBodyTemplate = $null + } else { + $RequestBodyTemplate = $JsonParameters.PSobject.Properties["requestBodyTemplate"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useStaticIpRange"))) { #optional property not found + $UseStaticIpRange = $null + } else { + $UseStaticIpRange = $JsonParameters.PSobject.Properties["useStaticIpRange"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreInsecureSslCertificates"))) { #optional property not found + $IgnoreInsecureSslCertificates = $null + } else { + $IgnoreInsecureSslCertificates = $JsonParameters.PSobject.Properties["ignoreInsecureSslCertificates"].value + } + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "basicAuth" = ${BasicAuth} + "name" = ${Name} + "eventName" = ${EventName} + "includeHeaders" = ${IncludeHeaders} + "requestBodyTemplate" = ${RequestBodyTemplate} + "useStaticIpRange" = ${UseStaticIpRange} + "ignoreInsecureSslCertificates" = ${IgnoreInsecureSslCertificates} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DNSLookupOptions.ps1 b/src/maislurp-client-powershell/Model/DNSLookupOptions.ps1 new file mode 100644 index 00000000..479b492c --- /dev/null +++ b/src/maislurp-client-powershell/Model/DNSLookupOptions.ps1 @@ -0,0 +1,141 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for DNS query. + +.PARAMETER Hostname +List of record types you wish to query such as MX, DNS, TXT, NS, A etc. +.PARAMETER RecordTypes +List of record types you wish to query such as MX, DNS, TXT, NS, A etc. +.PARAMETER OmitFinalDNSDot +Optionally control whether to omit the final dot in full DNS name values. +.OUTPUTS + +DNSLookupOptions +#> + +function Initialize-DNSLookupOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Hostname}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String[]] + ${RecordTypes}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${OmitFinalDNSDot} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DNSLookupOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Hostname -eq $null) { + throw "invalid value for 'Hostname', 'Hostname' cannot be null." + } + + if ($RecordTypes -eq $null) { + throw "invalid value for 'RecordTypes', 'RecordTypes' cannot be null." + } + + if ($OmitFinalDNSDot -eq $null) { + throw "invalid value for 'OmitFinalDNSDot', 'OmitFinalDNSDot' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "hostname" = ${Hostname} + "recordTypes" = ${RecordTypes} + "omitFinalDNSDot" = ${OmitFinalDNSDot} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DNSLookupOptions + +.DESCRIPTION + +Convert from JSON to DNSLookupOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +DNSLookupOptions +#> +function ConvertFrom-JsonToDNSLookupOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DNSLookupOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DNSLookupOptions + $AllProperties = ("hostname", "recordTypes", "omitFinalDNSDot") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'hostname' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hostname"))) { + throw "Error! JSON cannot be serialized due to the required property 'hostname' missing." + } else { + $Hostname = $JsonParameters.PSobject.Properties["hostname"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recordTypes"))) { + throw "Error! JSON cannot be serialized due to the required property 'recordTypes' missing." + } else { + $RecordTypes = $JsonParameters.PSobject.Properties["recordTypes"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "omitFinalDNSDot"))) { + throw "Error! JSON cannot be serialized due to the required property 'omitFinalDNSDot' missing." + } else { + $OmitFinalDNSDot = $JsonParameters.PSobject.Properties["omitFinalDNSDot"].value + } + + $PSO = [PSCustomObject]@{ + "hostname" = ${Hostname} + "recordTypes" = ${RecordTypes} + "omitFinalDNSDot" = ${OmitFinalDNSDot} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DNSLookupResult.ps1 b/src/maislurp-client-powershell/Model/DNSLookupResult.ps1 new file mode 100644 index 00000000..d1c71159 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DNSLookupResult.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +DNS lookup result. Includes record type, time to live, raw response, and name value for the name server response. + +.PARAMETER RecordType +Domain Name Server Record Types +.PARAMETER Ttl +No description available. +.PARAMETER RecordEntries +No description available. +.PARAMETER Name +No description available. +.OUTPUTS + +DNSLookupResult +#> + +function Initialize-DNSLookupResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String] + ${RecordType}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Ttl}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${RecordEntries}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DNSLookupResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($RecordType -eq $null) { + throw "invalid value for 'RecordType', 'RecordType' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + if ($RecordEntries -eq $null) { + throw "invalid value for 'RecordEntries', 'RecordEntries' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "recordType" = ${RecordType} + "ttl" = ${Ttl} + "recordEntries" = ${RecordEntries} + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DNSLookupResult + +.DESCRIPTION + +Convert from JSON to DNSLookupResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +DNSLookupResult +#> +function ConvertFrom-JsonToDNSLookupResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DNSLookupResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DNSLookupResult + $AllProperties = ("recordType", "ttl", "recordEntries", "name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'recordType' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recordType"))) { + throw "Error! JSON cannot be serialized due to the required property 'recordType' missing." + } else { + $RecordType = $JsonParameters.PSobject.Properties["recordType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recordEntries"))) { + throw "Error! JSON cannot be serialized due to the required property 'recordEntries' missing." + } else { + $RecordEntries = $JsonParameters.PSobject.Properties["recordEntries"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "recordType" = ${RecordType} + "ttl" = ${Ttl} + "recordEntries" = ${RecordEntries} + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DNSLookupResults.ps1 b/src/maislurp-client-powershell/Model/DNSLookupResults.ps1 new file mode 100644 index 00000000..3ca0a58b --- /dev/null +++ b/src/maislurp-client-powershell/Model/DNSLookupResults.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Results of query on domain name servers + +.PARAMETER Results +No description available. +.OUTPUTS + +DNSLookupResults +#> + +function Initialize-DNSLookupResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Results} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DNSLookupResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Results -eq $null) { + throw "invalid value for 'Results', 'Results' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "results" = ${Results} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DNSLookupResults + +.DESCRIPTION + +Convert from JSON to DNSLookupResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +DNSLookupResults +#> +function ConvertFrom-JsonToDNSLookupResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DNSLookupResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DNSLookupResults + $AllProperties = ("results") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'results' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "results"))) { + throw "Error! JSON cannot be serialized due to the required property 'results' missing." + } else { + $Results = $JsonParameters.PSobject.Properties["results"].value + } + + $PSO = [PSCustomObject]@{ + "results" = ${Results} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DNSLookupsOptions.ps1 b/src/maislurp-client-powershell/Model/DNSLookupsOptions.ps1 new file mode 100644 index 00000000..f4c64a80 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DNSLookupsOptions.ps1 @@ -0,0 +1,114 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for multiple DNS queries + +.PARAMETER Lookups +No description available. +.OUTPUTS + +DNSLookupsOptions +#> + +function Initialize-DNSLookupsOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Lookups} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DNSLookupsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Lookups -eq $null) { + throw "invalid value for 'Lookups', 'Lookups' cannot be null." + } + + if ($Lookups.length -gt 10) { + throw "invalid value for 'Lookups', number of items must be less than or equal to 10." + } + + if ($Lookups.length -lt 1) { + throw "invalid value for 'Lookups', number of items must be greater than or equal to 1." + } + + + $PSO = [PSCustomObject]@{ + "lookups" = ${Lookups} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DNSLookupsOptions + +.DESCRIPTION + +Convert from JSON to DNSLookupsOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +DNSLookupsOptions +#> +function ConvertFrom-JsonToDNSLookupsOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DNSLookupsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DNSLookupsOptions + $AllProperties = ("lookups") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'lookups' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lookups"))) { + throw "Error! JSON cannot be serialized due to the required property 'lookups' missing." + } else { + $Lookups = $JsonParameters.PSobject.Properties["lookups"].value + } + + $PSO = [PSCustomObject]@{ + "lookups" = ${Lookups} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DeliveryStatusDto.ps1 b/src/maislurp-client-powershell/Model/DeliveryStatusDto.ps1 new file mode 100644 index 00000000..de346cfe --- /dev/null +++ b/src/maislurp-client-powershell/Model/DeliveryStatusDto.ps1 @@ -0,0 +1,287 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER SentId +No description available. +.PARAMETER RemoteMtaIp +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER ReportingMta +No description available. +.PARAMETER Recipients +No description available. +.PARAMETER SmtpResponse +No description available. +.PARAMETER SmtpStatusCode +No description available. +.PARAMETER ProcessingTimeMillis +No description available. +.PARAMETER Received +No description available. +.PARAMETER Subject +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +DeliveryStatusDto +#> + +function Initialize-DeliveryStatusDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${RemoteMtaIp}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReportingMta}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Recipients}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpResponse}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SmtpStatusCode}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${ProcessingTimeMillis}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Received}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DeliveryStatusDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "sentId" = ${SentId} + "remoteMtaIp" = ${RemoteMtaIp} + "inboxId" = ${InboxId} + "reportingMta" = ${ReportingMta} + "recipients" = ${Recipients} + "smtpResponse" = ${SmtpResponse} + "smtpStatusCode" = ${SmtpStatusCode} + "processingTimeMillis" = ${ProcessingTimeMillis} + "received" = ${Received} + "subject" = ${Subject} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DeliveryStatusDto + +.DESCRIPTION + +Convert from JSON to DeliveryStatusDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +DeliveryStatusDto +#> +function ConvertFrom-JsonToDeliveryStatusDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DeliveryStatusDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DeliveryStatusDto + $AllProperties = ("id", "userId", "sentId", "remoteMtaIp", "inboxId", "reportingMta", "recipients", "smtpResponse", "smtpStatusCode", "processingTimeMillis", "received", "subject", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentId"))) { #optional property not found + $SentId = $null + } else { + $SentId = $JsonParameters.PSobject.Properties["sentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "remoteMtaIp"))) { #optional property not found + $RemoteMtaIp = $null + } else { + $RemoteMtaIp = $JsonParameters.PSobject.Properties["remoteMtaIp"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reportingMta"))) { #optional property not found + $ReportingMta = $null + } else { + $ReportingMta = $JsonParameters.PSobject.Properties["reportingMta"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipients"))) { #optional property not found + $Recipients = $null + } else { + $Recipients = $JsonParameters.PSobject.Properties["recipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpResponse"))) { #optional property not found + $SmtpResponse = $null + } else { + $SmtpResponse = $JsonParameters.PSobject.Properties["smtpResponse"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpStatusCode"))) { #optional property not found + $SmtpStatusCode = $null + } else { + $SmtpStatusCode = $JsonParameters.PSobject.Properties["smtpStatusCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "processingTimeMillis"))) { #optional property not found + $ProcessingTimeMillis = $null + } else { + $ProcessingTimeMillis = $JsonParameters.PSobject.Properties["processingTimeMillis"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "received"))) { #optional property not found + $Received = $null + } else { + $Received = $JsonParameters.PSobject.Properties["received"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "sentId" = ${SentId} + "remoteMtaIp" = ${RemoteMtaIp} + "inboxId" = ${InboxId} + "reportingMta" = ${ReportingMta} + "recipients" = ${Recipients} + "smtpResponse" = ${SmtpResponse} + "smtpStatusCode" = ${SmtpStatusCode} + "processingTimeMillis" = ${ProcessingTimeMillis} + "received" = ${Received} + "subject" = ${Subject} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DescribeDomainOptions.ps1 b/src/maislurp-client-powershell/Model/DescribeDomainOptions.ps1 new file mode 100644 index 00000000..fb142547 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DescribeDomainOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Domain record description + +.PARAMETER Domain +No description available. +.OUTPUTS + +DescribeDomainOptions +#> + +function Initialize-DescribeDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DescribeDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DescribeDomainOptions + +.DESCRIPTION + +Convert from JSON to DescribeDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +DescribeDomainOptions +#> +function ConvertFrom-JsonToDescribeDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DescribeDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DescribeDomainOptions + $AllProperties = ("domain") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domain' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DescribeMailServerDomainResult.ps1 b/src/maislurp-client-powershell/Model/DescribeMailServerDomainResult.ps1 new file mode 100644 index 00000000..771bcc0d --- /dev/null +++ b/src/maislurp-client-powershell/Model/DescribeMailServerDomainResult.ps1 @@ -0,0 +1,136 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Name Server lookup result + +.PARAMETER MxRecords +No description available. +.PARAMETER Domain +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +DescribeMailServerDomainResult +#> + +function Initialize-DescribeMailServerDomainResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${MxRecords}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DescribeMailServerDomainResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MxRecords -eq $null) { + throw "invalid value for 'MxRecords', 'MxRecords' cannot be null." + } + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "mxRecords" = ${MxRecords} + "domain" = ${Domain} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DescribeMailServerDomainResult + +.DESCRIPTION + +Convert from JSON to DescribeMailServerDomainResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +DescribeMailServerDomainResult +#> +function ConvertFrom-JsonToDescribeMailServerDomainResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DescribeMailServerDomainResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DescribeMailServerDomainResult + $AllProperties = ("mxRecords", "domain", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'mxRecords' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mxRecords"))) { + throw "Error! JSON cannot be serialized due to the required property 'mxRecords' missing." + } else { + $MxRecords = $JsonParameters.PSobject.Properties["mxRecords"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "mxRecords" = ${MxRecords} + "domain" = ${Domain} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainDto.ps1 b/src/maislurp-client-powershell/Model/DomainDto.ps1 new file mode 100644 index 00000000..804b2ef7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainDto.ps1 @@ -0,0 +1,303 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Domain plus verification records and status + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER Domain +Custom domain name +.PARAMETER VerificationToken +Verification tokens +.PARAMETER DkimTokens +Unique token DKIM tokens +.PARAMETER MissingRecordsMessage +If the domain is missing records then show which pairs are missing. +.PARAMETER HasMissingRecords +Whether the domain has missing required records. If true then see the domain in the dashboard app. +.PARAMETER IsVerified +Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records. +.PARAMETER DomainNameRecords +List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider. +.PARAMETER CatchAllInboxId +The optional catch all inbox that will receive emails sent to the domain that cannot be matched. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.PARAMETER DomainType +Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. +.OUTPUTS + +DomainDto +#> + +function Initialize-DomainDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${VerificationToken}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${DkimTokens}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${MissingRecordsMessage}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${HasMissingRecords}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsVerified}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${DomainNameRecords}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${CatchAllInboxId}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_DOMAIN")] + [String] + ${DomainType} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + if ($VerificationToken -eq $null) { + throw "invalid value for 'VerificationToken', 'VerificationToken' cannot be null." + } + + if ($DkimTokens -eq $null) { + throw "invalid value for 'DkimTokens', 'DkimTokens' cannot be null." + } + + if ($HasMissingRecords -eq $null) { + throw "invalid value for 'HasMissingRecords', 'HasMissingRecords' cannot be null." + } + + if ($IsVerified -eq $null) { + throw "invalid value for 'IsVerified', 'IsVerified' cannot be null." + } + + if ($DomainNameRecords -eq $null) { + throw "invalid value for 'DomainNameRecords', 'DomainNameRecords' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($DomainType -eq $null) { + throw "invalid value for 'DomainType', 'DomainType' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "domain" = ${Domain} + "verificationToken" = ${VerificationToken} + "dkimTokens" = ${DkimTokens} + "missingRecordsMessage" = ${MissingRecordsMessage} + "hasMissingRecords" = ${HasMissingRecords} + "isVerified" = ${IsVerified} + "domainNameRecords" = ${DomainNameRecords} + "catchAllInboxId" = ${CatchAllInboxId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "domainType" = ${DomainType} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainDto + +.DESCRIPTION + +Convert from JSON to DomainDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainDto +#> +function ConvertFrom-JsonToDomainDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainDto + $AllProperties = ("id", "userId", "domain", "verificationToken", "dkimTokens", "missingRecordsMessage", "hasMissingRecords", "isVerified", "domainNameRecords", "catchAllInboxId", "createdAt", "updatedAt", "domainType") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "verificationToken"))) { + throw "Error! JSON cannot be serialized due to the required property 'verificationToken' missing." + } else { + $VerificationToken = $JsonParameters.PSobject.Properties["verificationToken"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "dkimTokens"))) { + throw "Error! JSON cannot be serialized due to the required property 'dkimTokens' missing." + } else { + $DkimTokens = $JsonParameters.PSobject.Properties["dkimTokens"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hasMissingRecords"))) { + throw "Error! JSON cannot be serialized due to the required property 'hasMissingRecords' missing." + } else { + $HasMissingRecords = $JsonParameters.PSobject.Properties["hasMissingRecords"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isVerified"))) { + throw "Error! JSON cannot be serialized due to the required property 'isVerified' missing." + } else { + $IsVerified = $JsonParameters.PSobject.Properties["isVerified"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainNameRecords"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainNameRecords' missing." + } else { + $DomainNameRecords = $JsonParameters.PSobject.Properties["domainNameRecords"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainType"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainType' missing." + } else { + $DomainType = $JsonParameters.PSobject.Properties["domainType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "missingRecordsMessage"))) { #optional property not found + $MissingRecordsMessage = $null + } else { + $MissingRecordsMessage = $JsonParameters.PSobject.Properties["missingRecordsMessage"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "catchAllInboxId"))) { #optional property not found + $CatchAllInboxId = $null + } else { + $CatchAllInboxId = $JsonParameters.PSobject.Properties["catchAllInboxId"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "domain" = ${Domain} + "verificationToken" = ${VerificationToken} + "dkimTokens" = ${DkimTokens} + "missingRecordsMessage" = ${MissingRecordsMessage} + "hasMissingRecords" = ${HasMissingRecords} + "isVerified" = ${IsVerified} + "domainNameRecords" = ${DomainNameRecords} + "catchAllInboxId" = ${CatchAllInboxId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "domainType" = ${DomainType} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainGroup.ps1 b/src/maislurp-client-powershell/Model/DomainGroup.ps1 new file mode 100644 index 00000000..800b212d --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainGroup.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Label +No description available. +.PARAMETER Domains +No description available. +.OUTPUTS + +DomainGroup +#> + +function Initialize-DomainGroup { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("DEFAULT", "DOMAIN_POOL", "CUSTOM")] + [String] + ${Label}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Domains} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainGroup' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Label -eq $null) { + throw "invalid value for 'Label', 'Label' cannot be null." + } + + if ($Domains -eq $null) { + throw "invalid value for 'Domains', 'Domains' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "label" = ${Label} + "domains" = ${Domains} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainGroup + +.DESCRIPTION + +Convert from JSON to DomainGroup + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainGroup +#> +function ConvertFrom-JsonToDomainGroup { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainGroup' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainGroup + $AllProperties = ("label", "domains") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'label' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "label"))) { + throw "Error! JSON cannot be serialized due to the required property 'label' missing." + } else { + $Label = $JsonParameters.PSobject.Properties["label"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domains"))) { + throw "Error! JSON cannot be serialized due to the required property 'domains' missing." + } else { + $Domains = $JsonParameters.PSobject.Properties["domains"].value + } + + $PSO = [PSCustomObject]@{ + "label" = ${Label} + "domains" = ${Domains} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainGroupsDto.ps1 b/src/maislurp-client-powershell/Model/DomainGroupsDto.ps1 new file mode 100644 index 00000000..715f680b --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainGroupsDto.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER DomainGroups +No description available. +.OUTPUTS + +DomainGroupsDto +#> + +function Initialize-DomainGroupsDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${DomainGroups} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainGroupsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($DomainGroups -eq $null) { + throw "invalid value for 'DomainGroups', 'DomainGroups' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "domainGroups" = ${DomainGroups} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainGroupsDto + +.DESCRIPTION + +Convert from JSON to DomainGroupsDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainGroupsDto +#> +function ConvertFrom-JsonToDomainGroupsDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainGroupsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainGroupsDto + $AllProperties = ("domainGroups") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domainGroups' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainGroups"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainGroups' missing." + } else { + $DomainGroups = $JsonParameters.PSobject.Properties["domainGroups"].value + } + + $PSO = [PSCustomObject]@{ + "domainGroups" = ${DomainGroups} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainInformation.ps1 b/src/maislurp-client-powershell/Model/DomainInformation.ps1 new file mode 100644 index 00000000..cb0e8304 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainInformation.ps1 @@ -0,0 +1,141 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER DomainName +No description available. +.PARAMETER Verified +No description available. +.PARAMETER DomainType +Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. +.OUTPUTS + +DomainInformation +#> + +function Initialize-DomainInformation { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainName}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Verified}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_DOMAIN")] + [String] + ${DomainType} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainInformation' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($DomainName -eq $null) { + throw "invalid value for 'DomainName', 'DomainName' cannot be null." + } + + if ($Verified -eq $null) { + throw "invalid value for 'Verified', 'Verified' cannot be null." + } + + if ($DomainType -eq $null) { + throw "invalid value for 'DomainType', 'DomainType' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "domainName" = ${DomainName} + "verified" = ${Verified} + "domainType" = ${DomainType} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainInformation + +.DESCRIPTION + +Convert from JSON to DomainInformation + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainInformation +#> +function ConvertFrom-JsonToDomainInformation { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainInformation' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainInformation + $AllProperties = ("domainName", "verified", "domainType") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domainName' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainName"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainName' missing." + } else { + $DomainName = $JsonParameters.PSobject.Properties["domainName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "verified"))) { + throw "Error! JSON cannot be serialized due to the required property 'verified' missing." + } else { + $Verified = $JsonParameters.PSobject.Properties["verified"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainType"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainType' missing." + } else { + $DomainType = $JsonParameters.PSobject.Properties["domainType"].value + } + + $PSO = [PSCustomObject]@{ + "domainName" = ${DomainName} + "verified" = ${Verified} + "domainType" = ${DomainType} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainIssuesDto.ps1 b/src/maislurp-client-powershell/Model/DomainIssuesDto.ps1 new file mode 100644 index 00000000..bcaa12b9 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainIssuesDto.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER HasIssues +No description available. +.OUTPUTS + +DomainIssuesDto +#> + +function Initialize-DomainIssuesDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${HasIssues} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainIssuesDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($HasIssues -eq $null) { + throw "invalid value for 'HasIssues', 'HasIssues' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "hasIssues" = ${HasIssues} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainIssuesDto + +.DESCRIPTION + +Convert from JSON to DomainIssuesDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainIssuesDto +#> +function ConvertFrom-JsonToDomainIssuesDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainIssuesDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainIssuesDto + $AllProperties = ("hasIssues") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'hasIssues' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hasIssues"))) { + throw "Error! JSON cannot be serialized due to the required property 'hasIssues' missing." + } else { + $HasIssues = $JsonParameters.PSobject.Properties["hasIssues"].value + } + + $PSO = [PSCustomObject]@{ + "hasIssues" = ${HasIssues} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainNameRecord.ps1 b/src/maislurp-client-powershell/Model/DomainNameRecord.ps1 new file mode 100644 index 00000000..d00cb2f4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainNameRecord.ps1 @@ -0,0 +1,193 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +DNS Record required for verification of a domain. Record vary depending on domain type. + +.PARAMETER Label +Domain Name Server Record Label +.PARAMETER Required +No description available. +.PARAMETER RecordType +Domain Name Server Record Types +.PARAMETER Name +No description available. +.PARAMETER RecordEntries +No description available. +.PARAMETER Ttl +No description available. +.OUTPUTS + +DomainNameRecord +#> + +function Initialize-DomainNameRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("VERIFICATION", "MX", "SPF", "DKIM", "DMARC")] + [String] + ${Label}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Required}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String] + ${RecordType}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${RecordEntries}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Ttl} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainNameRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Label -eq $null) { + throw "invalid value for 'Label', 'Label' cannot be null." + } + + if ($Required -eq $null) { + throw "invalid value for 'Required', 'Required' cannot be null." + } + + if ($RecordType -eq $null) { + throw "invalid value for 'RecordType', 'RecordType' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($RecordEntries -eq $null) { + throw "invalid value for 'RecordEntries', 'RecordEntries' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "label" = ${Label} + "required" = ${Required} + "recordType" = ${RecordType} + "name" = ${Name} + "recordEntries" = ${RecordEntries} + "ttl" = ${Ttl} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainNameRecord + +.DESCRIPTION + +Convert from JSON to DomainNameRecord + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainNameRecord +#> +function ConvertFrom-JsonToDomainNameRecord { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainNameRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainNameRecord + $AllProperties = ("label", "required", "recordType", "name", "recordEntries", "ttl") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'label' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "label"))) { + throw "Error! JSON cannot be serialized due to the required property 'label' missing." + } else { + $Label = $JsonParameters.PSobject.Properties["label"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "required"))) { + throw "Error! JSON cannot be serialized due to the required property 'required' missing." + } else { + $Required = $JsonParameters.PSobject.Properties["required"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recordType"))) { + throw "Error! JSON cannot be serialized due to the required property 'recordType' missing." + } else { + $RecordType = $JsonParameters.PSobject.Properties["recordType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recordEntries"))) { + throw "Error! JSON cannot be serialized due to the required property 'recordEntries' missing." + } else { + $RecordEntries = $JsonParameters.PSobject.Properties["recordEntries"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + $PSO = [PSCustomObject]@{ + "label" = ${Label} + "required" = ${Required} + "recordType" = ${RecordType} + "name" = ${Name} + "recordEntries" = ${RecordEntries} + "ttl" = ${Ttl} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DomainPreview.ps1 b/src/maislurp-client-powershell/Model/DomainPreview.ps1 new file mode 100644 index 00000000..003612d5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/DomainPreview.ps1 @@ -0,0 +1,205 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Preview object for domain entity + +.PARAMETER Id +No description available. +.PARAMETER Domain +No description available. +.PARAMETER CatchAllInboxId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER DomainType +Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. +.PARAMETER IsVerified +No description available. +.PARAMETER HasMissingRecords +No description available. +.OUTPUTS + +DomainPreview +#> + +function Initialize-DomainPreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${CatchAllInboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_DOMAIN")] + [String] + ${DomainType}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsVerified}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${HasMissingRecords} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DomainPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($DomainType -eq $null) { + throw "invalid value for 'DomainType', 'DomainType' cannot be null." + } + + if ($IsVerified -eq $null) { + throw "invalid value for 'IsVerified', 'IsVerified' cannot be null." + } + + if ($HasMissingRecords -eq $null) { + throw "invalid value for 'HasMissingRecords', 'HasMissingRecords' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domain" = ${Domain} + "catchAllInboxId" = ${CatchAllInboxId} + "createdAt" = ${CreatedAt} + "domainType" = ${DomainType} + "isVerified" = ${IsVerified} + "hasMissingRecords" = ${HasMissingRecords} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DomainPreview + +.DESCRIPTION + +Convert from JSON to DomainPreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +DomainPreview +#> +function ConvertFrom-JsonToDomainPreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DomainPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DomainPreview + $AllProperties = ("id", "domain", "catchAllInboxId", "createdAt", "domainType", "isVerified", "hasMissingRecords") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainType"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainType' missing." + } else { + $DomainType = $JsonParameters.PSobject.Properties["domainType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isVerified"))) { + throw "Error! JSON cannot be serialized due to the required property 'isVerified' missing." + } else { + $IsVerified = $JsonParameters.PSobject.Properties["isVerified"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hasMissingRecords"))) { + throw "Error! JSON cannot be serialized due to the required property 'hasMissingRecords' missing." + } else { + $HasMissingRecords = $JsonParameters.PSobject.Properties["hasMissingRecords"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "catchAllInboxId"))) { #optional property not found + $CatchAllInboxId = $null + } else { + $CatchAllInboxId = $JsonParameters.PSobject.Properties["catchAllInboxId"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domain" = ${Domain} + "catchAllInboxId" = ${CatchAllInboxId} + "createdAt" = ${CreatedAt} + "domainType" = ${DomainType} + "isVerified" = ${IsVerified} + "hasMissingRecords" = ${HasMissingRecords} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/DownloadAttachmentDto.ps1 b/src/maislurp-client-powershell/Model/DownloadAttachmentDto.ps1 new file mode 100644 index 00000000..01494dec --- /dev/null +++ b/src/maislurp-client-powershell/Model/DownloadAttachmentDto.ps1 @@ -0,0 +1,140 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Content of attachment + +.PARAMETER Base64FileContents +Base64 encoded string of attachment bytes. Decode the base64 encoded string to get the raw contents. If the file has a content type such as `text/html` you can read the contents directly by converting it to string using `utf-8` encoding. +.PARAMETER ContentType +Content type of attachment. Examples are `image/png`, `application/msword`, `text/csv` etc. +.PARAMETER SizeBytes +Size in bytes of attachment content +.OUTPUTS + +DownloadAttachmentDto +#> + +function Initialize-DownloadAttachmentDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Base64FileContents}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${SizeBytes} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => DownloadAttachmentDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Base64FileContents -eq $null) { + throw "invalid value for 'Base64FileContents', 'Base64FileContents' cannot be null." + } + + if ($ContentType -eq $null) { + throw "invalid value for 'ContentType', 'ContentType' cannot be null." + } + + if ($SizeBytes -eq $null) { + throw "invalid value for 'SizeBytes', 'SizeBytes' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "base64FileContents" = ${Base64FileContents} + "contentType" = ${ContentType} + "sizeBytes" = ${SizeBytes} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to DownloadAttachmentDto + +.DESCRIPTION + +Convert from JSON to DownloadAttachmentDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +DownloadAttachmentDto +#> +function ConvertFrom-JsonToDownloadAttachmentDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => DownloadAttachmentDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in DownloadAttachmentDto + $AllProperties = ("base64FileContents", "contentType", "sizeBytes") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'base64FileContents' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "base64FileContents"))) { + throw "Error! JSON cannot be serialized due to the required property 'base64FileContents' missing." + } else { + $Base64FileContents = $JsonParameters.PSobject.Properties["base64FileContents"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentType' missing." + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sizeBytes"))) { + throw "Error! JSON cannot be serialized due to the required property 'sizeBytes' missing." + } else { + $SizeBytes = $JsonParameters.PSobject.Properties["sizeBytes"].value + } + + $PSO = [PSCustomObject]@{ + "base64FileContents" = ${Base64FileContents} + "contentType" = ${ContentType} + "sizeBytes" = ${SizeBytes} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/Email.ps1 b/src/maislurp-client-powershell/Model/Email.ps1 new file mode 100644 index 00000000..4e066aa5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/Email.ps1 @@ -0,0 +1,511 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The `body` contains the email content. If you want the original SMTP message see the `getRawEmail` endpoints. The attachments can be fetched using the AttachmentController + +.PARAMETER Id +ID of the email entity +.PARAMETER UserId +ID of user that email belongs to +.PARAMETER InboxId +ID of the inbox that received the email +.PARAMETER DomainId +ID of the domain that received the email +.PARAMETER To +List of `To` recipient email addresses that the email was addressed to. See recipients object for names. +.PARAMETER VarFrom +Who the email was sent from. An email address - see fromName for the sender name. +.PARAMETER VarSender +No description available. +.PARAMETER Recipients +No description available. +.PARAMETER ReplyTo +The `replyTo` field on the received email message +.PARAMETER Cc +List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. +.PARAMETER Bcc +List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. +.PARAMETER Headers +Collection of SMTP headers attached to email +.PARAMETER HeadersMap +Multi-value map of SMTP headers attached to email +.PARAMETER Attachments +List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension. +.PARAMETER Subject +The subject line of the email message as specified by SMTP subject header +.PARAMETER Body +The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests. +.PARAMETER BodyExcerpt +An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not +.PARAMETER TextExcerpt +An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists +.PARAMETER BodyMD5Hash +A hash signature of the email message using MD5. Useful for comparing emails without fetching full body. +.PARAMETER IsHTML +Is the email body content type HTML? +.PARAMETER Charset +Detected character set of the email body such as UTF-8 +.PARAMETER Analysis +No description available. +.PARAMETER CreatedAt +When was the email received by MailSlurp +.PARAMETER UpdatedAt +When was the email last updated +.PARAMETER Read +Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks. +.PARAMETER TeamAccess +Can the email be accessed by organization team members +.PARAMETER IsXAmpHtml +Is the email body content type x-amp-html Amp4Email? +.PARAMETER BodyPartContentTypes +A list of detected multipart mime message body part content types such as text/plain and text/html. Can be used with email bodyPart endpoints to fetch individual body parts. +.PARAMETER Html +No description available. +.PARAMETER XampHtml +No description available. +.OUTPUTS + +Email +#> + +function Initialize-Email { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${VarSender}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Recipients}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${Headers}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${HeadersMap}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 16, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyExcerpt}, + [Parameter(Position = 17, ValueFromPipelineByPropertyName = $true)] + [String] + ${TextExcerpt}, + [Parameter(Position = 18, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyMD5Hash}, + [Parameter(Position = 19, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsHTML}, + [Parameter(Position = 20, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 21, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Analysis}, + [Parameter(Position = 22, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 23, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 24, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read}, + [Parameter(Position = 25, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${TeamAccess}, + [Parameter(Position = 26, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsXAmpHtml}, + [Parameter(Position = 27, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${BodyPartContentTypes}, + [Parameter(Position = 28, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Html}, + [Parameter(Position = 29, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${XampHtml} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => Email' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + if ($TeamAccess -eq $null) { + throw "invalid value for 'TeamAccess', 'TeamAccess' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "domainId" = ${DomainId} + "to" = ${To} + "from" = ${VarFrom} + "sender" = ${VarSender} + "recipients" = ${Recipients} + "replyTo" = ${ReplyTo} + "cc" = ${Cc} + "bcc" = ${Bcc} + "headers" = ${Headers} + "headersMap" = ${HeadersMap} + "attachments" = ${Attachments} + "subject" = ${Subject} + "body" = ${Body} + "bodyExcerpt" = ${BodyExcerpt} + "textExcerpt" = ${TextExcerpt} + "bodyMD5Hash" = ${BodyMD5Hash} + "isHTML" = ${IsHTML} + "charset" = ${Charset} + "analysis" = ${Analysis} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "read" = ${Read} + "teamAccess" = ${TeamAccess} + "isXAmpHtml" = ${IsXAmpHtml} + "bodyPartContentTypes" = ${BodyPartContentTypes} + "html" = ${Html} + "xampHtml" = ${XampHtml} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to Email + +.DESCRIPTION + +Convert from JSON to Email + +.PARAMETER Json + +Json object + +.OUTPUTS + +Email +#> +function ConvertFrom-JsonToEmail { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => Email' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in Email + $AllProperties = ("id", "userId", "inboxId", "domainId", "to", "from", "sender", "recipients", "replyTo", "cc", "bcc", "headers", "headersMap", "attachments", "subject", "body", "bodyExcerpt", "textExcerpt", "bodyMD5Hash", "isHTML", "charset", "analysis", "createdAt", "updatedAt", "read", "teamAccess", "isXAmpHtml", "bodyPartContentTypes", "html", "xampHtml") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "teamAccess"))) { + throw "Error! JSON cannot be serialized due to the required property 'teamAccess' missing." + } else { + $TeamAccess = $JsonParameters.PSobject.Properties["teamAccess"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sender"))) { #optional property not found + $VarSender = $null + } else { + $VarSender = $JsonParameters.PSobject.Properties["sender"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipients"))) { #optional property not found + $Recipients = $null + } else { + $Recipients = $JsonParameters.PSobject.Properties["recipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "headers"))) { #optional property not found + $Headers = $null + } else { + $Headers = $JsonParameters.PSobject.Properties["headers"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "headersMap"))) { #optional property not found + $HeadersMap = $null + } else { + $HeadersMap = $JsonParameters.PSobject.Properties["headersMap"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyExcerpt"))) { #optional property not found + $BodyExcerpt = $null + } else { + $BodyExcerpt = $JsonParameters.PSobject.Properties["bodyExcerpt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "textExcerpt"))) { #optional property not found + $TextExcerpt = $null + } else { + $TextExcerpt = $JsonParameters.PSobject.Properties["textExcerpt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyMD5Hash"))) { #optional property not found + $BodyMD5Hash = $null + } else { + $BodyMD5Hash = $JsonParameters.PSobject.Properties["bodyMD5Hash"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { #optional property not found + $IsHTML = $null + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "analysis"))) { #optional property not found + $Analysis = $null + } else { + $Analysis = $JsonParameters.PSobject.Properties["analysis"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isXAmpHtml"))) { #optional property not found + $IsXAmpHtml = $null + } else { + $IsXAmpHtml = $JsonParameters.PSobject.Properties["isXAmpHtml"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyPartContentTypes"))) { #optional property not found + $BodyPartContentTypes = $null + } else { + $BodyPartContentTypes = $JsonParameters.PSobject.Properties["bodyPartContentTypes"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { #optional property not found + $Html = $null + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "xampHtml"))) { #optional property not found + $XampHtml = $null + } else { + $XampHtml = $JsonParameters.PSobject.Properties["xampHtml"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "domainId" = ${DomainId} + "to" = ${To} + "from" = ${VarFrom} + "sender" = ${VarSender} + "recipients" = ${Recipients} + "replyTo" = ${ReplyTo} + "cc" = ${Cc} + "bcc" = ${Bcc} + "headers" = ${Headers} + "headersMap" = ${HeadersMap} + "attachments" = ${Attachments} + "subject" = ${Subject} + "body" = ${Body} + "bodyExcerpt" = ${BodyExcerpt} + "textExcerpt" = ${TextExcerpt} + "bodyMD5Hash" = ${BodyMD5Hash} + "isHTML" = ${IsHTML} + "charset" = ${Charset} + "analysis" = ${Analysis} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "read" = ${Read} + "teamAccess" = ${TeamAccess} + "isXAmpHtml" = ${IsXAmpHtml} + "bodyPartContentTypes" = ${BodyPartContentTypes} + "html" = ${Html} + "xampHtml" = ${XampHtml} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailAnalysis.ps1 b/src/maislurp-client-powershell/Model/EmailAnalysis.ps1 new file mode 100644 index 00000000..4f02d481 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailAnalysis.ps1 @@ -0,0 +1,150 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error message + +.PARAMETER SpamVerdict +Verdict of spam ranking analysis +.PARAMETER VirusVerdict +Verdict of virus scan analysis +.PARAMETER SpfVerdict +Verdict of Send Policy Framework record spoofing analysis +.PARAMETER DkimVerdict +Verdict of DomainKeys Identified Mail analysis +.PARAMETER DmarcVerdict +Verdict of Domain-based Message Authentication Reporting and Conformance analysis +.OUTPUTS + +EmailAnalysis +#> + +function Initialize-EmailAnalysis { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SpamVerdict}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${VirusVerdict}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SpfVerdict}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${DkimVerdict}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${DmarcVerdict} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailAnalysis' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "spamVerdict" = ${SpamVerdict} + "virusVerdict" = ${VirusVerdict} + "spfVerdict" = ${SpfVerdict} + "dkimVerdict" = ${DkimVerdict} + "dmarcVerdict" = ${DmarcVerdict} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailAnalysis + +.DESCRIPTION + +Convert from JSON to EmailAnalysis + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailAnalysis +#> +function ConvertFrom-JsonToEmailAnalysis { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailAnalysis' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailAnalysis + $AllProperties = ("spamVerdict", "virusVerdict", "spfVerdict", "dkimVerdict", "dmarcVerdict") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "spamVerdict"))) { #optional property not found + $SpamVerdict = $null + } else { + $SpamVerdict = $JsonParameters.PSobject.Properties["spamVerdict"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virusVerdict"))) { #optional property not found + $VirusVerdict = $null + } else { + $VirusVerdict = $JsonParameters.PSobject.Properties["virusVerdict"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "spfVerdict"))) { #optional property not found + $SpfVerdict = $null + } else { + $SpfVerdict = $JsonParameters.PSobject.Properties["spfVerdict"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "dkimVerdict"))) { #optional property not found + $DkimVerdict = $null + } else { + $DkimVerdict = $JsonParameters.PSobject.Properties["dkimVerdict"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "dmarcVerdict"))) { #optional property not found + $DmarcVerdict = $null + } else { + $DmarcVerdict = $JsonParameters.PSobject.Properties["dmarcVerdict"].value + } + + $PSO = [PSCustomObject]@{ + "spamVerdict" = ${SpamVerdict} + "virusVerdict" = ${VirusVerdict} + "spfVerdict" = ${SpfVerdict} + "dkimVerdict" = ${DkimVerdict} + "dmarcVerdict" = ${DmarcVerdict} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailContentMatchResult.ps1 b/src/maislurp-client-powershell/Model/EmailContentMatchResult.ps1 new file mode 100644 index 00000000..1d29738f --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailContentMatchResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Matches for the given pattern + +.PARAMETER Pattern +No description available. +.PARAMETER VarMatches +No description available. +.OUTPUTS + +EmailContentMatchResult +#> + +function Initialize-EmailContentMatchResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Pattern}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${VarMatches} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailContentMatchResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Pattern -eq $null) { + throw "invalid value for 'Pattern', 'Pattern' cannot be null." + } + + if ($VarMatches -eq $null) { + throw "invalid value for 'VarMatches', 'VarMatches' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "pattern" = ${Pattern} + "matches" = ${VarMatches} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailContentMatchResult + +.DESCRIPTION + +Convert from JSON to EmailContentMatchResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailContentMatchResult +#> +function ConvertFrom-JsonToEmailContentMatchResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailContentMatchResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailContentMatchResult + $AllProperties = ("pattern", "matches") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'pattern' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pattern"))) { + throw "Error! JSON cannot be serialized due to the required property 'pattern' missing." + } else { + $Pattern = $JsonParameters.PSobject.Properties["pattern"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "matches"))) { + throw "Error! JSON cannot be serialized due to the required property 'matches' missing." + } else { + $VarMatches = $JsonParameters.PSobject.Properties["matches"].value + } + + $PSO = [PSCustomObject]@{ + "pattern" = ${Pattern} + "matches" = ${VarMatches} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailContentPartResult.ps1 b/src/maislurp-client-powershell/Model/EmailContentPartResult.ps1 new file mode 100644 index 00000000..86374aaa --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailContentPartResult.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Content +No description available. +.OUTPUTS + +EmailContentPartResult +#> + +function Initialize-EmailContentPartResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Content} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailContentPartResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailContentPartResult + +.DESCRIPTION + +Convert from JSON to EmailContentPartResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailContentPartResult +#> +function ConvertFrom-JsonToEmailContentPartResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailContentPartResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailContentPartResult + $AllProperties = ("content") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureCategoryName.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureCategoryName.ps1 new file mode 100644 index 00000000..e6ab4f5c --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureCategoryName.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Slug +No description available. +.PARAMETER Name +No description available. +.OUTPUTS + +EmailFeatureCategoryName +#> + +function Initialize-EmailFeatureCategoryName { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("css", "html", "image", "others")] + [String] + ${Slug}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureCategoryName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Slug -eq $null) { + throw "invalid value for 'Slug', 'Slug' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "slug" = ${Slug} + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureCategoryName + +.DESCRIPTION + +Convert from JSON to EmailFeatureCategoryName + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureCategoryName +#> +function ConvertFrom-JsonToEmailFeatureCategoryName { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureCategoryName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureCategoryName + $AllProperties = ("slug", "name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'slug' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "slug"))) { + throw "Error! JSON cannot be serialized due to the required property 'slug' missing." + } else { + $Slug = $JsonParameters.PSobject.Properties["slug"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "slug" = ${Slug} + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureFamilyName.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureFamilyName.ps1 new file mode 100644 index 00000000..10277ee9 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureFamilyName.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Slug +No description available. +.PARAMETER Name +No description available. +.OUTPUTS + +EmailFeatureFamilyName +#> + +function Initialize-EmailFeatureFamilyName { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("aol", "apple-mail", "fastmail", "free-fr", "gmail", "gmx", "hey", "ionos-1and1", "laposte", "mail-ru", "microsoft", "orange", "outlook", "protonmail", "rainloop", "samsung-email", "sfr", "t-online-de", "thunderbird", "web-de", "yahoo")] + [String] + ${Slug}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureFamilyName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Slug -eq $null) { + throw "invalid value for 'Slug', 'Slug' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "slug" = ${Slug} + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureFamilyName + +.DESCRIPTION + +Convert from JSON to EmailFeatureFamilyName + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureFamilyName +#> +function ConvertFrom-JsonToEmailFeatureFamilyName { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureFamilyName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureFamilyName + $AllProperties = ("slug", "name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'slug' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "slug"))) { + throw "Error! JSON cannot be serialized due to the required property 'slug' missing." + } else { + $Slug = $JsonParameters.PSobject.Properties["slug"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "slug" = ${Slug} + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureFamilyStatistics.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureFamilyStatistics.ps1 new file mode 100644 index 00000000..13b17471 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureFamilyStatistics.ps1 @@ -0,0 +1,142 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Feature +No description available. +.PARAMETER Family +No description available. +.PARAMETER Platforms +No description available. +.OUTPUTS + +EmailFeatureFamilyStatistics +#> + +function Initialize-EmailFeatureFamilyStatistics { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("amp", "css-accent-color", "css-align-items", "css-animation", "css-aspect-ratio", "css-at-font-face", "css-at-import", "css-at-keyframes", "css-at-media", "css-at-supports", "css-background-blend-mode", "css-background-clip", "css-background-color", "css-background-image", "css-background-origin", "css-background-position", "css-background-repeat", "css-background-size", "css-background", "css-block-inline-size", "css-border-image", "css-border-inline-block-individual", "css-border-inline-block-longhand", "css-border-inline-block", "css-border-radius-logical", "css-border-radius", "css-border", "css-box-shadow", "css-box-sizing", "css-caption-side", "css-clip-path", "css-column-count", "css-column-layout-properties", "css-direction", "css-display-flex", "css-display-grid", "css-display-none", "css-display", "css-filter", "css-flex-direction", "css-flex-wrap", "css-float", "css-font-kerning", "css-font-weight", "css-font", "css-gap", "css-grid-template", "css-height", "css-hyphens", "css-inline-size", "css-justify-content", "css-left-right-top-bottom", "css-letter-spacing", "css-line-height", "css-list-style-image", "css-list-style-position", "css-list-style-type", "css-list-style", "css-margin-block-start-end", "css-margin-inline-block", "css-margin-inline-start-end", "css-margin-inline", "css-margin", "css-max-block-size", "css-max-height", "css-max-width", "css-min-height", "css-min-inline-size", "css-min-width", "css-mix-blend-mode", "css-object-fit", "css-object-position", "css-opacity", "css-outline-offset", "css-outline", "css-overflow-wrap", "css-overflow", "css-padding-block-start-end", "css-padding-inline-block", "css-padding-inline-start-end", "css-padding", "css-position", "css-tab-size", "css-table-layout", "css-text-align-last", "css-text-align", "css-text-decoration-color", "css-text-decoration-thickness", "css-text-decoration", "css-text-emphasis-position", "css-text-emphasis", "css-text-indent", "css-text-overflow", "css-text-shadow", "css-text-transform", "css-text-underline-offset", "css-transform", "css-vertical-align", "css-visibility", "css-white-space", "css-width", "css-word-break", "css-writing-mode", "css-z-index", "html-abbr", "html-address", "html-align", "html-anchor-links", "html-aria-describedby", "html-aria-hidden", "html-aria-label", "html-aria-labelledby", "html-aria-live", "html-audio", "html-background", "html-base", "html-blockquote", "html-body", "html-button-reset", "html-button-submit", "html-code", "html-del", "html-dfn", "html-dialog", "html-dir", "html-div", "html-doctype", "html-form", "html-h1-h6", "html-height", "html-image-maps", "html-input-checkbox", "html-input-hidden", "html-input-radio", "html-input-reset", "html-input-submit", "html-input-text", "html-lang", "html-link", "html-lists", "html-loading-attribute", "html-mailto-links", "html-marquee", "html-meter", "html-object", "html-p", "html-picture", "html-pre", "html-progress", "html-required", "html-role", "html-rp", "html-rt", "html-ruby", "html-select", "html-semantics", "html-small", "html-span", "html-srcset", "html-strike", "html-strong", "html-style", "html-svg", "html-table", "html-target", "html-textarea", "html-valign", "html-video", "html-wbr", "html-width", "image-avif", "image-base64", "image-bmp", "image-gif", "image-ico", "image-jpg", "image-png", "image-svg", "image-webp", "unsupported")] + [String] + ${Feature}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("aol", "apple-mail", "fastmail", "free-fr", "gmail", "gmx", "hey", "ionos-1and1", "laposte", "mail-ru", "microsoft", "orange", "outlook", "protonmail", "rainloop", "samsung-email", "sfr", "t-online-de", "thunderbird", "web-de", "yahoo")] + [String] + ${Family}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Platforms} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureFamilyStatistics' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Feature -eq $null) { + throw "invalid value for 'Feature', 'Feature' cannot be null." + } + + if ($Family -eq $null) { + throw "invalid value for 'Family', 'Family' cannot be null." + } + + if ($Platforms -eq $null) { + throw "invalid value for 'Platforms', 'Platforms' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "feature" = ${Feature} + "family" = ${Family} + "platforms" = ${Platforms} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureFamilyStatistics + +.DESCRIPTION + +Convert from JSON to EmailFeatureFamilyStatistics + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureFamilyStatistics +#> +function ConvertFrom-JsonToEmailFeatureFamilyStatistics { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureFamilyStatistics' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureFamilyStatistics + $AllProperties = ("feature", "family", "platforms") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'feature' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "feature"))) { + throw "Error! JSON cannot be serialized due to the required property 'feature' missing." + } else { + $Feature = $JsonParameters.PSobject.Properties["feature"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "family"))) { + throw "Error! JSON cannot be serialized due to the required property 'family' missing." + } else { + $Family = $JsonParameters.PSobject.Properties["family"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "platforms"))) { + throw "Error! JSON cannot be serialized due to the required property 'platforms' missing." + } else { + $Platforms = $JsonParameters.PSobject.Properties["platforms"].value + } + + $PSO = [PSCustomObject]@{ + "feature" = ${Feature} + "family" = ${Family} + "platforms" = ${Platforms} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureNames.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureNames.ps1 new file mode 100644 index 00000000..04c9d675 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureNames.ps1 @@ -0,0 +1,140 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Family +No description available. +.PARAMETER Platform +No description available. +.PARAMETER Category +No description available. +.OUTPUTS + +EmailFeatureNames +#> + +function Initialize-EmailFeatureNames { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Family}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Platform}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Category} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureNames' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Family -eq $null) { + throw "invalid value for 'Family', 'Family' cannot be null." + } + + if ($Platform -eq $null) { + throw "invalid value for 'Platform', 'Platform' cannot be null." + } + + if ($Category -eq $null) { + throw "invalid value for 'Category', 'Category' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "family" = ${Family} + "platform" = ${Platform} + "category" = ${Category} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureNames + +.DESCRIPTION + +Convert from JSON to EmailFeatureNames + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureNames +#> +function ConvertFrom-JsonToEmailFeatureNames { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureNames' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureNames + $AllProperties = ("family", "platform", "category") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'family' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "family"))) { + throw "Error! JSON cannot be serialized due to the required property 'family' missing." + } else { + $Family = $JsonParameters.PSobject.Properties["family"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "platform"))) { + throw "Error! JSON cannot be serialized due to the required property 'platform' missing." + } else { + $Platform = $JsonParameters.PSobject.Properties["platform"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "category"))) { + throw "Error! JSON cannot be serialized due to the required property 'category' missing." + } else { + $Category = $JsonParameters.PSobject.Properties["category"].value + } + + $PSO = [PSCustomObject]@{ + "family" = ${Family} + "platform" = ${Platform} + "category" = ${Category} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureOverview.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureOverview.ps1 new file mode 100644 index 00000000..5d4fdfe1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureOverview.ps1 @@ -0,0 +1,204 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Feature +No description available. +.PARAMETER Title +No description available. +.PARAMETER Description +No description available. +.PARAMETER Category +No description available. +.PARAMETER Notes +No description available. +.PARAMETER NotesNumbers +No description available. +.PARAMETER FeatureStatistics +No description available. +.PARAMETER Statuses +No description available. +.OUTPUTS + +EmailFeatureOverview +#> + +function Initialize-EmailFeatureOverview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("amp", "css-accent-color", "css-align-items", "css-animation", "css-aspect-ratio", "css-at-font-face", "css-at-import", "css-at-keyframes", "css-at-media", "css-at-supports", "css-background-blend-mode", "css-background-clip", "css-background-color", "css-background-image", "css-background-origin", "css-background-position", "css-background-repeat", "css-background-size", "css-background", "css-block-inline-size", "css-border-image", "css-border-inline-block-individual", "css-border-inline-block-longhand", "css-border-inline-block", "css-border-radius-logical", "css-border-radius", "css-border", "css-box-shadow", "css-box-sizing", "css-caption-side", "css-clip-path", "css-column-count", "css-column-layout-properties", "css-direction", "css-display-flex", "css-display-grid", "css-display-none", "css-display", "css-filter", "css-flex-direction", "css-flex-wrap", "css-float", "css-font-kerning", "css-font-weight", "css-font", "css-gap", "css-grid-template", "css-height", "css-hyphens", "css-inline-size", "css-justify-content", "css-left-right-top-bottom", "css-letter-spacing", "css-line-height", "css-list-style-image", "css-list-style-position", "css-list-style-type", "css-list-style", "css-margin-block-start-end", "css-margin-inline-block", "css-margin-inline-start-end", "css-margin-inline", "css-margin", "css-max-block-size", "css-max-height", "css-max-width", "css-min-height", "css-min-inline-size", "css-min-width", "css-mix-blend-mode", "css-object-fit", "css-object-position", "css-opacity", "css-outline-offset", "css-outline", "css-overflow-wrap", "css-overflow", "css-padding-block-start-end", "css-padding-inline-block", "css-padding-inline-start-end", "css-padding", "css-position", "css-tab-size", "css-table-layout", "css-text-align-last", "css-text-align", "css-text-decoration-color", "css-text-decoration-thickness", "css-text-decoration", "css-text-emphasis-position", "css-text-emphasis", "css-text-indent", "css-text-overflow", "css-text-shadow", "css-text-transform", "css-text-underline-offset", "css-transform", "css-vertical-align", "css-visibility", "css-white-space", "css-width", "css-word-break", "css-writing-mode", "css-z-index", "html-abbr", "html-address", "html-align", "html-anchor-links", "html-aria-describedby", "html-aria-hidden", "html-aria-label", "html-aria-labelledby", "html-aria-live", "html-audio", "html-background", "html-base", "html-blockquote", "html-body", "html-button-reset", "html-button-submit", "html-code", "html-del", "html-dfn", "html-dialog", "html-dir", "html-div", "html-doctype", "html-form", "html-h1-h6", "html-height", "html-image-maps", "html-input-checkbox", "html-input-hidden", "html-input-radio", "html-input-reset", "html-input-submit", "html-input-text", "html-lang", "html-link", "html-lists", "html-loading-attribute", "html-mailto-links", "html-marquee", "html-meter", "html-object", "html-p", "html-picture", "html-pre", "html-progress", "html-required", "html-role", "html-rp", "html-rt", "html-ruby", "html-select", "html-semantics", "html-small", "html-span", "html-srcset", "html-strike", "html-strong", "html-style", "html-svg", "html-table", "html-target", "html-textarea", "html-valign", "html-video", "html-wbr", "html-width", "image-avif", "image-base64", "image-bmp", "image-gif", "image-ico", "image-jpg", "image-png", "image-svg", "image-webp", "unsupported")] + [String] + ${Feature}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Title}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("css", "html", "image", "others")] + [String] + ${Category}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Notes}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${NotesNumbers}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${FeatureStatistics}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUPPORTED", "PARTIAL", "NOT_SUPPORTED", "UNKNOWN")] + [String[]] + ${Statuses} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureOverview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Feature -eq $null) { + throw "invalid value for 'Feature', 'Feature' cannot be null." + } + + if ($Statuses -eq $null) { + throw "invalid value for 'Statuses', 'Statuses' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "feature" = ${Feature} + "title" = ${Title} + "description" = ${Description} + "category" = ${Category} + "notes" = ${Notes} + "notesNumbers" = ${NotesNumbers} + "featureStatistics" = ${FeatureStatistics} + "statuses" = ${Statuses} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureOverview + +.DESCRIPTION + +Convert from JSON to EmailFeatureOverview + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureOverview +#> +function ConvertFrom-JsonToEmailFeatureOverview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureOverview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureOverview + $AllProperties = ("feature", "title", "description", "category", "notes", "notesNumbers", "featureStatistics", "statuses") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'feature' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "feature"))) { + throw "Error! JSON cannot be serialized due to the required property 'feature' missing." + } else { + $Feature = $JsonParameters.PSobject.Properties["feature"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "statuses"))) { + throw "Error! JSON cannot be serialized due to the required property 'statuses' missing." + } else { + $Statuses = $JsonParameters.PSobject.Properties["statuses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "title"))) { #optional property not found + $Title = $null + } else { + $Title = $JsonParameters.PSobject.Properties["title"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "category"))) { #optional property not found + $Category = $null + } else { + $Category = $JsonParameters.PSobject.Properties["category"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "notes"))) { #optional property not found + $Notes = $null + } else { + $Notes = $JsonParameters.PSobject.Properties["notes"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "notesNumbers"))) { #optional property not found + $NotesNumbers = $null + } else { + $NotesNumbers = $JsonParameters.PSobject.Properties["notesNumbers"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "featureStatistics"))) { #optional property not found + $FeatureStatistics = $null + } else { + $FeatureStatistics = $JsonParameters.PSobject.Properties["featureStatistics"].value + } + + $PSO = [PSCustomObject]@{ + "feature" = ${Feature} + "title" = ${Title} + "description" = ${Description} + "category" = ${Category} + "notes" = ${Notes} + "notesNumbers" = ${NotesNumbers} + "featureStatistics" = ${FeatureStatistics} + "statuses" = ${Statuses} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeaturePlatformName.ps1 b/src/maislurp-client-powershell/Model/EmailFeaturePlatformName.ps1 new file mode 100644 index 00000000..5663e6f2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeaturePlatformName.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Slug +No description available. +.PARAMETER Name +No description available. +.OUTPUTS + +EmailFeaturePlatformName +#> + +function Initialize-EmailFeaturePlatformName { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("android", "desktop-app", "desktop-webmail", "ios", "macos", "mobile-webmail", "outlook-com", "webmail", "windows", "windows-mail")] + [String] + ${Slug}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeaturePlatformName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Slug -eq $null) { + throw "invalid value for 'Slug', 'Slug' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "slug" = ${Slug} + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeaturePlatformName + +.DESCRIPTION + +Convert from JSON to EmailFeaturePlatformName + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeaturePlatformName +#> +function ConvertFrom-JsonToEmailFeaturePlatformName { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeaturePlatformName' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeaturePlatformName + $AllProperties = ("slug", "name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'slug' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "slug"))) { + throw "Error! JSON cannot be serialized due to the required property 'slug' missing." + } else { + $Slug = $JsonParameters.PSobject.Properties["slug"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "slug" = ${Slug} + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeaturePlatformStatistics.ps1 b/src/maislurp-client-powershell/Model/EmailFeaturePlatformStatistics.ps1 new file mode 100644 index 00000000..82509f4d --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeaturePlatformStatistics.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Platform +No description available. +.PARAMETER Versions +No description available. +.OUTPUTS + +EmailFeaturePlatformStatistics +#> + +function Initialize-EmailFeaturePlatformStatistics { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("android", "desktop-app", "desktop-webmail", "ios", "macos", "mobile-webmail", "outlook-com", "webmail", "windows", "windows-mail")] + [String] + ${Platform}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Versions} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeaturePlatformStatistics' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Platform -eq $null) { + throw "invalid value for 'Platform', 'Platform' cannot be null." + } + + if ($Versions -eq $null) { + throw "invalid value for 'Versions', 'Versions' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "platform" = ${Platform} + "versions" = ${Versions} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeaturePlatformStatistics + +.DESCRIPTION + +Convert from JSON to EmailFeaturePlatformStatistics + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeaturePlatformStatistics +#> +function ConvertFrom-JsonToEmailFeaturePlatformStatistics { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeaturePlatformStatistics' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeaturePlatformStatistics + $AllProperties = ("platform", "versions") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'platform' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "platform"))) { + throw "Error! JSON cannot be serialized due to the required property 'platform' missing." + } else { + $Platform = $JsonParameters.PSobject.Properties["platform"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "versions"))) { + throw "Error! JSON cannot be serialized due to the required property 'versions' missing." + } else { + $Versions = $JsonParameters.PSobject.Properties["versions"].value + } + + $PSO = [PSCustomObject]@{ + "platform" = ${Platform} + "versions" = ${Versions} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureSupportFlags.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureSupportFlags.ps1 new file mode 100644 index 00000000..1f05a918 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureSupportFlags.ps1 @@ -0,0 +1,120 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Status +No description available. +.PARAMETER Notes +No description available. +.OUTPUTS + +EmailFeatureSupportFlags +#> + +function Initialize-EmailFeatureSupportFlags { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUPPORTED", "PARTIAL", "NOT_SUPPORTED", "UNKNOWN")] + [String] + ${Status}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Notes} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureSupportFlags' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Status -eq $null) { + throw "invalid value for 'Status', 'Status' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "status" = ${Status} + "notes" = ${Notes} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureSupportFlags + +.DESCRIPTION + +Convert from JSON to EmailFeatureSupportFlags + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureSupportFlags +#> +function ConvertFrom-JsonToEmailFeatureSupportFlags { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureSupportFlags' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureSupportFlags + $AllProperties = ("status", "notes") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'status' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { + throw "Error! JSON cannot be serialized due to the required property 'status' missing." + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "notes"))) { #optional property not found + $Notes = $null + } else { + $Notes = $JsonParameters.PSobject.Properties["notes"].value + } + + $PSO = [PSCustomObject]@{ + "status" = ${Status} + "notes" = ${Notes} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureSupportResult.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureSupportResult.ps1 new file mode 100644 index 00000000..191069c5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureSupportResult.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Names +No description available. +.PARAMETER DetectedFeatures +No description available. +.PARAMETER FeatureOverviews +No description available. +.PARAMETER FeaturePercentages +No description available. +.OUTPUTS + +EmailFeatureSupportResult +#> + +function Initialize-EmailFeatureSupportResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Names}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("amp", "css-accent-color", "css-align-items", "css-animation", "css-aspect-ratio", "css-at-font-face", "css-at-import", "css-at-keyframes", "css-at-media", "css-at-supports", "css-background-blend-mode", "css-background-clip", "css-background-color", "css-background-image", "css-background-origin", "css-background-position", "css-background-repeat", "css-background-size", "css-background", "css-block-inline-size", "css-border-image", "css-border-inline-block-individual", "css-border-inline-block-longhand", "css-border-inline-block", "css-border-radius-logical", "css-border-radius", "css-border", "css-box-shadow", "css-box-sizing", "css-caption-side", "css-clip-path", "css-column-count", "css-column-layout-properties", "css-direction", "css-display-flex", "css-display-grid", "css-display-none", "css-display", "css-filter", "css-flex-direction", "css-flex-wrap", "css-float", "css-font-kerning", "css-font-weight", "css-font", "css-gap", "css-grid-template", "css-height", "css-hyphens", "css-inline-size", "css-justify-content", "css-left-right-top-bottom", "css-letter-spacing", "css-line-height", "css-list-style-image", "css-list-style-position", "css-list-style-type", "css-list-style", "css-margin-block-start-end", "css-margin-inline-block", "css-margin-inline-start-end", "css-margin-inline", "css-margin", "css-max-block-size", "css-max-height", "css-max-width", "css-min-height", "css-min-inline-size", "css-min-width", "css-mix-blend-mode", "css-object-fit", "css-object-position", "css-opacity", "css-outline-offset", "css-outline", "css-overflow-wrap", "css-overflow", "css-padding-block-start-end", "css-padding-inline-block", "css-padding-inline-start-end", "css-padding", "css-position", "css-tab-size", "css-table-layout", "css-text-align-last", "css-text-align", "css-text-decoration-color", "css-text-decoration-thickness", "css-text-decoration", "css-text-emphasis-position", "css-text-emphasis", "css-text-indent", "css-text-overflow", "css-text-shadow", "css-text-transform", "css-text-underline-offset", "css-transform", "css-vertical-align", "css-visibility", "css-white-space", "css-width", "css-word-break", "css-writing-mode", "css-z-index", "html-abbr", "html-address", "html-align", "html-anchor-links", "html-aria-describedby", "html-aria-hidden", "html-aria-label", "html-aria-labelledby", "html-aria-live", "html-audio", "html-background", "html-base", "html-blockquote", "html-body", "html-button-reset", "html-button-submit", "html-code", "html-del", "html-dfn", "html-dialog", "html-dir", "html-div", "html-doctype", "html-form", "html-h1-h6", "html-height", "html-image-maps", "html-input-checkbox", "html-input-hidden", "html-input-radio", "html-input-reset", "html-input-submit", "html-input-text", "html-lang", "html-link", "html-lists", "html-loading-attribute", "html-mailto-links", "html-marquee", "html-meter", "html-object", "html-p", "html-picture", "html-pre", "html-progress", "html-required", "html-role", "html-rp", "html-rt", "html-ruby", "html-select", "html-semantics", "html-small", "html-span", "html-srcset", "html-strike", "html-strong", "html-style", "html-svg", "html-table", "html-target", "html-textarea", "html-valign", "html-video", "html-wbr", "html-width", "image-avif", "image-base64", "image-bmp", "image-gif", "image-ico", "image-jpg", "image-png", "image-svg", "image-webp", "unsupported")] + [String[]] + ${DetectedFeatures}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${FeatureOverviews}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${FeaturePercentages} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureSupportResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Names -eq $null) { + throw "invalid value for 'Names', 'Names' cannot be null." + } + + if ($DetectedFeatures -eq $null) { + throw "invalid value for 'DetectedFeatures', 'DetectedFeatures' cannot be null." + } + + if ($FeatureOverviews -eq $null) { + throw "invalid value for 'FeatureOverviews', 'FeatureOverviews' cannot be null." + } + + if ($FeaturePercentages -eq $null) { + throw "invalid value for 'FeaturePercentages', 'FeaturePercentages' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "names" = ${Names} + "detectedFeatures" = ${DetectedFeatures} + "featureOverviews" = ${FeatureOverviews} + "featurePercentages" = ${FeaturePercentages} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureSupportResult + +.DESCRIPTION + +Convert from JSON to EmailFeatureSupportResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureSupportResult +#> +function ConvertFrom-JsonToEmailFeatureSupportResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureSupportResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureSupportResult + $AllProperties = ("names", "detectedFeatures", "featureOverviews", "featurePercentages") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'names' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "names"))) { + throw "Error! JSON cannot be serialized due to the required property 'names' missing." + } else { + $Names = $JsonParameters.PSobject.Properties["names"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "detectedFeatures"))) { + throw "Error! JSON cannot be serialized due to the required property 'detectedFeatures' missing." + } else { + $DetectedFeatures = $JsonParameters.PSobject.Properties["detectedFeatures"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "featureOverviews"))) { + throw "Error! JSON cannot be serialized due to the required property 'featureOverviews' missing." + } else { + $FeatureOverviews = $JsonParameters.PSobject.Properties["featureOverviews"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "featurePercentages"))) { + throw "Error! JSON cannot be serialized due to the required property 'featurePercentages' missing." + } else { + $FeaturePercentages = $JsonParameters.PSobject.Properties["featurePercentages"].value + } + + $PSO = [PSCustomObject]@{ + "names" = ${Names} + "detectedFeatures" = ${DetectedFeatures} + "featureOverviews" = ${FeatureOverviews} + "featurePercentages" = ${FeaturePercentages} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureSupportStatusPercentage.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureSupportStatusPercentage.ps1 new file mode 100644 index 00000000..cc37a980 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureSupportStatusPercentage.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Status +No description available. +.PARAMETER Percentage +No description available. +.OUTPUTS + +EmailFeatureSupportStatusPercentage +#> + +function Initialize-EmailFeatureSupportStatusPercentage { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUPPORTED", "PARTIAL", "NOT_SUPPORTED", "UNKNOWN")] + [String] + ${Status}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Double] + ${Percentage} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureSupportStatusPercentage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Status -eq $null) { + throw "invalid value for 'Status', 'Status' cannot be null." + } + + if ($Percentage -eq $null) { + throw "invalid value for 'Percentage', 'Percentage' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "status" = ${Status} + "percentage" = ${Percentage} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureSupportStatusPercentage + +.DESCRIPTION + +Convert from JSON to EmailFeatureSupportStatusPercentage + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureSupportStatusPercentage +#> +function ConvertFrom-JsonToEmailFeatureSupportStatusPercentage { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureSupportStatusPercentage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureSupportStatusPercentage + $AllProperties = ("status", "percentage") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'status' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { + throw "Error! JSON cannot be serialized due to the required property 'status' missing." + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "percentage"))) { + throw "Error! JSON cannot be serialized due to the required property 'percentage' missing." + } else { + $Percentage = $JsonParameters.PSobject.Properties["percentage"].value + } + + $PSO = [PSCustomObject]@{ + "status" = ${Status} + "percentage" = ${Percentage} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailFeatureVersionStatistics.ps1 b/src/maislurp-client-powershell/Model/EmailFeatureVersionStatistics.ps1 new file mode 100644 index 00000000..37fdbb46 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailFeatureVersionStatistics.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Version +No description available. +.PARAMETER SupportFlags +No description available. +.OUTPUTS + +EmailFeatureVersionStatistics +#> + +function Initialize-EmailFeatureVersionStatistics { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Version}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${SupportFlags} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailFeatureVersionStatistics' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Version -eq $null) { + throw "invalid value for 'Version', 'Version' cannot be null." + } + + if ($SupportFlags -eq $null) { + throw "invalid value for 'SupportFlags', 'SupportFlags' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "version" = ${Version} + "supportFlags" = ${SupportFlags} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailFeatureVersionStatistics + +.DESCRIPTION + +Convert from JSON to EmailFeatureVersionStatistics + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailFeatureVersionStatistics +#> +function ConvertFrom-JsonToEmailFeatureVersionStatistics { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailFeatureVersionStatistics' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailFeatureVersionStatistics + $AllProperties = ("version", "supportFlags") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'version' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "version"))) { + throw "Error! JSON cannot be serialized due to the required property 'version' missing." + } else { + $Version = $JsonParameters.PSobject.Properties["version"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "supportFlags"))) { + throw "Error! JSON cannot be serialized due to the required property 'supportFlags' missing." + } else { + $SupportFlags = $JsonParameters.PSobject.Properties["supportFlags"].value + } + + $PSO = [PSCustomObject]@{ + "version" = ${Version} + "supportFlags" = ${SupportFlags} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailHtmlDto.ps1 b/src/maislurp-client-powershell/Model/EmailHtmlDto.ps1 new file mode 100644 index 00000000..38ce6b66 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailHtmlDto.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Subject +No description available. +.PARAMETER Body +No description available. +.OUTPUTS + +EmailHtmlDto +#> + +function Initialize-EmailHtmlDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailHtmlDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "subject" = ${Subject} + "body" = ${Body} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailHtmlDto + +.DESCRIPTION + +Convert from JSON to EmailHtmlDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailHtmlDto +#> +function ConvertFrom-JsonToEmailHtmlDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailHtmlDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailHtmlDto + $AllProperties = ("subject", "body") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + $PSO = [PSCustomObject]@{ + "subject" = ${Subject} + "body" = ${Body} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailLinksResult.ps1 b/src/maislurp-client-powershell/Model/EmailLinksResult.ps1 new file mode 100644 index 00000000..e4d8bf0b --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailLinksResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Links found in HTML + +.PARAMETER Links +No description available. +.PARAMETER Body +No description available. +.OUTPUTS + +EmailLinksResult +#> + +function Initialize-EmailLinksResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Links}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailLinksResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Links -eq $null) { + throw "invalid value for 'Links', 'Links' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "links" = ${Links} + "body" = ${Body} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailLinksResult + +.DESCRIPTION + +Convert from JSON to EmailLinksResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailLinksResult +#> +function ConvertFrom-JsonToEmailLinksResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailLinksResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailLinksResult + $AllProperties = ("links", "body") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'links' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "links"))) { + throw "Error! JSON cannot be serialized due to the required property 'links' missing." + } else { + $Links = $JsonParameters.PSobject.Properties["links"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + $PSO = [PSCustomObject]@{ + "links" = ${Links} + "body" = ${Body} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailPreview.ps1 b/src/maislurp-client-powershell/Model/EmailPreview.ps1 new file mode 100644 index 00000000..708a611a --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailPreview.ps1 @@ -0,0 +1,231 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Preview of an email message. For full message (including body and attachments) call the `getEmail` or other email endpoints with the provided email ID. + +.PARAMETER Id +ID of the email entity +.PARAMETER DomainId +ID of the domain that received the email +.PARAMETER Subject +The subject line of the email message as specified by SMTP subject header +.PARAMETER To +List of `To` recipient email addresses that the email was addressed to. See recipients object for names. +.PARAMETER VarFrom +Who the email was sent from. An email address - see fromName for the sender name. +.PARAMETER Bcc +List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. +.PARAMETER Cc +List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. +.PARAMETER CreatedAt +When was the email received by MailSlurp +.PARAMETER Read +Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks. +.PARAMETER Attachments +List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension. +.OUTPUTS + +EmailPreview +#> + +function Initialize-EmailPreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domainId" = ${DomainId} + "subject" = ${Subject} + "to" = ${To} + "from" = ${VarFrom} + "bcc" = ${Bcc} + "cc" = ${Cc} + "createdAt" = ${CreatedAt} + "read" = ${Read} + "attachments" = ${Attachments} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailPreview + +.DESCRIPTION + +Convert from JSON to EmailPreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailPreview +#> +function ConvertFrom-JsonToEmailPreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailPreview + $AllProperties = ("id", "domainId", "subject", "to", "from", "bcc", "cc", "createdAt", "read", "attachments") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domainId" = ${DomainId} + "subject" = ${Subject} + "to" = ${To} + "from" = ${VarFrom} + "bcc" = ${Bcc} + "cc" = ${Cc} + "createdAt" = ${CreatedAt} + "read" = ${Read} + "attachments" = ${Attachments} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailPreviewUrls.ps1 b/src/maislurp-client-powershell/Model/EmailPreviewUrls.ps1 new file mode 100644 index 00000000..61fb45ea --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailPreviewUrls.ps1 @@ -0,0 +1,140 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +URLs for email body + +.PARAMETER RawSmtpMessageUrl +No description available. +.PARAMETER PlainHtmlBodyUrl +No description available. +.PARAMETER Origin +No description available. +.OUTPUTS + +EmailPreviewUrls +#> + +function Initialize-EmailPreviewUrls { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${RawSmtpMessageUrl}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${PlainHtmlBodyUrl}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Origin} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailPreviewUrls' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($RawSmtpMessageUrl -eq $null) { + throw "invalid value for 'RawSmtpMessageUrl', 'RawSmtpMessageUrl' cannot be null." + } + + if ($PlainHtmlBodyUrl -eq $null) { + throw "invalid value for 'PlainHtmlBodyUrl', 'PlainHtmlBodyUrl' cannot be null." + } + + if ($Origin -eq $null) { + throw "invalid value for 'Origin', 'Origin' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "rawSmtpMessageUrl" = ${RawSmtpMessageUrl} + "plainHtmlBodyUrl" = ${PlainHtmlBodyUrl} + "origin" = ${Origin} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailPreviewUrls + +.DESCRIPTION + +Convert from JSON to EmailPreviewUrls + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailPreviewUrls +#> +function ConvertFrom-JsonToEmailPreviewUrls { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailPreviewUrls' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailPreviewUrls + $AllProperties = ("rawSmtpMessageUrl", "plainHtmlBodyUrl", "origin") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'rawSmtpMessageUrl' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rawSmtpMessageUrl"))) { + throw "Error! JSON cannot be serialized due to the required property 'rawSmtpMessageUrl' missing." + } else { + $RawSmtpMessageUrl = $JsonParameters.PSobject.Properties["rawSmtpMessageUrl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "plainHtmlBodyUrl"))) { + throw "Error! JSON cannot be serialized due to the required property 'plainHtmlBodyUrl' missing." + } else { + $PlainHtmlBodyUrl = $JsonParameters.PSobject.Properties["plainHtmlBodyUrl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "origin"))) { + throw "Error! JSON cannot be serialized due to the required property 'origin' missing." + } else { + $Origin = $JsonParameters.PSobject.Properties["origin"].value + } + + $PSO = [PSCustomObject]@{ + "rawSmtpMessageUrl" = ${RawSmtpMessageUrl} + "plainHtmlBodyUrl" = ${PlainHtmlBodyUrl} + "origin" = ${Origin} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailProjection.ps1 b/src/maislurp-client-powershell/Model/EmailProjection.ps1 new file mode 100644 index 00000000..5a9720d4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailProjection.ps1 @@ -0,0 +1,308 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties. + +.PARAMETER Attachments +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER To +No description available. +.PARAMETER DomainId +No description available. +.PARAMETER Bcc +No description available. +.PARAMETER Cc +No description available. +.PARAMETER Read +No description available. +.PARAMETER BodyExcerpt +No description available. +.PARAMETER TeamAccess +No description available. +.PARAMETER BodyMD5Hash +No description available. +.PARAMETER TextExcerpt +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Id +No description available. +.PARAMETER VarFrom +No description available. +.OUTPUTS + +EmailProjection +#> + +function Initialize-EmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyExcerpt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${TeamAccess}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyMD5Hash}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${TextExcerpt}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + if ($TeamAccess -eq $null) { + throw "invalid value for 'TeamAccess', 'TeamAccess' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "attachments" = ${Attachments} + "inboxId" = ${InboxId} + "to" = ${To} + "domainId" = ${DomainId} + "bcc" = ${Bcc} + "cc" = ${Cc} + "read" = ${Read} + "bodyExcerpt" = ${BodyExcerpt} + "teamAccess" = ${TeamAccess} + "bodyMD5Hash" = ${BodyMD5Hash} + "textExcerpt" = ${TextExcerpt} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + "from" = ${VarFrom} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailProjection + +.DESCRIPTION + +Convert from JSON to EmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailProjection +#> +function ConvertFrom-JsonToEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailProjection + $AllProperties = ("attachments", "inboxId", "to", "domainId", "bcc", "cc", "read", "bodyExcerpt", "teamAccess", "bodyMD5Hash", "textExcerpt", "createdAt", "subject", "id", "from") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "teamAccess"))) { + throw "Error! JSON cannot be serialized due to the required property 'teamAccess' missing." + } else { + $TeamAccess = $JsonParameters.PSobject.Properties["teamAccess"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyExcerpt"))) { #optional property not found + $BodyExcerpt = $null + } else { + $BodyExcerpt = $JsonParameters.PSobject.Properties["bodyExcerpt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyMD5Hash"))) { #optional property not found + $BodyMD5Hash = $null + } else { + $BodyMD5Hash = $JsonParameters.PSobject.Properties["bodyMD5Hash"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "textExcerpt"))) { #optional property not found + $TextExcerpt = $null + } else { + $TextExcerpt = $JsonParameters.PSobject.Properties["textExcerpt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + $PSO = [PSCustomObject]@{ + "attachments" = ${Attachments} + "inboxId" = ${InboxId} + "to" = ${To} + "domainId" = ${DomainId} + "bcc" = ${Bcc} + "cc" = ${Cc} + "read" = ${Read} + "bodyExcerpt" = ${BodyExcerpt} + "teamAccess" = ${TeamAccess} + "bodyMD5Hash" = ${BodyMD5Hash} + "textExcerpt" = ${TextExcerpt} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + "from" = ${VarFrom} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailRecipients.ps1 b/src/maislurp-client-powershell/Model/EmailRecipients.ps1 new file mode 100644 index 00000000..7565f6ba --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailRecipients.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +The `To`,`CC`,`BCC` recipients stored in object form with email address and name accessible. + +.PARAMETER To +No description available. +.PARAMETER Cc +No description available. +.PARAMETER Bcc +No description available. +.OUTPUTS + +EmailRecipients +#> + +function Initialize-EmailRecipients { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${To}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Cc}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Bcc} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "to" = ${To} + "cc" = ${Cc} + "bcc" = ${Bcc} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailRecipients + +.DESCRIPTION + +Convert from JSON to EmailRecipients + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailRecipients +#> +function ConvertFrom-JsonToEmailRecipients { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailRecipients + $AllProperties = ("to", "cc", "bcc") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { #optional property not found + $To = $null + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + $PSO = [PSCustomObject]@{ + "to" = ${To} + "cc" = ${Cc} + "bcc" = ${Bcc} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailScreenshotResult.ps1 b/src/maislurp-client-powershell/Model/EmailScreenshotResult.ps1 new file mode 100644 index 00000000..a02ad38b --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailScreenshotResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Base64EncodedImage +No description available. +.OUTPUTS + +EmailScreenshotResult +#> + +function Initialize-EmailScreenshotResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Base64EncodedImage} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailScreenshotResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Base64EncodedImage -eq $null) { + throw "invalid value for 'Base64EncodedImage', 'Base64EncodedImage' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "base64EncodedImage" = ${Base64EncodedImage} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailScreenshotResult + +.DESCRIPTION + +Convert from JSON to EmailScreenshotResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailScreenshotResult +#> +function ConvertFrom-JsonToEmailScreenshotResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailScreenshotResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailScreenshotResult + $AllProperties = ("base64EncodedImage") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'base64EncodedImage' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "base64EncodedImage"))) { + throw "Error! JSON cannot be serialized due to the required property 'base64EncodedImage' missing." + } else { + $Base64EncodedImage = $JsonParameters.PSobject.Properties["base64EncodedImage"].value + } + + $PSO = [PSCustomObject]@{ + "base64EncodedImage" = ${Base64EncodedImage} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailTextLinesResult.ps1 b/src/maislurp-client-powershell/Model/EmailTextLinesResult.ps1 new file mode 100644 index 00000000..9d4e0015 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailTextLinesResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Parsed text of an email + +.PARAMETER Lines +No description available. +.PARAMETER Body +No description available. +.OUTPUTS + +EmailTextLinesResult +#> + +function Initialize-EmailTextLinesResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Lines}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailTextLinesResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Lines -eq $null) { + throw "invalid value for 'Lines', 'Lines' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "lines" = ${Lines} + "body" = ${Body} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailTextLinesResult + +.DESCRIPTION + +Convert from JSON to EmailTextLinesResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailTextLinesResult +#> +function ConvertFrom-JsonToEmailTextLinesResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailTextLinesResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailTextLinesResult + $AllProperties = ("lines", "body") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'lines' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lines"))) { + throw "Error! JSON cannot be serialized due to the required property 'lines' missing." + } else { + $Lines = $JsonParameters.PSobject.Properties["lines"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + $PSO = [PSCustomObject]@{ + "lines" = ${Lines} + "body" = ${Body} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailValidationRequestDto.ps1 b/src/maislurp-client-powershell/Model/EmailValidationRequestDto.ps1 new file mode 100644 index 00000000..986363b4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailValidationRequestDto.ps1 @@ -0,0 +1,191 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email validation request + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER IsValid +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +EmailValidationRequestDto +#> + +function Initialize-EmailValidationRequestDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsValid}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailValidationRequestDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($IsValid -eq $null) { + throw "invalid value for 'IsValid', 'IsValid' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "emailAddress" = ${EmailAddress} + "isValid" = ${IsValid} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailValidationRequestDto + +.DESCRIPTION + +Convert from JSON to EmailValidationRequestDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailValidationRequestDto +#> +function ConvertFrom-JsonToEmailValidationRequestDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailValidationRequestDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailValidationRequestDto + $AllProperties = ("id", "userId", "emailAddress", "isValid", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isValid"))) { + throw "Error! JSON cannot be serialized due to the required property 'isValid' missing." + } else { + $IsValid = $JsonParameters.PSobject.Properties["isValid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "emailAddress" = ${EmailAddress} + "isValid" = ${IsValid} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmailVerificationResult.ps1 b/src/maislurp-client-powershell/Model/EmailVerificationResult.ps1 new file mode 100644 index 00000000..d849ed15 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmailVerificationResult.ps1 @@ -0,0 +1,170 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email verification result. Valid means email address exists according to response from mail server running at the domain and port given. + +.PARAMETER DomainName +No description available. +.PARAMETER Port +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER IsValid +No description available. +.PARAMETER VarError +No description available. +.OUTPUTS + +EmailVerificationResult +#> + +function Initialize-EmailVerificationResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainName}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Port}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsValid}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarError} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmailVerificationResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($DomainName -eq $null) { + throw "invalid value for 'DomainName', 'DomainName' cannot be null." + } + + if ($Port -eq $null) { + throw "invalid value for 'Port', 'Port' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($IsValid -eq $null) { + throw "invalid value for 'IsValid', 'IsValid' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "domainName" = ${DomainName} + "port" = ${Port} + "emailAddress" = ${EmailAddress} + "isValid" = ${IsValid} + "error" = ${VarError} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmailVerificationResult + +.DESCRIPTION + +Convert from JSON to EmailVerificationResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmailVerificationResult +#> +function ConvertFrom-JsonToEmailVerificationResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmailVerificationResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmailVerificationResult + $AllProperties = ("domainName", "port", "emailAddress", "isValid", "error") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domainName' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainName"))) { + throw "Error! JSON cannot be serialized due to the required property 'domainName' missing." + } else { + $DomainName = $JsonParameters.PSobject.Properties["domainName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "port"))) { + throw "Error! JSON cannot be serialized due to the required property 'port' missing." + } else { + $Port = $JsonParameters.PSobject.Properties["port"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isValid"))) { + throw "Error! JSON cannot be serialized due to the required property 'isValid' missing." + } else { + $IsValid = $JsonParameters.PSobject.Properties["isValid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "error"))) { #optional property not found + $VarError = $null + } else { + $VarError = $JsonParameters.PSobject.Properties["error"].value + } + + $PSO = [PSCustomObject]@{ + "domainName" = ${DomainName} + "port" = ${Port} + "emailAddress" = ${EmailAddress} + "isValid" = ${IsValid} + "error" = ${VarError} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmergencyAddress.ps1 b/src/maislurp-client-powershell/Model/EmergencyAddress.ps1 new file mode 100644 index 00000000..ca54ef56 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmergencyAddress.ps1 @@ -0,0 +1,307 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER Sid +No description available. +.PARAMETER UserId +No description available. +.PARAMETER DisplayName +No description available. +.PARAMETER CustomerName +No description available. +.PARAMETER Address1 +No description available. +.PARAMETER City +No description available. +.PARAMETER Region +No description available. +.PARAMETER PostalCode +No description available. +.PARAMETER PhoneCountry +No description available. +.PARAMETER AccountSid +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +EmergencyAddress +#> + +function Initialize-EmergencyAddress { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Sid}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${DisplayName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${CustomerName}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Address1}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${City}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Region}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${PostalCode}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("US", "GB", "AU")] + [String] + ${PhoneCountry}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${AccountSid}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmergencyAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Sid -eq $null) { + throw "invalid value for 'Sid', 'Sid' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($DisplayName -eq $null) { + throw "invalid value for 'DisplayName', 'DisplayName' cannot be null." + } + + if ($CustomerName -eq $null) { + throw "invalid value for 'CustomerName', 'CustomerName' cannot be null." + } + + if ($Address1 -eq $null) { + throw "invalid value for 'Address1', 'Address1' cannot be null." + } + + if ($City -eq $null) { + throw "invalid value for 'City', 'City' cannot be null." + } + + if ($Region -eq $null) { + throw "invalid value for 'Region', 'Region' cannot be null." + } + + if ($PostalCode -eq $null) { + throw "invalid value for 'PostalCode', 'PostalCode' cannot be null." + } + + if ($PhoneCountry -eq $null) { + throw "invalid value for 'PhoneCountry', 'PhoneCountry' cannot be null." + } + + if ($AccountSid -eq $null) { + throw "invalid value for 'AccountSid', 'AccountSid' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "sid" = ${Sid} + "userId" = ${UserId} + "displayName" = ${DisplayName} + "customerName" = ${CustomerName} + "address1" = ${Address1} + "city" = ${City} + "region" = ${Region} + "postalCode" = ${PostalCode} + "phoneCountry" = ${PhoneCountry} + "accountSid" = ${AccountSid} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmergencyAddress + +.DESCRIPTION + +Convert from JSON to EmergencyAddress + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmergencyAddress +#> +function ConvertFrom-JsonToEmergencyAddress { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmergencyAddress' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmergencyAddress + $AllProperties = ("id", "sid", "userId", "displayName", "customerName", "address1", "city", "region", "postalCode", "phoneCountry", "accountSid", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'sid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sid"))) { + throw "Error! JSON cannot be serialized due to the required property 'sid' missing." + } else { + $Sid = $JsonParameters.PSobject.Properties["sid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "displayName"))) { + throw "Error! JSON cannot be serialized due to the required property 'displayName' missing." + } else { + $DisplayName = $JsonParameters.PSobject.Properties["displayName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "customerName"))) { + throw "Error! JSON cannot be serialized due to the required property 'customerName' missing." + } else { + $CustomerName = $JsonParameters.PSobject.Properties["customerName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "address1"))) { + throw "Error! JSON cannot be serialized due to the required property 'address1' missing." + } else { + $Address1 = $JsonParameters.PSobject.Properties["address1"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "city"))) { + throw "Error! JSON cannot be serialized due to the required property 'city' missing." + } else { + $City = $JsonParameters.PSobject.Properties["city"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "region"))) { + throw "Error! JSON cannot be serialized due to the required property 'region' missing." + } else { + $Region = $JsonParameters.PSobject.Properties["region"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "postalCode"))) { + throw "Error! JSON cannot be serialized due to the required property 'postalCode' missing." + } else { + $PostalCode = $JsonParameters.PSobject.Properties["postalCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneCountry"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneCountry' missing." + } else { + $PhoneCountry = $JsonParameters.PSobject.Properties["phoneCountry"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "accountSid"))) { + throw "Error! JSON cannot be serialized due to the required property 'accountSid' missing." + } else { + $AccountSid = $JsonParameters.PSobject.Properties["accountSid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "sid" = ${Sid} + "userId" = ${UserId} + "displayName" = ${DisplayName} + "customerName" = ${CustomerName} + "address1" = ${Address1} + "city" = ${City} + "region" = ${Region} + "postalCode" = ${PostalCode} + "phoneCountry" = ${PhoneCountry} + "accountSid" = ${AccountSid} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmergencyAddressDto.ps1 b/src/maislurp-client-powershell/Model/EmergencyAddressDto.ps1 new file mode 100644 index 00000000..1762c4a0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmergencyAddressDto.ps1 @@ -0,0 +1,141 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER Address1 +No description available. +.PARAMETER PhoneCountry +No description available. +.OUTPUTS + +EmergencyAddressDto +#> + +function Initialize-EmergencyAddressDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Address1}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("US", "GB", "AU")] + [String] + ${PhoneCountry} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmergencyAddressDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Address1 -eq $null) { + throw "invalid value for 'Address1', 'Address1' cannot be null." + } + + if ($PhoneCountry -eq $null) { + throw "invalid value for 'PhoneCountry', 'PhoneCountry' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "address1" = ${Address1} + "phoneCountry" = ${PhoneCountry} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmergencyAddressDto + +.DESCRIPTION + +Convert from JSON to EmergencyAddressDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmergencyAddressDto +#> +function ConvertFrom-JsonToEmergencyAddressDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmergencyAddressDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmergencyAddressDto + $AllProperties = ("id", "address1", "phoneCountry") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "address1"))) { + throw "Error! JSON cannot be serialized due to the required property 'address1' missing." + } else { + $Address1 = $JsonParameters.PSobject.Properties["address1"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneCountry"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneCountry' missing." + } else { + $PhoneCountry = $JsonParameters.PSobject.Properties["phoneCountry"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "address1" = ${Address1} + "phoneCountry" = ${PhoneCountry} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/EmptyResponseDto.ps1 b/src/maislurp-client-powershell/Model/EmptyResponseDto.ps1 new file mode 100644 index 00000000..8728bdf6 --- /dev/null +++ b/src/maislurp-client-powershell/Model/EmptyResponseDto.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Message +No description available. +.OUTPUTS + +EmptyResponseDto +#> + +function Initialize-EmptyResponseDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => EmptyResponseDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to EmptyResponseDto + +.DESCRIPTION + +Convert from JSON to EmptyResponseDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +EmptyResponseDto +#> +function ConvertFrom-JsonToEmptyResponseDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => EmptyResponseDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in EmptyResponseDto + $AllProperties = ("message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ExpirationDefaults.ps1 b/src/maislurp-client-powershell/Model/ExpirationDefaults.ps1 new file mode 100644 index 00000000..003d6759 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ExpirationDefaults.ps1 @@ -0,0 +1,162 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Expiration defaults for your account + +.PARAMETER DefaultExpirationMillis +No description available. +.PARAMETER MaxExpirationMillis +No description available. +.PARAMETER DefaultExpiresAt +No description available. +.PARAMETER CanPermanentInbox +No description available. +.PARAMETER NextInboxAllowsPermanent +No description available. +.OUTPUTS + +ExpirationDefaults +#> + +function Initialize-ExpirationDefaults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${DefaultExpirationMillis}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${MaxExpirationMillis}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${DefaultExpiresAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${CanPermanentInbox}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${NextInboxAllowsPermanent} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ExpirationDefaults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CanPermanentInbox -eq $null) { + throw "invalid value for 'CanPermanentInbox', 'CanPermanentInbox' cannot be null." + } + + if ($NextInboxAllowsPermanent -eq $null) { + throw "invalid value for 'NextInboxAllowsPermanent', 'NextInboxAllowsPermanent' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "defaultExpirationMillis" = ${DefaultExpirationMillis} + "maxExpirationMillis" = ${MaxExpirationMillis} + "defaultExpiresAt" = ${DefaultExpiresAt} + "canPermanentInbox" = ${CanPermanentInbox} + "nextInboxAllowsPermanent" = ${NextInboxAllowsPermanent} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ExpirationDefaults + +.DESCRIPTION + +Convert from JSON to ExpirationDefaults + +.PARAMETER Json + +Json object + +.OUTPUTS + +ExpirationDefaults +#> +function ConvertFrom-JsonToExpirationDefaults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ExpirationDefaults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ExpirationDefaults + $AllProperties = ("defaultExpirationMillis", "maxExpirationMillis", "defaultExpiresAt", "canPermanentInbox", "nextInboxAllowsPermanent") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'canPermanentInbox' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "canPermanentInbox"))) { + throw "Error! JSON cannot be serialized due to the required property 'canPermanentInbox' missing." + } else { + $CanPermanentInbox = $JsonParameters.PSobject.Properties["canPermanentInbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "nextInboxAllowsPermanent"))) { + throw "Error! JSON cannot be serialized due to the required property 'nextInboxAllowsPermanent' missing." + } else { + $NextInboxAllowsPermanent = $JsonParameters.PSobject.Properties["nextInboxAllowsPermanent"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "defaultExpirationMillis"))) { #optional property not found + $DefaultExpirationMillis = $null + } else { + $DefaultExpirationMillis = $JsonParameters.PSobject.Properties["defaultExpirationMillis"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "maxExpirationMillis"))) { #optional property not found + $MaxExpirationMillis = $null + } else { + $MaxExpirationMillis = $JsonParameters.PSobject.Properties["maxExpirationMillis"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "defaultExpiresAt"))) { #optional property not found + $DefaultExpiresAt = $null + } else { + $DefaultExpiresAt = $JsonParameters.PSobject.Properties["defaultExpiresAt"].value + } + + $PSO = [PSCustomObject]@{ + "defaultExpirationMillis" = ${DefaultExpirationMillis} + "maxExpirationMillis" = ${MaxExpirationMillis} + "defaultExpiresAt" = ${DefaultExpiresAt} + "canPermanentInbox" = ${CanPermanentInbox} + "nextInboxAllowsPermanent" = ${NextInboxAllowsPermanent} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ExpiredInboxDto.ps1 b/src/maislurp-client-powershell/Model/ExpiredInboxDto.ps1 new file mode 100644 index 00000000..dff6a67d --- /dev/null +++ b/src/maislurp-client-powershell/Model/ExpiredInboxDto.ps1 @@ -0,0 +1,140 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Expired inbox + +.PARAMETER Id +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER EmailAddress +No description available. +.OUTPUTS + +ExpiredInboxDto +#> + +function Initialize-ExpiredInboxDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ExpiredInboxDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "emailAddress" = ${EmailAddress} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ExpiredInboxDto + +.DESCRIPTION + +Convert from JSON to ExpiredInboxDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ExpiredInboxDto +#> +function ConvertFrom-JsonToExpiredInboxDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ExpiredInboxDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ExpiredInboxDto + $AllProperties = ("id", "inboxId", "emailAddress") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "emailAddress" = ${EmailAddress} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ExpiredInboxRecordProjection.ps1 b/src/maislurp-client-powershell/Model/ExpiredInboxRecordProjection.ps1 new file mode 100644 index 00000000..fc2a5e29 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ExpiredInboxRecordProjection.ps1 @@ -0,0 +1,157 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Record of inbox expiration + +.PARAMETER EmailAddress +No description available. +.PARAMETER UserId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ExpiredInboxRecordProjection +#> + +function Initialize-ExpiredInboxRecordProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ExpiredInboxRecordProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "userId" = ${UserId} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ExpiredInboxRecordProjection + +.DESCRIPTION + +Convert from JSON to ExpiredInboxRecordProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ExpiredInboxRecordProjection +#> +function ConvertFrom-JsonToExpiredInboxRecordProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ExpiredInboxRecordProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ExpiredInboxRecordProjection + $AllProperties = ("emailAddress", "userId", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddress' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "userId" = ${UserId} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ExportLink.ps1 b/src/maislurp-client-powershell/Model/ExportLink.ps1 new file mode 100644 index 00000000..fc903be5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ExportLink.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Export download link + +.PARAMETER DownloadLink +No description available. +.OUTPUTS + +ExportLink +#> + +function Initialize-ExportLink { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${DownloadLink} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ExportLink' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($DownloadLink -eq $null) { + throw "invalid value for 'DownloadLink', 'DownloadLink' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "downloadLink" = ${DownloadLink} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ExportLink + +.DESCRIPTION + +Convert from JSON to ExportLink + +.PARAMETER Json + +Json object + +.OUTPUTS + +ExportLink +#> +function ConvertFrom-JsonToExportLink { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ExportLink' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ExportLink + $AllProperties = ("downloadLink") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'downloadLink' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "downloadLink"))) { + throw "Error! JSON cannot be serialized due to the required property 'downloadLink' missing." + } else { + $DownloadLink = $JsonParameters.PSobject.Properties["downloadLink"].value + } + + $PSO = [PSCustomObject]@{ + "downloadLink" = ${DownloadLink} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ExportOptions.ps1 b/src/maislurp-client-powershell/Model/ExportOptions.ps1 new file mode 100644 index 00000000..644dbb86 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ExportOptions.ps1 @@ -0,0 +1,172 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for exporting user data + +.PARAMETER OutputFormat +No description available. +.PARAMETER ExcludePreviouslyExported +No description available. +.PARAMETER CreatedEarliestTime +No description available. +.PARAMETER CreatedOldestTime +No description available. +.PARAMETER VarFilter +No description available. +.PARAMETER ListSeparatorToken +No description available. +.OUTPUTS + +ExportOptions +#> + +function Initialize-ExportOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("CSV_DEFAULT", "CSV_EXCEL")] + [String] + ${OutputFormat}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${ExcludePreviouslyExported}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${CreatedEarliestTime}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${CreatedOldestTime}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFilter}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${ListSeparatorToken} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ExportOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($OutputFormat -eq $null) { + throw "invalid value for 'OutputFormat', 'OutputFormat' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "outputFormat" = ${OutputFormat} + "excludePreviouslyExported" = ${ExcludePreviouslyExported} + "createdEarliestTime" = ${CreatedEarliestTime} + "createdOldestTime" = ${CreatedOldestTime} + "filter" = ${VarFilter} + "listSeparatorToken" = ${ListSeparatorToken} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ExportOptions + +.DESCRIPTION + +Convert from JSON to ExportOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ExportOptions +#> +function ConvertFrom-JsonToExportOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ExportOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ExportOptions + $AllProperties = ("outputFormat", "excludePreviouslyExported", "createdEarliestTime", "createdOldestTime", "filter", "listSeparatorToken") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'outputFormat' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "outputFormat"))) { + throw "Error! JSON cannot be serialized due to the required property 'outputFormat' missing." + } else { + $OutputFormat = $JsonParameters.PSobject.Properties["outputFormat"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "excludePreviouslyExported"))) { #optional property not found + $ExcludePreviouslyExported = $null + } else { + $ExcludePreviouslyExported = $JsonParameters.PSobject.Properties["excludePreviouslyExported"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdEarliestTime"))) { #optional property not found + $CreatedEarliestTime = $null + } else { + $CreatedEarliestTime = $JsonParameters.PSobject.Properties["createdEarliestTime"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdOldestTime"))) { #optional property not found + $CreatedOldestTime = $null + } else { + $CreatedOldestTime = $JsonParameters.PSobject.Properties["createdOldestTime"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "filter"))) { #optional property not found + $VarFilter = $null + } else { + $VarFilter = $JsonParameters.PSobject.Properties["filter"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "listSeparatorToken"))) { #optional property not found + $ListSeparatorToken = $null + } else { + $ListSeparatorToken = $JsonParameters.PSobject.Properties["listSeparatorToken"].value + } + + $PSO = [PSCustomObject]@{ + "outputFormat" = ${OutputFormat} + "excludePreviouslyExported" = ${ExcludePreviouslyExported} + "createdEarliestTime" = ${CreatedEarliestTime} + "createdOldestTime" = ${CreatedOldestTime} + "filter" = ${VarFilter} + "listSeparatorToken" = ${ListSeparatorToken} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/FakeEmailDto.ps1 b/src/maislurp-client-powershell/Model/FakeEmailDto.ps1 new file mode 100644 index 00000000..6d5aa753 --- /dev/null +++ b/src/maislurp-client-powershell/Model/FakeEmailDto.ps1 @@ -0,0 +1,226 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER VarSender +No description available. +.PARAMETER Recipients +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Preview +No description available. +.PARAMETER Body +No description available. +.PARAMETER Seen +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +FakeEmailDto +#> + +function Initialize-FakeEmailDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${VarSender}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Recipients}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Preview}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Seen}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => FakeEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($Seen -eq $null) { + throw "invalid value for 'Seen', 'Seen' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "sender" = ${VarSender} + "recipients" = ${Recipients} + "subject" = ${Subject} + "preview" = ${Preview} + "body" = ${Body} + "seen" = ${Seen} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to FakeEmailDto + +.DESCRIPTION + +Convert from JSON to FakeEmailDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +FakeEmailDto +#> +function ConvertFrom-JsonToFakeEmailDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => FakeEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in FakeEmailDto + $AllProperties = ("id", "emailAddress", "sender", "recipients", "subject", "preview", "body", "seen", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seen"))) { + throw "Error! JSON cannot be serialized due to the required property 'seen' missing." + } else { + $Seen = $JsonParameters.PSobject.Properties["seen"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sender"))) { #optional property not found + $VarSender = $null + } else { + $VarSender = $JsonParameters.PSobject.Properties["sender"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipients"))) { #optional property not found + $Recipients = $null + } else { + $Recipients = $JsonParameters.PSobject.Properties["recipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "preview"))) { #optional property not found + $Preview = $null + } else { + $Preview = $JsonParameters.PSobject.Properties["preview"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "sender" = ${VarSender} + "recipients" = ${Recipients} + "subject" = ${Subject} + "preview" = ${Preview} + "body" = ${Body} + "seen" = ${Seen} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/FakeEmailPreview.ps1 b/src/maislurp-client-powershell/Model/FakeEmailPreview.ps1 new file mode 100644 index 00000000..41ee4a7c --- /dev/null +++ b/src/maislurp-client-powershell/Model/FakeEmailPreview.ps1 @@ -0,0 +1,209 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER VarSender +No description available. +.PARAMETER Recipients +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Preview +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Seen +No description available. +.OUTPUTS + +FakeEmailPreview +#> + +function Initialize-FakeEmailPreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${VarSender}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Recipients}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Preview}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Seen} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => FakeEmailPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Seen -eq $null) { + throw "invalid value for 'Seen', 'Seen' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "sender" = ${VarSender} + "recipients" = ${Recipients} + "subject" = ${Subject} + "preview" = ${Preview} + "createdAt" = ${CreatedAt} + "seen" = ${Seen} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to FakeEmailPreview + +.DESCRIPTION + +Convert from JSON to FakeEmailPreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +FakeEmailPreview +#> +function ConvertFrom-JsonToFakeEmailPreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => FakeEmailPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in FakeEmailPreview + $AllProperties = ("id", "emailAddress", "sender", "recipients", "subject", "preview", "createdAt", "seen") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seen"))) { + throw "Error! JSON cannot be serialized due to the required property 'seen' missing." + } else { + $Seen = $JsonParameters.PSobject.Properties["seen"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sender"))) { #optional property not found + $VarSender = $null + } else { + $VarSender = $JsonParameters.PSobject.Properties["sender"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipients"))) { #optional property not found + $Recipients = $null + } else { + $Recipients = $JsonParameters.PSobject.Properties["recipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "preview"))) { #optional property not found + $Preview = $null + } else { + $Preview = $JsonParameters.PSobject.Properties["preview"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "sender" = ${VarSender} + "recipients" = ${Recipients} + "subject" = ${Subject} + "preview" = ${Preview} + "createdAt" = ${CreatedAt} + "seen" = ${Seen} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/FakeEmailResult.ps1 b/src/maislurp-client-powershell/Model/FakeEmailResult.ps1 new file mode 100644 index 00000000..4d69df79 --- /dev/null +++ b/src/maislurp-client-powershell/Model/FakeEmailResult.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Email +No description available. +.OUTPUTS + +FakeEmailResult +#> + +function Initialize-FakeEmailResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Email} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => FakeEmailResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "email" = ${Email} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to FakeEmailResult + +.DESCRIPTION + +Convert from JSON to FakeEmailResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +FakeEmailResult +#> +function ConvertFrom-JsonToFakeEmailResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => FakeEmailResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in FakeEmailResult + $AllProperties = ("email") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "email"))) { #optional property not found + $Email = $null + } else { + $Email = $JsonParameters.PSobject.Properties["email"].value + } + + $PSO = [PSCustomObject]@{ + "email" = ${Email} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/FilterBouncedRecipientsOptions.ps1 b/src/maislurp-client-powershell/Model/FilterBouncedRecipientsOptions.ps1 new file mode 100644 index 00000000..b591459b --- /dev/null +++ b/src/maislurp-client-powershell/Model/FilterBouncedRecipientsOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for filtering bounced email recipients + +.PARAMETER EmailRecipients +No description available. +.OUTPUTS + +FilterBouncedRecipientsOptions +#> + +function Initialize-FilterBouncedRecipientsOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${EmailRecipients} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => FilterBouncedRecipientsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailRecipients -eq $null) { + throw "invalid value for 'EmailRecipients', 'EmailRecipients' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailRecipients" = ${EmailRecipients} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to FilterBouncedRecipientsOptions + +.DESCRIPTION + +Convert from JSON to FilterBouncedRecipientsOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +FilterBouncedRecipientsOptions +#> +function ConvertFrom-JsonToFilterBouncedRecipientsOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => FilterBouncedRecipientsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in FilterBouncedRecipientsOptions + $AllProperties = ("emailRecipients") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailRecipients' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailRecipients"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailRecipients' missing." + } else { + $EmailRecipients = $JsonParameters.PSobject.Properties["emailRecipients"].value + } + + $PSO = [PSCustomObject]@{ + "emailRecipients" = ${EmailRecipients} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/FilterBouncedRecipientsResult.ps1 b/src/maislurp-client-powershell/Model/FilterBouncedRecipientsResult.ps1 new file mode 100644 index 00000000..de00296f --- /dev/null +++ b/src/maislurp-client-powershell/Model/FilterBouncedRecipientsResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Remaining recipients that were filtered to remove bounced recipients + +.PARAMETER FilteredRecipients +No description available. +.OUTPUTS + +FilterBouncedRecipientsResult +#> + +function Initialize-FilterBouncedRecipientsResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${FilteredRecipients} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => FilterBouncedRecipientsResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($FilteredRecipients -eq $null) { + throw "invalid value for 'FilteredRecipients', 'FilteredRecipients' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "filteredRecipients" = ${FilteredRecipients} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to FilterBouncedRecipientsResult + +.DESCRIPTION + +Convert from JSON to FilterBouncedRecipientsResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +FilterBouncedRecipientsResult +#> +function ConvertFrom-JsonToFilterBouncedRecipientsResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => FilterBouncedRecipientsResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in FilterBouncedRecipientsResult + $AllProperties = ("filteredRecipients") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'filteredRecipients' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "filteredRecipients"))) { + throw "Error! JSON cannot be serialized due to the required property 'filteredRecipients' missing." + } else { + $FilteredRecipients = $JsonParameters.PSobject.Properties["filteredRecipients"].value + } + + $PSO = [PSCustomObject]@{ + "filteredRecipients" = ${FilteredRecipients} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/FlushExpiredInboxesResult.ps1 b/src/maislurp-client-powershell/Model/FlushExpiredInboxesResult.ps1 new file mode 100644 index 00000000..6e00499b --- /dev/null +++ b/src/maislurp-client-powershell/Model/FlushExpiredInboxesResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result from calling expire on any inboxes that have applicable expiration dates given current time. + +.PARAMETER InboxIds +Inbox IDs affected by expiration +.PARAMETER ExpireBefore +DateTime to filter inboxes so that those expiring before this time are expired +.OUTPUTS + +FlushExpiredInboxesResult +#> + +function Initialize-FlushExpiredInboxesResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${InboxIds}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${ExpireBefore} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => FlushExpiredInboxesResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxIds -eq $null) { + throw "invalid value for 'InboxIds', 'InboxIds' cannot be null." + } + + if ($ExpireBefore -eq $null) { + throw "invalid value for 'ExpireBefore', 'ExpireBefore' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + "expireBefore" = ${ExpireBefore} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to FlushExpiredInboxesResult + +.DESCRIPTION + +Convert from JSON to FlushExpiredInboxesResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +FlushExpiredInboxesResult +#> +function ConvertFrom-JsonToFlushExpiredInboxesResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => FlushExpiredInboxesResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in FlushExpiredInboxesResult + $AllProperties = ("inboxIds", "expireBefore") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxIds' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxIds"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxIds' missing." + } else { + $InboxIds = $JsonParameters.PSobject.Properties["inboxIds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "expireBefore"))) { + throw "Error! JSON cannot be serialized due to the required property 'expireBefore' missing." + } else { + $ExpireBefore = $JsonParameters.PSobject.Properties["expireBefore"].value + } + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + "expireBefore" = ${ExpireBefore} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ForwardEmailOptions.ps1 b/src/maislurp-client-powershell/Model/ForwardEmailOptions.ps1 new file mode 100644 index 00000000..84d667d8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ForwardEmailOptions.ps1 @@ -0,0 +1,184 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for forwarding an email + +.PARAMETER To +To recipients for forwarded email +.PARAMETER Subject +Subject for forwarded email +.PARAMETER Cc +Optional cc recipients +.PARAMETER Bcc +Optional bcc recipients +.PARAMETER VarFrom +Optional from override +.PARAMETER UseInboxName +Optionally use inbox name as display name for sender email address +.PARAMETER FilterBouncedRecipients +Filter recipients to remove any bounced recipients from to, bcc, and cc before sending +.OUTPUTS + +ForwardEmailOptions +#> + +function Initialize-ForwardEmailOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseInboxName}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${FilterBouncedRecipients} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ForwardEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "to" = ${To} + "subject" = ${Subject} + "cc" = ${Cc} + "bcc" = ${Bcc} + "from" = ${VarFrom} + "useInboxName" = ${UseInboxName} + "filterBouncedRecipients" = ${FilterBouncedRecipients} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ForwardEmailOptions + +.DESCRIPTION + +Convert from JSON to ForwardEmailOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ForwardEmailOptions +#> +function ConvertFrom-JsonToForwardEmailOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ForwardEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ForwardEmailOptions + $AllProperties = ("to", "subject", "cc", "bcc", "from", "useInboxName", "filterBouncedRecipients") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'to' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useInboxName"))) { #optional property not found + $UseInboxName = $null + } else { + $UseInboxName = $JsonParameters.PSobject.Properties["useInboxName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "filterBouncedRecipients"))) { #optional property not found + $FilterBouncedRecipients = $null + } else { + $FilterBouncedRecipients = $JsonParameters.PSobject.Properties["filterBouncedRecipients"].value + } + + $PSO = [PSCustomObject]@{ + "to" = ${To} + "subject" = ${Subject} + "cc" = ${Cc} + "bcc" = ${Bcc} + "from" = ${VarFrom} + "useInboxName" = ${UseInboxName} + "filterBouncedRecipients" = ${FilterBouncedRecipients} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateBimiRecordOptions.ps1 b/src/maislurp-client-powershell/Model/GenerateBimiRecordOptions.ps1 new file mode 100644 index 00000000..c6c52f4f --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateBimiRecordOptions.ps1 @@ -0,0 +1,154 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Domain +No description available. +.PARAMETER Version +No description available. +.PARAMETER LogoUrl +No description available. +.PARAMETER VmcUrl +No description available. +.OUTPUTS + +GenerateBimiRecordOptions +#> + +function Initialize-GenerateBimiRecordOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("BIMI1")] + [String] + ${Version}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${LogoUrl}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${VmcUrl} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateBimiRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + if ($Version -eq $null) { + throw "invalid value for 'Version', 'Version' cannot be null." + } + + if ($LogoUrl -eq $null) { + throw "invalid value for 'LogoUrl', 'LogoUrl' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + "version" = ${Version} + "logoUrl" = ${LogoUrl} + "vmcUrl" = ${VmcUrl} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateBimiRecordOptions + +.DESCRIPTION + +Convert from JSON to GenerateBimiRecordOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateBimiRecordOptions +#> +function ConvertFrom-JsonToGenerateBimiRecordOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateBimiRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateBimiRecordOptions + $AllProperties = ("domain", "version", "logoUrl", "vmcUrl") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domain' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "version"))) { + throw "Error! JSON cannot be serialized due to the required property 'version' missing." + } else { + $Version = $JsonParameters.PSobject.Properties["version"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "logoUrl"))) { + throw "Error! JSON cannot be serialized due to the required property 'logoUrl' missing." + } else { + $LogoUrl = $JsonParameters.PSobject.Properties["logoUrl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "vmcUrl"))) { #optional property not found + $VmcUrl = $null + } else { + $VmcUrl = $JsonParameters.PSobject.Properties["vmcUrl"].value + } + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + "version" = ${Version} + "logoUrl" = ${LogoUrl} + "vmcUrl" = ${VmcUrl} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateBimiRecordResults.ps1 b/src/maislurp-client-powershell/Model/GenerateBimiRecordResults.ps1 new file mode 100644 index 00000000..be5cc055 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateBimiRecordResults.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. +.PARAMETER Type +Domain Name Server Record Types +.PARAMETER Ttl +No description available. +.PARAMETER Value +No description available. +.OUTPUTS + +GenerateBimiRecordResults +#> + +function Initialize-GenerateBimiRecordResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String] + ${Type}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Ttl}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateBimiRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Type -eq $null) { + throw "invalid value for 'Type', 'Type' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateBimiRecordResults + +.DESCRIPTION + +Convert from JSON to GenerateBimiRecordResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateBimiRecordResults +#> +function ConvertFrom-JsonToGenerateBimiRecordResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateBimiRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateBimiRecordResults + $AllProperties = ("name", "type", "ttl", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "type"))) { + throw "Error! JSON cannot be serialized due to the required property 'type' missing." + } else { + $Type = $JsonParameters.PSobject.Properties["type"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateDmarcRecordOptions.ps1 b/src/maislurp-client-powershell/Model/GenerateDmarcRecordOptions.ps1 new file mode 100644 index 00000000..1d434203 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateDmarcRecordOptions.ps1 @@ -0,0 +1,272 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Domain +No description available. +.PARAMETER Version +No description available. +.PARAMETER Policy +No description available. +.PARAMETER SubdomainPolicy +No description available. +.PARAMETER ReportEmailAddress +No description available. +.PARAMETER ForensicEmailAddress +No description available. +.PARAMETER Percentage +No description available. +.PARAMETER ReportFormat +No description available. +.PARAMETER SecondsBetweenReports +No description available. +.PARAMETER Adkim +No description available. +.PARAMETER Aspf +No description available. +.PARAMETER Fo +No description available. +.OUTPUTS + +GenerateDmarcRecordOptions +#> + +function Initialize-GenerateDmarcRecordOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Domain}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("DMARC1")] + [String] + ${Version}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("NONE", "QUARANTINE", "REJECT")] + [String] + ${Policy}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("NONE", "QUARANTINE", "REJECT")] + [String] + ${SubdomainPolicy}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ReportEmailAddress}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ForensicEmailAddress}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Percentage}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("AFRF")] + [String] + ${ReportFormat}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SecondsBetweenReports}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("STRICT", "RELAXED")] + [String] + ${Adkim}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("STRICT", "RELAXED")] + [String] + ${Aspf}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("FO_0", "FO_1", "FO_D", "FO_S")] + [String] + ${Fo} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateDmarcRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Domain -eq $null) { + throw "invalid value for 'Domain', 'Domain' cannot be null." + } + + if ($Version -eq $null) { + throw "invalid value for 'Version', 'Version' cannot be null." + } + + if ($Policy -eq $null) { + throw "invalid value for 'Policy', 'Policy' cannot be null." + } + + if ($Percentage -and $Percentage -gt 100) { + throw "invalid value for 'Percentage', must be smaller than or equal to 100." + } + + if ($Percentage -and $Percentage -lt 1) { + throw "invalid value for 'Percentage', must be greater than or equal to 1." + } + + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + "version" = ${Version} + "policy" = ${Policy} + "subdomainPolicy" = ${SubdomainPolicy} + "reportEmailAddress" = ${ReportEmailAddress} + "forensicEmailAddress" = ${ForensicEmailAddress} + "percentage" = ${Percentage} + "reportFormat" = ${ReportFormat} + "secondsBetweenReports" = ${SecondsBetweenReports} + "adkim" = ${Adkim} + "aspf" = ${Aspf} + "fo" = ${Fo} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateDmarcRecordOptions + +.DESCRIPTION + +Convert from JSON to GenerateDmarcRecordOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateDmarcRecordOptions +#> +function ConvertFrom-JsonToGenerateDmarcRecordOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateDmarcRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateDmarcRecordOptions + $AllProperties = ("domain", "version", "policy", "subdomainPolicy", "reportEmailAddress", "forensicEmailAddress", "percentage", "reportFormat", "secondsBetweenReports", "adkim", "aspf", "fo") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'domain' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domain"))) { + throw "Error! JSON cannot be serialized due to the required property 'domain' missing." + } else { + $Domain = $JsonParameters.PSobject.Properties["domain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "version"))) { + throw "Error! JSON cannot be serialized due to the required property 'version' missing." + } else { + $Version = $JsonParameters.PSobject.Properties["version"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "policy"))) { + throw "Error! JSON cannot be serialized due to the required property 'policy' missing." + } else { + $Policy = $JsonParameters.PSobject.Properties["policy"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subdomainPolicy"))) { #optional property not found + $SubdomainPolicy = $null + } else { + $SubdomainPolicy = $JsonParameters.PSobject.Properties["subdomainPolicy"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reportEmailAddress"))) { #optional property not found + $ReportEmailAddress = $null + } else { + $ReportEmailAddress = $JsonParameters.PSobject.Properties["reportEmailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "forensicEmailAddress"))) { #optional property not found + $ForensicEmailAddress = $null + } else { + $ForensicEmailAddress = $JsonParameters.PSobject.Properties["forensicEmailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "percentage"))) { #optional property not found + $Percentage = $null + } else { + $Percentage = $JsonParameters.PSobject.Properties["percentage"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reportFormat"))) { #optional property not found + $ReportFormat = $null + } else { + $ReportFormat = $JsonParameters.PSobject.Properties["reportFormat"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secondsBetweenReports"))) { #optional property not found + $SecondsBetweenReports = $null + } else { + $SecondsBetweenReports = $JsonParameters.PSobject.Properties["secondsBetweenReports"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "adkim"))) { #optional property not found + $Adkim = $null + } else { + $Adkim = $JsonParameters.PSobject.Properties["adkim"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "aspf"))) { #optional property not found + $Aspf = $null + } else { + $Aspf = $JsonParameters.PSobject.Properties["aspf"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fo"))) { #optional property not found + $Fo = $null + } else { + $Fo = $JsonParameters.PSobject.Properties["fo"].value + } + + $PSO = [PSCustomObject]@{ + "domain" = ${Domain} + "version" = ${Version} + "policy" = ${Policy} + "subdomainPolicy" = ${SubdomainPolicy} + "reportEmailAddress" = ${ReportEmailAddress} + "forensicEmailAddress" = ${ForensicEmailAddress} + "percentage" = ${Percentage} + "reportFormat" = ${ReportFormat} + "secondsBetweenReports" = ${SecondsBetweenReports} + "adkim" = ${Adkim} + "aspf" = ${Aspf} + "fo" = ${Fo} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateDmarcRecordResults.ps1 b/src/maislurp-client-powershell/Model/GenerateDmarcRecordResults.ps1 new file mode 100644 index 00000000..1f143517 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateDmarcRecordResults.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. +.PARAMETER Type +Domain Name Server Record Types +.PARAMETER Ttl +No description available. +.PARAMETER Value +No description available. +.OUTPUTS + +GenerateDmarcRecordResults +#> + +function Initialize-GenerateDmarcRecordResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String] + ${Type}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Ttl}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateDmarcRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Type -eq $null) { + throw "invalid value for 'Type', 'Type' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateDmarcRecordResults + +.DESCRIPTION + +Convert from JSON to GenerateDmarcRecordResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateDmarcRecordResults +#> +function ConvertFrom-JsonToGenerateDmarcRecordResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateDmarcRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateDmarcRecordResults + $AllProperties = ("name", "type", "ttl", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "type"))) { + throw "Error! JSON cannot be serialized due to the required property 'type' missing." + } else { + $Type = $JsonParameters.PSobject.Properties["type"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateMtaStsRecordOptions.ps1 b/src/maislurp-client-powershell/Model/GenerateMtaStsRecordOptions.ps1 new file mode 100644 index 00000000..67ffc921 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateMtaStsRecordOptions.ps1 @@ -0,0 +1,193 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarHost +No description available. +.PARAMETER Version +No description available. +.PARAMETER Mode +No description available. +.PARAMETER Ttl +No description available. +.PARAMETER MaxAgeSeconds +No description available. +.PARAMETER MxRecords +No description available. +.OUTPUTS + +GenerateMtaStsRecordOptions +#> + +function Initialize-GenerateMtaStsRecordOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("STSv1")] + [String] + ${Version}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("TESTING", "ENFORCE", "NONE")] + [String] + ${Mode}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Ttl}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${MaxAgeSeconds}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${MxRecords} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateMtaStsRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + if ($Version -eq $null) { + throw "invalid value for 'Version', 'Version' cannot be null." + } + + if ($Mode -eq $null) { + throw "invalid value for 'Mode', 'Mode' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + if ($MaxAgeSeconds -eq $null) { + throw "invalid value for 'MaxAgeSeconds', 'MaxAgeSeconds' cannot be null." + } + + if ($MxRecords -eq $null) { + throw "invalid value for 'MxRecords', 'MxRecords' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + "version" = ${Version} + "mode" = ${Mode} + "ttl" = ${Ttl} + "maxAgeSeconds" = ${MaxAgeSeconds} + "mxRecords" = ${MxRecords} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateMtaStsRecordOptions + +.DESCRIPTION + +Convert from JSON to GenerateMtaStsRecordOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateMtaStsRecordOptions +#> +function ConvertFrom-JsonToGenerateMtaStsRecordOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateMtaStsRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateMtaStsRecordOptions + $AllProperties = ("host", "version", "mode", "ttl", "maxAgeSeconds", "mxRecords") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'host' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "version"))) { + throw "Error! JSON cannot be serialized due to the required property 'version' missing." + } else { + $Version = $JsonParameters.PSobject.Properties["version"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mode"))) { + throw "Error! JSON cannot be serialized due to the required property 'mode' missing." + } else { + $Mode = $JsonParameters.PSobject.Properties["mode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "maxAgeSeconds"))) { + throw "Error! JSON cannot be serialized due to the required property 'maxAgeSeconds' missing." + } else { + $MaxAgeSeconds = $JsonParameters.PSobject.Properties["maxAgeSeconds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mxRecords"))) { + throw "Error! JSON cannot be serialized due to the required property 'mxRecords' missing." + } else { + $MxRecords = $JsonParameters.PSobject.Properties["mxRecords"].value + } + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + "version" = ${Version} + "mode" = ${Mode} + "ttl" = ${Ttl} + "maxAgeSeconds" = ${MaxAgeSeconds} + "mxRecords" = ${MxRecords} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateMtaStsRecordResults.ps1 b/src/maislurp-client-powershell/Model/GenerateMtaStsRecordResults.ps1 new file mode 100644 index 00000000..a902a368 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateMtaStsRecordResults.ps1 @@ -0,0 +1,192 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. +.PARAMETER Type +Domain Name Server Record Types +.PARAMETER Ttl +No description available. +.PARAMETER Value +No description available. +.PARAMETER WellKnownValue +No description available. +.PARAMETER WellKnownUrl +No description available. +.OUTPUTS + +GenerateMtaStsRecordResults +#> + +function Initialize-GenerateMtaStsRecordResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String] + ${Type}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Ttl}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${WellKnownValue}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${WellKnownUrl} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateMtaStsRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Type -eq $null) { + throw "invalid value for 'Type', 'Type' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + if ($WellKnownValue -eq $null) { + throw "invalid value for 'WellKnownValue', 'WellKnownValue' cannot be null." + } + + if ($WellKnownUrl -eq $null) { + throw "invalid value for 'WellKnownUrl', 'WellKnownUrl' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + "wellKnownValue" = ${WellKnownValue} + "wellKnownUrl" = ${WellKnownUrl} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateMtaStsRecordResults + +.DESCRIPTION + +Convert from JSON to GenerateMtaStsRecordResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateMtaStsRecordResults +#> +function ConvertFrom-JsonToGenerateMtaStsRecordResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateMtaStsRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateMtaStsRecordResults + $AllProperties = ("name", "type", "ttl", "value", "wellKnownValue", "wellKnownUrl") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "type"))) { + throw "Error! JSON cannot be serialized due to the required property 'type' missing." + } else { + $Type = $JsonParameters.PSobject.Properties["type"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "wellKnownValue"))) { + throw "Error! JSON cannot be serialized due to the required property 'wellKnownValue' missing." + } else { + $WellKnownValue = $JsonParameters.PSobject.Properties["wellKnownValue"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "wellKnownUrl"))) { + throw "Error! JSON cannot be serialized due to the required property 'wellKnownUrl' missing." + } else { + $WellKnownUrl = $JsonParameters.PSobject.Properties["wellKnownUrl"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + "wellKnownValue" = ${WellKnownValue} + "wellKnownUrl" = ${WellKnownUrl} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateTlsReportingRecordOptions.ps1 b/src/maislurp-client-powershell/Model/GenerateTlsReportingRecordOptions.ps1 new file mode 100644 index 00000000..ce744523 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateTlsReportingRecordOptions.ps1 @@ -0,0 +1,171 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER ReportingAddresses +No description available. +.PARAMETER ReportingUrl +No description available. +.PARAMETER VarHost +No description available. +.PARAMETER Version +No description available. +.PARAMETER Ttl +No description available. +.OUTPUTS + +GenerateTlsReportingRecordOptions +#> + +function Initialize-GenerateTlsReportingRecordOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ReportingAddresses}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReportingUrl}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("TLSRPTv1")] + [String] + ${Version}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Ttl} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateTlsReportingRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ReportingAddresses -eq $null) { + throw "invalid value for 'ReportingAddresses', 'ReportingAddresses' cannot be null." + } + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + if ($Version -eq $null) { + throw "invalid value for 'Version', 'Version' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "reportingAddresses" = ${ReportingAddresses} + "reportingUrl" = ${ReportingUrl} + "host" = ${VarHost} + "version" = ${Version} + "ttl" = ${Ttl} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateTlsReportingRecordOptions + +.DESCRIPTION + +Convert from JSON to GenerateTlsReportingRecordOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateTlsReportingRecordOptions +#> +function ConvertFrom-JsonToGenerateTlsReportingRecordOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateTlsReportingRecordOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateTlsReportingRecordOptions + $AllProperties = ("reportingAddresses", "reportingUrl", "host", "version", "ttl") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'reportingAddresses' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reportingAddresses"))) { + throw "Error! JSON cannot be serialized due to the required property 'reportingAddresses' missing." + } else { + $ReportingAddresses = $JsonParameters.PSobject.Properties["reportingAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "version"))) { + throw "Error! JSON cannot be serialized due to the required property 'version' missing." + } else { + $Version = $JsonParameters.PSobject.Properties["version"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reportingUrl"))) { #optional property not found + $ReportingUrl = $null + } else { + $ReportingUrl = $JsonParameters.PSobject.Properties["reportingUrl"].value + } + + $PSO = [PSCustomObject]@{ + "reportingAddresses" = ${ReportingAddresses} + "reportingUrl" = ${ReportingUrl} + "host" = ${VarHost} + "version" = ${Version} + "ttl" = ${Ttl} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GenerateTlsReportingRecordResults.ps1 b/src/maislurp-client-powershell/Model/GenerateTlsReportingRecordResults.ps1 new file mode 100644 index 00000000..72caafa6 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GenerateTlsReportingRecordResults.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. +.PARAMETER Type +Domain Name Server Record Types +.PARAMETER Ttl +No description available. +.PARAMETER Value +No description available. +.OUTPUTS + +GenerateTlsReportingRecordResults +#> + +function Initialize-GenerateTlsReportingRecordResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV")] + [String] + ${Type}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Ttl}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GenerateTlsReportingRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Type -eq $null) { + throw "invalid value for 'Type', 'Type' cannot be null." + } + + if ($Ttl -eq $null) { + throw "invalid value for 'Ttl', 'Ttl' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GenerateTlsReportingRecordResults + +.DESCRIPTION + +Convert from JSON to GenerateTlsReportingRecordResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +GenerateTlsReportingRecordResults +#> +function ConvertFrom-JsonToGenerateTlsReportingRecordResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GenerateTlsReportingRecordResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GenerateTlsReportingRecordResults + $AllProperties = ("name", "type", "ttl", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "type"))) { + throw "Error! JSON cannot be serialized due to the required property 'type' missing." + } else { + $Type = $JsonParameters.PSobject.Properties["type"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ttl"))) { + throw "Error! JSON cannot be serialized due to the required property 'ttl' missing." + } else { + $Ttl = $JsonParameters.PSobject.Properties["ttl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "type" = ${Type} + "ttl" = ${Ttl} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GetEmailScreenshotOptions.ps1 b/src/maislurp-client-powershell/Model/GetEmailScreenshotOptions.ps1 new file mode 100644 index 00000000..e5520b9c --- /dev/null +++ b/src/maislurp-client-powershell/Model/GetEmailScreenshotOptions.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options taking a screenshot capture of a rendered email + +.PARAMETER Height +Window height in pixels +.PARAMETER Width +Window width in pixels +.OUTPUTS + +GetEmailScreenshotOptions +#> + +function Initialize-GetEmailScreenshotOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Height}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Width} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GetEmailScreenshotOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "height" = ${Height} + "width" = ${Width} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GetEmailScreenshotOptions + +.DESCRIPTION + +Convert from JSON to GetEmailScreenshotOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +GetEmailScreenshotOptions +#> +function ConvertFrom-JsonToGetEmailScreenshotOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GetEmailScreenshotOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GetEmailScreenshotOptions + $AllProperties = ("height", "width") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "height"))) { #optional property not found + $Height = $null + } else { + $Height = $JsonParameters.PSobject.Properties["height"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "width"))) { #optional property not found + $Width = $null + } else { + $Width = $JsonParameters.PSobject.Properties["width"].value + } + + $PSO = [PSCustomObject]@{ + "height" = ${Height} + "width" = ${Width} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GravatarUrl.ps1 b/src/maislurp-client-powershell/Model/GravatarUrl.ps1 new file mode 100644 index 00000000..88cebf0e --- /dev/null +++ b/src/maislurp-client-powershell/Model/GravatarUrl.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +User image + +.PARAMETER Url +No description available. +.PARAMETER Hash +No description available. +.OUTPUTS + +GravatarUrl +#> + +function Initialize-GravatarUrl { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Hash} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GravatarUrl' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($Hash -eq $null) { + throw "invalid value for 'Hash', 'Hash' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "hash" = ${Hash} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GravatarUrl + +.DESCRIPTION + +Convert from JSON to GravatarUrl + +.PARAMETER Json + +Json object + +.OUTPUTS + +GravatarUrl +#> +function ConvertFrom-JsonToGravatarUrl { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GravatarUrl' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GravatarUrl + $AllProperties = ("url", "hash") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'url' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hash"))) { + throw "Error! JSON cannot be serialized due to the required property 'hash' missing." + } else { + $Hash = $JsonParameters.PSobject.Properties["hash"].value + } + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "hash" = ${Hash} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GroupContactsDto.ps1 b/src/maislurp-client-powershell/Model/GroupContactsDto.ps1 new file mode 100644 index 00000000..bb508186 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GroupContactsDto.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Describes contacts attached to a contact group + +.PARAMETER Group +No description available. +.PARAMETER Contacts +No description available. +.OUTPUTS + +GroupContactsDto +#> + +function Initialize-GroupContactsDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Group}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Contacts} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GroupContactsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Group -eq $null) { + throw "invalid value for 'Group', 'Group' cannot be null." + } + + if ($Contacts -eq $null) { + throw "invalid value for 'Contacts', 'Contacts' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "group" = ${Group} + "contacts" = ${Contacts} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GroupContactsDto + +.DESCRIPTION + +Convert from JSON to GroupContactsDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +GroupContactsDto +#> +function ConvertFrom-JsonToGroupContactsDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GroupContactsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GroupContactsDto + $AllProperties = ("group", "contacts") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'group' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "group"))) { + throw "Error! JSON cannot be serialized due to the required property 'group' missing." + } else { + $Group = $JsonParameters.PSobject.Properties["group"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contacts"))) { + throw "Error! JSON cannot be serialized due to the required property 'contacts' missing." + } else { + $Contacts = $JsonParameters.PSobject.Properties["contacts"].value + } + + $PSO = [PSCustomObject]@{ + "group" = ${Group} + "contacts" = ${Contacts} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GroupDto.ps1 b/src/maislurp-client-powershell/Model/GroupDto.ps1 new file mode 100644 index 00000000..6bb102ec --- /dev/null +++ b/src/maislurp-client-powershell/Model/GroupDto.ps1 @@ -0,0 +1,153 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Contact group data + +.PARAMETER Id +No description available. +.PARAMETER Name +No description available. +.PARAMETER Description +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +GroupDto +#> + +function Initialize-GroupDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GroupDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "name" = ${Name} + "description" = ${Description} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GroupDto + +.DESCRIPTION + +Convert from JSON to GroupDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +GroupDto +#> +function ConvertFrom-JsonToGroupDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GroupDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GroupDto + $AllProperties = ("id", "name", "description", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "name" = ${Name} + "description" = ${Description} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/GroupProjection.ps1 b/src/maislurp-client-powershell/Model/GroupProjection.ps1 new file mode 100644 index 00000000..73607422 --- /dev/null +++ b/src/maislurp-client-powershell/Model/GroupProjection.ps1 @@ -0,0 +1,153 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Data for contact group + +.PARAMETER CreatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER Id +No description available. +.PARAMETER Description +No description available. +.OUTPUTS + +GroupProjection +#> + +function Initialize-GroupProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => GroupProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "createdAt" = ${CreatedAt} + "name" = ${Name} + "id" = ${Id} + "description" = ${Description} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to GroupProjection + +.DESCRIPTION + +Convert from JSON to GroupProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +GroupProjection +#> +function ConvertFrom-JsonToGroupProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => GroupProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in GroupProjection + $AllProperties = ("createdAt", "name", "id", "description") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + $PSO = [PSCustomObject]@{ + "createdAt" = ${CreatedAt} + "name" = ${Name} + "id" = ${Id} + "description" = ${Description} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/HTMLValidationResult.ps1 b/src/maislurp-client-powershell/Model/HTMLValidationResult.ps1 new file mode 100644 index 00000000..847ce90f --- /dev/null +++ b/src/maislurp-client-powershell/Model/HTMLValidationResult.ps1 @@ -0,0 +1,157 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +HTML Validation Results + +.PARAMETER IsValid +Is HTML validation result valid +.PARAMETER Infos +Optional infos resulting from HTML validation +.PARAMETER Errors +Optional errors resulting from HTML validation +.PARAMETER Warnings +Optional warnings resulting from HTML validation +.OUTPUTS + +HTMLValidationResult +#> + +function Initialize-HTMLValidationResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsValid}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Infos}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Errors}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Warnings} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => HTMLValidationResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($IsValid -eq $null) { + throw "invalid value for 'IsValid', 'IsValid' cannot be null." + } + + if ($Infos -eq $null) { + throw "invalid value for 'Infos', 'Infos' cannot be null." + } + + if ($Errors -eq $null) { + throw "invalid value for 'Errors', 'Errors' cannot be null." + } + + if ($Warnings -eq $null) { + throw "invalid value for 'Warnings', 'Warnings' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "isValid" = ${IsValid} + "infos" = ${Infos} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to HTMLValidationResult + +.DESCRIPTION + +Convert from JSON to HTMLValidationResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +HTMLValidationResult +#> +function ConvertFrom-JsonToHTMLValidationResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => HTMLValidationResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in HTMLValidationResult + $AllProperties = ("isValid", "infos", "errors", "warnings") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'isValid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isValid"))) { + throw "Error! JSON cannot be serialized due to the required property 'isValid' missing." + } else { + $IsValid = $JsonParameters.PSobject.Properties["isValid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "infos"))) { + throw "Error! JSON cannot be serialized due to the required property 'infos' missing." + } else { + $Infos = $JsonParameters.PSobject.Properties["infos"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "errors"))) { + throw "Error! JSON cannot be serialized due to the required property 'errors' missing." + } else { + $Errors = $JsonParameters.PSobject.Properties["errors"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "warnings"))) { + throw "Error! JSON cannot be serialized due to the required property 'warnings' missing." + } else { + $Warnings = $JsonParameters.PSobject.Properties["warnings"].value + } + + $PSO = [PSCustomObject]@{ + "isValid" = ${IsValid} + "infos" = ${Infos} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/IPAddressResult.ps1 b/src/maislurp-client-powershell/Model/IPAddressResult.ps1 new file mode 100644 index 00000000..66ff2dee --- /dev/null +++ b/src/maislurp-client-powershell/Model/IPAddressResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +IP Address look up result for a given domain / hostname + +.PARAMETER Address +No description available. +.PARAMETER Hostname +No description available. +.OUTPUTS + +IPAddressResult +#> + +function Initialize-IPAddressResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Address}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Hostname} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => IPAddressResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Address -eq $null) { + throw "invalid value for 'Address', 'Address' cannot be null." + } + + if ($Hostname -eq $null) { + throw "invalid value for 'Hostname', 'Hostname' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "address" = ${Address} + "hostname" = ${Hostname} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to IPAddressResult + +.DESCRIPTION + +Convert from JSON to IPAddressResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +IPAddressResult +#> +function ConvertFrom-JsonToIPAddressResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => IPAddressResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in IPAddressResult + $AllProperties = ("address", "hostname") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'address' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "address"))) { + throw "Error! JSON cannot be serialized due to the required property 'address' missing." + } else { + $Address = $JsonParameters.PSobject.Properties["address"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "hostname"))) { + throw "Error! JSON cannot be serialized due to the required property 'hostname' missing." + } else { + $Hostname = $JsonParameters.PSobject.Properties["hostname"].value + } + + $PSO = [PSCustomObject]@{ + "address" = ${Address} + "hostname" = ${Hostname} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImageIssue.ps1 b/src/maislurp-client-powershell/Model/ImageIssue.ps1 new file mode 100644 index 00000000..7abd6b6e --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImageIssue.ps1 @@ -0,0 +1,154 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Url +No description available. +.PARAMETER ResponseStatus +No description available. +.PARAMETER Severity +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +ImageIssue +#> + +function Initialize-ImageIssue { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${ResponseStatus}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("Warning", "Error")] + [String] + ${Severity}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImageIssue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($Severity -eq $null) { + throw "invalid value for 'Severity', 'Severity' cannot be null." + } + + if ($Message -eq $null) { + throw "invalid value for 'Message', 'Message' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "responseStatus" = ${ResponseStatus} + "severity" = ${Severity} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImageIssue + +.DESCRIPTION + +Convert from JSON to ImageIssue + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImageIssue +#> +function ConvertFrom-JsonToImageIssue { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImageIssue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImageIssue + $AllProperties = ("url", "responseStatus", "severity", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'url' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "severity"))) { + throw "Error! JSON cannot be serialized due to the required property 'severity' missing." + } else { + $Severity = $JsonParameters.PSobject.Properties["severity"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { + throw "Error! JSON cannot be serialized due to the required property 'message' missing." + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "responseStatus"))) { #optional property not found + $ResponseStatus = $null + } else { + $ResponseStatus = $JsonParameters.PSobject.Properties["responseStatus"].value + } + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "responseStatus" = ${ResponseStatus} + "severity" = ${Severity} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapAccessDetails.ps1 b/src/maislurp-client-powershell/Model/ImapAccessDetails.ps1 new file mode 100644 index 00000000..75fbf2f0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapAccessDetails.ps1 @@ -0,0 +1,242 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Access details for inbox using IMAP + +.PARAMETER SecureImapServerHost +Secure TLS IMAP server host domain +.PARAMETER SecureImapServerPort +Secure TLS IMAP server host port +.PARAMETER SecureImapUsername +Secure TLS IMAP username for login +.PARAMETER SecureImapPassword +Secure TLS IMAP password for login +.PARAMETER ImapServerHost +IMAP server host domain +.PARAMETER ImapServerPort +IMAP server host port +.PARAMETER ImapUsername +IMAP username for login +.PARAMETER ImapPassword +IMAP password for login +.PARAMETER ImapMailbox +IMAP mailbox to SELECT +.OUTPUTS + +ImapAccessDetails +#> + +function Initialize-ImapAccessDetails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureImapServerHost}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${SecureImapServerPort}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureImapUsername}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureImapPassword}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapServerHost}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${ImapServerPort}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapUsername}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapPassword}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapMailbox} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapAccessDetails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($SecureImapServerHost -eq $null) { + throw "invalid value for 'SecureImapServerHost', 'SecureImapServerHost' cannot be null." + } + + if ($SecureImapServerPort -eq $null) { + throw "invalid value for 'SecureImapServerPort', 'SecureImapServerPort' cannot be null." + } + + if ($SecureImapUsername -eq $null) { + throw "invalid value for 'SecureImapUsername', 'SecureImapUsername' cannot be null." + } + + if ($SecureImapPassword -eq $null) { + throw "invalid value for 'SecureImapPassword', 'SecureImapPassword' cannot be null." + } + + if ($ImapServerHost -eq $null) { + throw "invalid value for 'ImapServerHost', 'ImapServerHost' cannot be null." + } + + if ($ImapServerPort -eq $null) { + throw "invalid value for 'ImapServerPort', 'ImapServerPort' cannot be null." + } + + if ($ImapUsername -eq $null) { + throw "invalid value for 'ImapUsername', 'ImapUsername' cannot be null." + } + + if ($ImapPassword -eq $null) { + throw "invalid value for 'ImapPassword', 'ImapPassword' cannot be null." + } + + if ($ImapMailbox -eq $null) { + throw "invalid value for 'ImapMailbox', 'ImapMailbox' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "secureImapServerHost" = ${SecureImapServerHost} + "secureImapServerPort" = ${SecureImapServerPort} + "secureImapUsername" = ${SecureImapUsername} + "secureImapPassword" = ${SecureImapPassword} + "imapServerHost" = ${ImapServerHost} + "imapServerPort" = ${ImapServerPort} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "imapMailbox" = ${ImapMailbox} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapAccessDetails + +.DESCRIPTION + +Convert from JSON to ImapAccessDetails + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapAccessDetails +#> +function ConvertFrom-JsonToImapAccessDetails { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapAccessDetails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapAccessDetails + $AllProperties = ("secureImapServerHost", "secureImapServerPort", "secureImapUsername", "secureImapPassword", "imapServerHost", "imapServerPort", "imapUsername", "imapPassword", "imapMailbox") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'secureImapServerHost' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapServerHost' missing." + } else { + $SecureImapServerHost = $JsonParameters.PSobject.Properties["secureImapServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapServerPort' missing." + } else { + $SecureImapServerPort = $JsonParameters.PSobject.Properties["secureImapServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapUsername' missing." + } else { + $SecureImapUsername = $JsonParameters.PSobject.Properties["secureImapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapPassword' missing." + } else { + $SecureImapPassword = $JsonParameters.PSobject.Properties["secureImapPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapServerHost' missing." + } else { + $ImapServerHost = $JsonParameters.PSobject.Properties["imapServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapServerPort' missing." + } else { + $ImapServerPort = $JsonParameters.PSobject.Properties["imapServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapUsername' missing." + } else { + $ImapUsername = $JsonParameters.PSobject.Properties["imapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapPassword' missing." + } else { + $ImapPassword = $JsonParameters.PSobject.Properties["imapPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapMailbox"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapMailbox' missing." + } else { + $ImapMailbox = $JsonParameters.PSobject.Properties["imapMailbox"].value + } + + $PSO = [PSCustomObject]@{ + "secureImapServerHost" = ${SecureImapServerHost} + "secureImapServerPort" = ${SecureImapServerPort} + "secureImapUsername" = ${SecureImapUsername} + "secureImapPassword" = ${SecureImapPassword} + "imapServerHost" = ${ImapServerHost} + "imapServerPort" = ${ImapServerPort} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "imapMailbox" = ${ImapMailbox} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapEmailProjection.ps1 b/src/maislurp-client-powershell/Model/ImapEmailProjection.ps1 new file mode 100644 index 00000000..c581da09 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapEmailProjection.ps1 @@ -0,0 +1,170 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Read +No description available. +.PARAMETER Uid +No description available. +.PARAMETER SeqNum +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ImapEmailProjection +#> + +function Initialize-ImapEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Read}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Uid}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${SeqNum}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Uid -eq $null) { + throw "invalid value for 'Uid', 'Uid' cannot be null." + } + + if ($SeqNum -eq $null) { + throw "invalid value for 'SeqNum', 'SeqNum' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "read" = ${Read} + "uid" = ${Uid} + "seqNum" = ${SeqNum} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapEmailProjection + +.DESCRIPTION + +Convert from JSON to ImapEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapEmailProjection +#> +function ConvertFrom-JsonToImapEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapEmailProjection + $AllProperties = ("read", "uid", "seqNum", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'uid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uid"))) { + throw "Error! JSON cannot be serialized due to the required property 'uid' missing." + } else { + $Uid = $JsonParameters.PSobject.Properties["uid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seqNum"))) { + throw "Error! JSON cannot be serialized due to the required property 'seqNum' missing." + } else { + $SeqNum = $JsonParameters.PSobject.Properties["seqNum"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { #optional property not found + $Read = $null + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + $PSO = [PSCustomObject]@{ + "read" = ${Read} + "uid" = ${Uid} + "seqNum" = ${SeqNum} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapFlagOperationOptions.ps1 b/src/maislurp-client-powershell/Model/ImapFlagOperationOptions.ps1 new file mode 100644 index 00000000..54d42e53 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapFlagOperationOptions.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +IMAP operation flags + +.PARAMETER FlagOperation +No description available. +.PARAMETER Flags +No description available. +.OUTPUTS + +ImapFlagOperationOptions +#> + +function Initialize-ImapFlagOperationOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SET_FLAGS", "ADD_FLAGS", "REMOVE_FLAGS")] + [String] + ${FlagOperation}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Flags} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapFlagOperationOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($FlagOperation -eq $null) { + throw "invalid value for 'FlagOperation', 'FlagOperation' cannot be null." + } + + if ($Flags -eq $null) { + throw "invalid value for 'Flags', 'Flags' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "flagOperation" = ${FlagOperation} + "flags" = ${Flags} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapFlagOperationOptions + +.DESCRIPTION + +Convert from JSON to ImapFlagOperationOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapFlagOperationOptions +#> +function ConvertFrom-JsonToImapFlagOperationOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapFlagOperationOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapFlagOperationOptions + $AllProperties = ("flagOperation", "flags") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'flagOperation' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "flagOperation"))) { + throw "Error! JSON cannot be serialized due to the required property 'flagOperation' missing." + } else { + $FlagOperation = $JsonParameters.PSobject.Properties["flagOperation"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "flags"))) { + throw "Error! JSON cannot be serialized due to the required property 'flags' missing." + } else { + $Flags = $JsonParameters.PSobject.Properties["flags"].value + } + + $PSO = [PSCustomObject]@{ + "flagOperation" = ${FlagOperation} + "flags" = ${Flags} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapMailboxStatus.ps1 b/src/maislurp-client-powershell/Model/ImapMailboxStatus.ps1 new file mode 100644 index 00000000..5850b050 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapMailboxStatus.ps1 @@ -0,0 +1,277 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Name +The mailbox name. +.PARAMETER ReadOnly +True if the mailbox is open in read-only mode. +.PARAMETER Items +Results map +.PARAMETER Flags +The mailbox flags. +.PARAMETER PermanentFlags +The mailbox permanent flags. +.PARAMETER UnseenSeqNum +The sequence number of the first unseen message in the mailbox. +.PARAMETER Messages +The number of messages in this mailbox. +.PARAMETER Recent +The number of messages not seen since the last time the mailbox was opened. +.PARAMETER Unseen +The number of unread messages. +.PARAMETER UidNext +The next UID. +.PARAMETER UidValidity +Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1. +.PARAMETER AppendLimit +Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension +.OUTPUTS + +ImapMailboxStatus +#> + +function Initialize-ImapMailboxStatus { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${ReadOnly}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Items}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Flags}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${PermanentFlags}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${UnseenSeqNum}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Messages}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Recent}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Unseen}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${UidNext}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${UidValidity}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${AppendLimit} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapMailboxStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($ReadOnly -eq $null) { + throw "invalid value for 'ReadOnly', 'ReadOnly' cannot be null." + } + + if ($UnseenSeqNum -eq $null) { + throw "invalid value for 'UnseenSeqNum', 'UnseenSeqNum' cannot be null." + } + + if ($Messages -eq $null) { + throw "invalid value for 'Messages', 'Messages' cannot be null." + } + + if ($Recent -eq $null) { + throw "invalid value for 'Recent', 'Recent' cannot be null." + } + + if ($Unseen -eq $null) { + throw "invalid value for 'Unseen', 'Unseen' cannot be null." + } + + if ($UidNext -eq $null) { + throw "invalid value for 'UidNext', 'UidNext' cannot be null." + } + + if ($UidValidity -eq $null) { + throw "invalid value for 'UidValidity', 'UidValidity' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "readOnly" = ${ReadOnly} + "items" = ${Items} + "flags" = ${Flags} + "permanentFlags" = ${PermanentFlags} + "unseenSeqNum" = ${UnseenSeqNum} + "messages" = ${Messages} + "recent" = ${Recent} + "unseen" = ${Unseen} + "uidNext" = ${UidNext} + "uidValidity" = ${UidValidity} + "appendLimit" = ${AppendLimit} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapMailboxStatus + +.DESCRIPTION + +Convert from JSON to ImapMailboxStatus + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapMailboxStatus +#> +function ConvertFrom-JsonToImapMailboxStatus { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapMailboxStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapMailboxStatus + $AllProperties = ("name", "readOnly", "items", "flags", "permanentFlags", "unseenSeqNum", "messages", "recent", "unseen", "uidNext", "uidValidity", "appendLimit") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "readOnly"))) { + throw "Error! JSON cannot be serialized due to the required property 'readOnly' missing." + } else { + $ReadOnly = $JsonParameters.PSobject.Properties["readOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "items"))) { + throw "Error! JSON cannot be serialized due to the required property 'items' missing." + } else { + $Items = $JsonParameters.PSobject.Properties["items"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "flags"))) { + throw "Error! JSON cannot be serialized due to the required property 'flags' missing." + } else { + $Flags = $JsonParameters.PSobject.Properties["flags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "permanentFlags"))) { + throw "Error! JSON cannot be serialized due to the required property 'permanentFlags' missing." + } else { + $PermanentFlags = $JsonParameters.PSobject.Properties["permanentFlags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unseenSeqNum"))) { + throw "Error! JSON cannot be serialized due to the required property 'unseenSeqNum' missing." + } else { + $UnseenSeqNum = $JsonParameters.PSobject.Properties["unseenSeqNum"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messages"))) { + throw "Error! JSON cannot be serialized due to the required property 'messages' missing." + } else { + $Messages = $JsonParameters.PSobject.Properties["messages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recent"))) { + throw "Error! JSON cannot be serialized due to the required property 'recent' missing." + } else { + $Recent = $JsonParameters.PSobject.Properties["recent"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unseen"))) { + throw "Error! JSON cannot be serialized due to the required property 'unseen' missing." + } else { + $Unseen = $JsonParameters.PSobject.Properties["unseen"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uidNext"))) { + throw "Error! JSON cannot be serialized due to the required property 'uidNext' missing." + } else { + $UidNext = $JsonParameters.PSobject.Properties["uidNext"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uidValidity"))) { + throw "Error! JSON cannot be serialized due to the required property 'uidValidity' missing." + } else { + $UidValidity = $JsonParameters.PSobject.Properties["uidValidity"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "appendLimit"))) { #optional property not found + $AppendLimit = $null + } else { + $AppendLimit = $JsonParameters.PSobject.Properties["appendLimit"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "readOnly" = ${ReadOnly} + "items" = ${Items} + "flags" = ${Flags} + "permanentFlags" = ${PermanentFlags} + "unseenSeqNum" = ${UnseenSeqNum} + "messages" = ${Messages} + "recent" = ${Recent} + "unseen" = ${Unseen} + "uidNext" = ${UidNext} + "uidValidity" = ${UidValidity} + "appendLimit" = ${AppendLimit} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerFetchItem.ps1 b/src/maislurp-client-powershell/Model/ImapServerFetchItem.ps1 new file mode 100644 index 00000000..a70b11a9 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerFetchItem.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +IMAP fetch content in raw format + +.PARAMETER Content +Content of the email +.PARAMETER Id +ID of the email +.PARAMETER Uid +UID of the email +.PARAMETER SeqNum +Sequence number of the email +.PARAMETER Read +Read status of the email +.OUTPUTS + +ImapServerFetchItem +#> + +function Initialize-ImapServerFetchItem { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Uid}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${SeqNum}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerFetchItem' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Content -eq $null) { + throw "invalid value for 'Content', 'Content' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Uid -eq $null) { + throw "invalid value for 'Uid', 'Uid' cannot be null." + } + + if ($SeqNum -eq $null) { + throw "invalid value for 'SeqNum', 'SeqNum' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "id" = ${Id} + "uid" = ${Uid} + "seqNum" = ${SeqNum} + "read" = ${Read} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerFetchItem + +.DESCRIPTION + +Convert from JSON to ImapServerFetchItem + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerFetchItem +#> +function ConvertFrom-JsonToImapServerFetchItem { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerFetchItem' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerFetchItem + $AllProperties = ("content", "id", "uid", "seqNum", "read") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'content' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { + throw "Error! JSON cannot be serialized due to the required property 'content' missing." + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uid"))) { + throw "Error! JSON cannot be serialized due to the required property 'uid' missing." + } else { + $Uid = $JsonParameters.PSobject.Properties["uid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seqNum"))) { + throw "Error! JSON cannot be serialized due to the required property 'seqNum' missing." + } else { + $SeqNum = $JsonParameters.PSobject.Properties["seqNum"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "id" = ${Id} + "uid" = ${Uid} + "seqNum" = ${SeqNum} + "read" = ${Read} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerFetchResult.ps1 b/src/maislurp-client-powershell/Model/ImapServerFetchResult.ps1 new file mode 100644 index 00000000..f0c68594 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerFetchResult.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +IMAP fetch email result + +.PARAMETER Result +No description available. +.OUTPUTS + +ImapServerFetchResult +#> + +function Initialize-ImapServerFetchResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Result} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerFetchResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerFetchResult + +.DESCRIPTION + +Convert from JSON to ImapServerFetchResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerFetchResult +#> +function ConvertFrom-JsonToImapServerFetchResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerFetchResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerFetchResult + $AllProperties = ("result") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "result"))) { #optional property not found + $Result = $null + } else { + $Result = $JsonParameters.PSobject.Properties["result"].value + } + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerGetResult.ps1 b/src/maislurp-client-powershell/Model/ImapServerGetResult.ps1 new file mode 100644 index 00000000..dc6bece6 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerGetResult.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Result +No description available. +.OUTPUTS + +ImapServerGetResult +#> + +function Initialize-ImapServerGetResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Result} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerGetResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerGetResult + +.DESCRIPTION + +Convert from JSON to ImapServerGetResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerGetResult +#> +function ConvertFrom-JsonToImapServerGetResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerGetResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerGetResult + $AllProperties = ("result") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "result"))) { #optional property not found + $Result = $null + } else { + $Result = $JsonParameters.PSobject.Properties["result"].value + } + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerListOptions.ps1 b/src/maislurp-client-powershell/Model/ImapServerListOptions.ps1 new file mode 100644 index 00000000..a27ffb70 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerListOptions.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER UidSet +No description available. +.PARAMETER SeqSet +No description available. +.OUTPUTS + +ImapServerListOptions +#> + +function Initialize-ImapServerListOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${UidSet}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${SeqSet} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerListOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "uidSet" = ${UidSet} + "seqSet" = ${SeqSet} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerListOptions + +.DESCRIPTION + +Convert from JSON to ImapServerListOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerListOptions +#> +function ConvertFrom-JsonToImapServerListOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerListOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerListOptions + $AllProperties = ("uidSet", "seqSet") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uidSet"))) { #optional property not found + $UidSet = $null + } else { + $UidSet = $JsonParameters.PSobject.Properties["uidSet"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seqSet"))) { #optional property not found + $SeqSet = $null + } else { + $SeqSet = $JsonParameters.PSobject.Properties["seqSet"].value + } + + $PSO = [PSCustomObject]@{ + "uidSet" = ${UidSet} + "seqSet" = ${SeqSet} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerListResult.ps1 b/src/maislurp-client-powershell/Model/ImapServerListResult.ps1 new file mode 100644 index 00000000..658669c2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerListResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Results +No description available. +.OUTPUTS + +ImapServerListResult +#> + +function Initialize-ImapServerListResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Results} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerListResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Results -eq $null) { + throw "invalid value for 'Results', 'Results' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "results" = ${Results} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerListResult + +.DESCRIPTION + +Convert from JSON to ImapServerListResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerListResult +#> +function ConvertFrom-JsonToImapServerListResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerListResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerListResult + $AllProperties = ("results") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'results' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "results"))) { + throw "Error! JSON cannot be serialized due to the required property 'results' missing." + } else { + $Results = $JsonParameters.PSobject.Properties["results"].value + } + + $PSO = [PSCustomObject]@{ + "results" = ${Results} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerSearchOptions.ps1 b/src/maislurp-client-powershell/Model/ImapServerSearchOptions.ps1 new file mode 100644 index 00000000..760945a3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerSearchOptions.ps1 @@ -0,0 +1,228 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +IMAP server search options + +.PARAMETER SeqNum +No description available. +.PARAMETER Uid +No description available. +.PARAMETER Since +No description available. +.PARAMETER Before +No description available. +.PARAMETER SentSince +No description available. +.PARAMETER SentBefore +No description available. +.PARAMETER Header +No description available. +.PARAMETER Body +No description available. +.PARAMETER Text +No description available. +.PARAMETER WithFlags +No description available. +.PARAMETER WithoutFlags +No description available. +.OUTPUTS + +ImapServerSearchOptions +#> + +function Initialize-ImapServerSearchOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SeqNum}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Uid}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${SentSince}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${SentBefore}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${Header}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Body}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Text}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${WithFlags}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${WithoutFlags} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerSearchOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "seqNum" = ${SeqNum} + "uid" = ${Uid} + "since" = ${Since} + "before" = ${Before} + "sentSince" = ${SentSince} + "sentBefore" = ${SentBefore} + "header" = ${Header} + "body" = ${Body} + "text" = ${Text} + "withFlags" = ${WithFlags} + "withoutFlags" = ${WithoutFlags} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerSearchOptions + +.DESCRIPTION + +Convert from JSON to ImapServerSearchOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerSearchOptions +#> +function ConvertFrom-JsonToImapServerSearchOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerSearchOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerSearchOptions + $AllProperties = ("seqNum", "uid", "since", "before", "sentSince", "sentBefore", "header", "body", "text", "withFlags", "withoutFlags") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seqNum"))) { #optional property not found + $SeqNum = $null + } else { + $SeqNum = $JsonParameters.PSobject.Properties["seqNum"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uid"))) { #optional property not found + $Uid = $null + } else { + $Uid = $JsonParameters.PSobject.Properties["uid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found + $Since = $null + } else { + $Since = $JsonParameters.PSobject.Properties["since"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "before"))) { #optional property not found + $Before = $null + } else { + $Before = $JsonParameters.PSobject.Properties["before"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentSince"))) { #optional property not found + $SentSince = $null + } else { + $SentSince = $JsonParameters.PSobject.Properties["sentSince"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentBefore"))) { #optional property not found + $SentBefore = $null + } else { + $SentBefore = $JsonParameters.PSobject.Properties["sentBefore"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "header"))) { #optional property not found + $Header = $null + } else { + $Header = $JsonParameters.PSobject.Properties["header"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "text"))) { #optional property not found + $Text = $null + } else { + $Text = $JsonParameters.PSobject.Properties["text"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "withFlags"))) { #optional property not found + $WithFlags = $null + } else { + $WithFlags = $JsonParameters.PSobject.Properties["withFlags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "withoutFlags"))) { #optional property not found + $WithoutFlags = $null + } else { + $WithoutFlags = $JsonParameters.PSobject.Properties["withoutFlags"].value + } + + $PSO = [PSCustomObject]@{ + "seqNum" = ${SeqNum} + "uid" = ${Uid} + "since" = ${Since} + "before" = ${Before} + "sentSince" = ${SentSince} + "sentBefore" = ${SentBefore} + "header" = ${Header} + "body" = ${Body} + "text" = ${Text} + "withFlags" = ${WithFlags} + "withoutFlags" = ${WithoutFlags} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerSearchResult.ps1 b/src/maislurp-client-powershell/Model/ImapServerSearchResult.ps1 new file mode 100644 index 00000000..add55218 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerSearchResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Results +No description available. +.OUTPUTS + +ImapServerSearchResult +#> + +function Initialize-ImapServerSearchResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Results} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerSearchResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Results -eq $null) { + throw "invalid value for 'Results', 'Results' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "results" = ${Results} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerSearchResult + +.DESCRIPTION + +Convert from JSON to ImapServerSearchResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerSearchResult +#> +function ConvertFrom-JsonToImapServerSearchResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerSearchResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerSearchResult + $AllProperties = ("results") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'results' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "results"))) { + throw "Error! JSON cannot be serialized due to the required property 'results' missing." + } else { + $Results = $JsonParameters.PSobject.Properties["results"].value + } + + $PSO = [PSCustomObject]@{ + "results" = ${Results} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerStatusOptions.ps1 b/src/maislurp-client-powershell/Model/ImapServerStatusOptions.ps1 new file mode 100644 index 00000000..73d1dde4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerStatusOptions.ps1 @@ -0,0 +1,112 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Name +No description available. +.PARAMETER StatusItems +No description available. +.OUTPUTS + +ImapServerStatusOptions +#> + +function Initialize-ImapServerStatusOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("MESSAGES", "RECENT", "UIDNEXT", "UIDVALIDITY", "UNSEEN", "APPENDLIMIT")] + [String[]] + ${StatusItems} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerStatusOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "statusItems" = ${StatusItems} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerStatusOptions + +.DESCRIPTION + +Convert from JSON to ImapServerStatusOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerStatusOptions +#> +function ConvertFrom-JsonToImapServerStatusOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerStatusOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerStatusOptions + $AllProperties = ("name", "statusItems") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "statusItems"))) { #optional property not found + $StatusItems = $null + } else { + $StatusItems = $JsonParameters.PSobject.Properties["statusItems"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "statusItems" = ${StatusItems} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapServerStatusResult.ps1 b/src/maislurp-client-powershell/Model/ImapServerStatusResult.ps1 new file mode 100644 index 00000000..5f4bf1c8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapServerStatusResult.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Result +No description available. +.OUTPUTS + +ImapServerStatusResult +#> + +function Initialize-ImapServerStatusResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Result} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapServerStatusResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapServerStatusResult + +.DESCRIPTION + +Convert from JSON to ImapServerStatusResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapServerStatusResult +#> +function ConvertFrom-JsonToImapServerStatusResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapServerStatusResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapServerStatusResult + $AllProperties = ("result") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "result"))) { #optional property not found + $Result = $null + } else { + $Result = $JsonParameters.PSobject.Properties["result"].value + } + + $PSO = [PSCustomObject]@{ + "result" = ${Result} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapSmtpAccessDetails.ps1 b/src/maislurp-client-powershell/Model/ImapSmtpAccessDetails.ps1 new file mode 100644 index 00000000..938d0ffc --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapSmtpAccessDetails.ps1 @@ -0,0 +1,391 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Access details for inbox using SMTP or IMAP + +.PARAMETER SecureSmtpServerHost +Secure TLS SMTP server host domain +.PARAMETER SecureSmtpServerPort +Secure TLS SMTP server host port +.PARAMETER SecureSmtpUsername +Secure TLS SMTP username for login +.PARAMETER SecureSmtpPassword +Secure TLS SMTP password for login +.PARAMETER SmtpServerHost +SMTP server host domain +.PARAMETER SmtpServerPort +SMTP server host port +.PARAMETER SmtpUsername +SMTP username for login +.PARAMETER SmtpPassword +SMTP password for login +.PARAMETER SecureImapServerHost +Secure TLS IMAP server host domain +.PARAMETER SecureImapServerPort +Secure TLS IMAP server host port +.PARAMETER SecureImapUsername +Secure TLS IMAP username for login +.PARAMETER SecureImapPassword +Secure TLS IMAP password for login +.PARAMETER ImapServerHost +IMAP server host domain +.PARAMETER ImapServerPort +IMAP server host port +.PARAMETER ImapUsername +IMAP username for login +.PARAMETER ImapPassword +IMAP password for login +.PARAMETER ImapMailbox +IMAP mailbox to SELECT +.PARAMETER MailFromDomain +Mail from domain or SMTP HELO value +.OUTPUTS + +ImapSmtpAccessDetails +#> + +function Initialize-ImapSmtpAccessDetails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureSmtpServerHost}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${SecureSmtpServerPort}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureSmtpUsername}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureSmtpPassword}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpServerHost}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${SmtpServerPort}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpUsername}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpPassword}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureImapServerHost}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${SecureImapServerPort}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureImapUsername}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureImapPassword}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapServerHost}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${ImapServerPort}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapUsername}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapPassword}, + [Parameter(Position = 16, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapMailbox}, + [Parameter(Position = 17, ValueFromPipelineByPropertyName = $true)] + [String] + ${MailFromDomain} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapSmtpAccessDetails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($SecureSmtpServerHost -eq $null) { + throw "invalid value for 'SecureSmtpServerHost', 'SecureSmtpServerHost' cannot be null." + } + + if ($SecureSmtpServerPort -eq $null) { + throw "invalid value for 'SecureSmtpServerPort', 'SecureSmtpServerPort' cannot be null." + } + + if ($SecureSmtpUsername -eq $null) { + throw "invalid value for 'SecureSmtpUsername', 'SecureSmtpUsername' cannot be null." + } + + if ($SecureSmtpPassword -eq $null) { + throw "invalid value for 'SecureSmtpPassword', 'SecureSmtpPassword' cannot be null." + } + + if ($SmtpServerHost -eq $null) { + throw "invalid value for 'SmtpServerHost', 'SmtpServerHost' cannot be null." + } + + if ($SmtpServerPort -eq $null) { + throw "invalid value for 'SmtpServerPort', 'SmtpServerPort' cannot be null." + } + + if ($SmtpUsername -eq $null) { + throw "invalid value for 'SmtpUsername', 'SmtpUsername' cannot be null." + } + + if ($SmtpPassword -eq $null) { + throw "invalid value for 'SmtpPassword', 'SmtpPassword' cannot be null." + } + + if ($SecureImapServerHost -eq $null) { + throw "invalid value for 'SecureImapServerHost', 'SecureImapServerHost' cannot be null." + } + + if ($SecureImapServerPort -eq $null) { + throw "invalid value for 'SecureImapServerPort', 'SecureImapServerPort' cannot be null." + } + + if ($SecureImapUsername -eq $null) { + throw "invalid value for 'SecureImapUsername', 'SecureImapUsername' cannot be null." + } + + if ($SecureImapPassword -eq $null) { + throw "invalid value for 'SecureImapPassword', 'SecureImapPassword' cannot be null." + } + + if ($ImapServerHost -eq $null) { + throw "invalid value for 'ImapServerHost', 'ImapServerHost' cannot be null." + } + + if ($ImapServerPort -eq $null) { + throw "invalid value for 'ImapServerPort', 'ImapServerPort' cannot be null." + } + + if ($ImapUsername -eq $null) { + throw "invalid value for 'ImapUsername', 'ImapUsername' cannot be null." + } + + if ($ImapPassword -eq $null) { + throw "invalid value for 'ImapPassword', 'ImapPassword' cannot be null." + } + + if ($ImapMailbox -eq $null) { + throw "invalid value for 'ImapMailbox', 'ImapMailbox' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "secureSmtpServerHost" = ${SecureSmtpServerHost} + "secureSmtpServerPort" = ${SecureSmtpServerPort} + "secureSmtpUsername" = ${SecureSmtpUsername} + "secureSmtpPassword" = ${SecureSmtpPassword} + "smtpServerHost" = ${SmtpServerHost} + "smtpServerPort" = ${SmtpServerPort} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + "secureImapServerHost" = ${SecureImapServerHost} + "secureImapServerPort" = ${SecureImapServerPort} + "secureImapUsername" = ${SecureImapUsername} + "secureImapPassword" = ${SecureImapPassword} + "imapServerHost" = ${ImapServerHost} + "imapServerPort" = ${ImapServerPort} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "imapMailbox" = ${ImapMailbox} + "mailFromDomain" = ${MailFromDomain} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapSmtpAccessDetails + +.DESCRIPTION + +Convert from JSON to ImapSmtpAccessDetails + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapSmtpAccessDetails +#> +function ConvertFrom-JsonToImapSmtpAccessDetails { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapSmtpAccessDetails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapSmtpAccessDetails + $AllProperties = ("secureSmtpServerHost", "secureSmtpServerPort", "secureSmtpUsername", "secureSmtpPassword", "smtpServerHost", "smtpServerPort", "smtpUsername", "smtpPassword", "secureImapServerHost", "secureImapServerPort", "secureImapUsername", "secureImapPassword", "imapServerHost", "imapServerPort", "imapUsername", "imapPassword", "imapMailbox", "mailFromDomain") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'secureSmtpServerHost' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpServerHost' missing." + } else { + $SecureSmtpServerHost = $JsonParameters.PSobject.Properties["secureSmtpServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpServerPort' missing." + } else { + $SecureSmtpServerPort = $JsonParameters.PSobject.Properties["secureSmtpServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpUsername' missing." + } else { + $SecureSmtpUsername = $JsonParameters.PSobject.Properties["secureSmtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpPassword' missing." + } else { + $SecureSmtpPassword = $JsonParameters.PSobject.Properties["secureSmtpPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpServerHost' missing." + } else { + $SmtpServerHost = $JsonParameters.PSobject.Properties["smtpServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpServerPort' missing." + } else { + $SmtpServerPort = $JsonParameters.PSobject.Properties["smtpServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpUsername' missing." + } else { + $SmtpUsername = $JsonParameters.PSobject.Properties["smtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpPassword' missing." + } else { + $SmtpPassword = $JsonParameters.PSobject.Properties["smtpPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapServerHost' missing." + } else { + $SecureImapServerHost = $JsonParameters.PSobject.Properties["secureImapServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapServerPort' missing." + } else { + $SecureImapServerPort = $JsonParameters.PSobject.Properties["secureImapServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapUsername' missing." + } else { + $SecureImapUsername = $JsonParameters.PSobject.Properties["secureImapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapPassword' missing." + } else { + $SecureImapPassword = $JsonParameters.PSobject.Properties["secureImapPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapServerHost' missing." + } else { + $ImapServerHost = $JsonParameters.PSobject.Properties["imapServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapServerPort' missing." + } else { + $ImapServerPort = $JsonParameters.PSobject.Properties["imapServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapUsername' missing." + } else { + $ImapUsername = $JsonParameters.PSobject.Properties["imapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapPassword' missing." + } else { + $ImapPassword = $JsonParameters.PSobject.Properties["imapPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapMailbox"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapMailbox' missing." + } else { + $ImapMailbox = $JsonParameters.PSobject.Properties["imapMailbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mailFromDomain"))) { #optional property not found + $MailFromDomain = $null + } else { + $MailFromDomain = $JsonParameters.PSobject.Properties["mailFromDomain"].value + } + + $PSO = [PSCustomObject]@{ + "secureSmtpServerHost" = ${SecureSmtpServerHost} + "secureSmtpServerPort" = ${SecureSmtpServerPort} + "secureSmtpUsername" = ${SecureSmtpUsername} + "secureSmtpPassword" = ${SecureSmtpPassword} + "smtpServerHost" = ${SmtpServerHost} + "smtpServerPort" = ${SmtpServerPort} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + "secureImapServerHost" = ${SecureImapServerHost} + "secureImapServerPort" = ${SecureImapServerPort} + "secureImapUsername" = ${SecureImapUsername} + "secureImapPassword" = ${SecureImapPassword} + "imapServerHost" = ${ImapServerHost} + "imapServerPort" = ${ImapServerPort} + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + "imapMailbox" = ${ImapMailbox} + "mailFromDomain" = ${MailFromDomain} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapSmtpAccessServers.ps1 b/src/maislurp-client-powershell/Model/ImapSmtpAccessServers.ps1 new file mode 100644 index 00000000..353bd9c2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapSmtpAccessServers.ps1 @@ -0,0 +1,157 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +IMAP and SMTP server endpoints for MailSlurp + +.PARAMETER ImapServer +No description available. +.PARAMETER SecureImapServer +No description available. +.PARAMETER SmtpServer +No description available. +.PARAMETER SecureSmtpServer +No description available. +.OUTPUTS + +ImapSmtpAccessServers +#> + +function Initialize-ImapSmtpAccessServers { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${ImapServer}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${SecureImapServer}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${SmtpServer}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${SecureSmtpServer} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapSmtpAccessServers' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ImapServer -eq $null) { + throw "invalid value for 'ImapServer', 'ImapServer' cannot be null." + } + + if ($SecureImapServer -eq $null) { + throw "invalid value for 'SecureImapServer', 'SecureImapServer' cannot be null." + } + + if ($SmtpServer -eq $null) { + throw "invalid value for 'SmtpServer', 'SmtpServer' cannot be null." + } + + if ($SecureSmtpServer -eq $null) { + throw "invalid value for 'SecureSmtpServer', 'SecureSmtpServer' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "imapServer" = ${ImapServer} + "secureImapServer" = ${SecureImapServer} + "smtpServer" = ${SmtpServer} + "secureSmtpServer" = ${SecureSmtpServer} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapSmtpAccessServers + +.DESCRIPTION + +Convert from JSON to ImapSmtpAccessServers + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapSmtpAccessServers +#> +function ConvertFrom-JsonToImapSmtpAccessServers { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapSmtpAccessServers' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapSmtpAccessServers + $AllProperties = ("imapServer", "secureImapServer", "smtpServer", "secureSmtpServer") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'imapServer' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapServer"))) { + throw "Error! JSON cannot be serialized due to the required property 'imapServer' missing." + } else { + $ImapServer = $JsonParameters.PSobject.Properties["imapServer"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureImapServer"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureImapServer' missing." + } else { + $SecureImapServer = $JsonParameters.PSobject.Properties["secureImapServer"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpServer"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpServer' missing." + } else { + $SmtpServer = $JsonParameters.PSobject.Properties["smtpServer"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpServer"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpServer' missing." + } else { + $SecureSmtpServer = $JsonParameters.PSobject.Properties["secureSmtpServer"].value + } + + $PSO = [PSCustomObject]@{ + "imapServer" = ${ImapServer} + "secureImapServer" = ${SecureImapServer} + "smtpServer" = ${SmtpServer} + "secureSmtpServer" = ${SecureSmtpServer} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ImapUpdateFlagsOptions.ps1 b/src/maislurp-client-powershell/Model/ImapUpdateFlagsOptions.ps1 new file mode 100644 index 00000000..8f9e43fb --- /dev/null +++ b/src/maislurp-client-powershell/Model/ImapUpdateFlagsOptions.ps1 @@ -0,0 +1,145 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Operation +No description available. +.PARAMETER Flags +No description available. +.PARAMETER UidSet +No description available. +.PARAMETER SeqSet +No description available. +.OUTPUTS + +ImapUpdateFlagsOptions +#> + +function Initialize-ImapUpdateFlagsOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Operation}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Flags}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${UidSet}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${SeqSet} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ImapUpdateFlagsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Operation -eq $null) { + throw "invalid value for 'Operation', 'Operation' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "operation" = ${Operation} + "flags" = ${Flags} + "uidSet" = ${UidSet} + "seqSet" = ${SeqSet} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ImapUpdateFlagsOptions + +.DESCRIPTION + +Convert from JSON to ImapUpdateFlagsOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ImapUpdateFlagsOptions +#> +function ConvertFrom-JsonToImapUpdateFlagsOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ImapUpdateFlagsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ImapUpdateFlagsOptions + $AllProperties = ("operation", "flags", "uidSet", "seqSet") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'operation' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "operation"))) { + throw "Error! JSON cannot be serialized due to the required property 'operation' missing." + } else { + $Operation = $JsonParameters.PSobject.Properties["operation"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "flags"))) { #optional property not found + $Flags = $null + } else { + $Flags = $JsonParameters.PSobject.Properties["flags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "uidSet"))) { #optional property not found + $UidSet = $null + } else { + $UidSet = $JsonParameters.PSobject.Properties["uidSet"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seqSet"))) { #optional property not found + $SeqSet = $null + } else { + $SeqSet = $JsonParameters.PSobject.Properties["seqSet"].value + } + + $PSO = [PSCustomObject]@{ + "operation" = ${Operation} + "flags" = ${Flags} + "uidSet" = ${UidSet} + "seqSet" = ${SeqSet} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxByEmailAddressResult.ps1 b/src/maislurp-client-powershell/Model/InboxByEmailAddressResult.ps1 new file mode 100644 index 00000000..6359e8da --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxByEmailAddressResult.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of search for inbox by email address + +.PARAMETER InboxId +No description available. +.PARAMETER Exists +No description available. +.OUTPUTS + +InboxByEmailAddressResult +#> + +function Initialize-InboxByEmailAddressResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Exists} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxByEmailAddressResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Exists -eq $null) { + throw "invalid value for 'Exists', 'Exists' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "exists" = ${Exists} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxByEmailAddressResult + +.DESCRIPTION + +Convert from JSON to InboxByEmailAddressResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxByEmailAddressResult +#> +function ConvertFrom-JsonToInboxByEmailAddressResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxByEmailAddressResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxByEmailAddressResult + $AllProperties = ("inboxId", "exists") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'exists' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "exists"))) { + throw "Error! JSON cannot be serialized due to the required property 'exists' missing." + } else { + $Exists = $JsonParameters.PSobject.Properties["exists"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "exists" = ${Exists} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxByNameResult.ps1 b/src/maislurp-client-powershell/Model/InboxByNameResult.ps1 new file mode 100644 index 00000000..65b35b55 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxByNameResult.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of search for inbox by name + +.PARAMETER InboxId +No description available. +.PARAMETER Exists +No description available. +.OUTPUTS + +InboxByNameResult +#> + +function Initialize-InboxByNameResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Exists} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxByNameResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Exists -eq $null) { + throw "invalid value for 'Exists', 'Exists' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "exists" = ${Exists} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxByNameResult + +.DESCRIPTION + +Convert from JSON to InboxByNameResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxByNameResult +#> +function ConvertFrom-JsonToInboxByNameResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxByNameResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxByNameResult + $AllProperties = ("inboxId", "exists") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'exists' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "exists"))) { + throw "Error! JSON cannot be serialized due to the required property 'exists' missing." + } else { + $Exists = $JsonParameters.PSobject.Properties["exists"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "exists" = ${Exists} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxDto.ps1 b/src/maislurp-client-powershell/Model/InboxDto.ps1 new file mode 100644 index 00000000..8d7d25ce --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxDto.ps1 @@ -0,0 +1,297 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. `SMTP` inboxes use a custom mail server at `mxslurp.click` and support SMTP login, IMAP and POP3. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching. + +.PARAMETER Id +ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. +.PARAMETER UserId +ID of user that inbox belongs to +.PARAMETER CreatedAt +When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. +.PARAMETER Name +Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search +.PARAMETER DomainId +ID of custom domain used by the inbox if any +.PARAMETER Description +Description of an inbox for labelling and searching purposes +.PARAMETER EmailAddress +The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. +.PARAMETER ExpiresAt +Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. +.PARAMETER Favourite +Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering +.PARAMETER Tags +Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. +.PARAMETER InboxType +Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). +.PARAMETER ReadOnly +Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes. +.PARAMETER VirtualInbox +Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. +.PARAMETER FunctionsAs +Inbox function if used as a primitive for another system. +.OUTPUTS + +InboxDto +#> + +function Initialize-InboxDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${ExpiresAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Favourite}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${ReadOnly}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${VirtualInbox}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR")] + [String] + ${FunctionsAs} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($Favourite -eq $null) { + throw "invalid value for 'Favourite', 'Favourite' cannot be null." + } + + if ($ReadOnly -eq $null) { + throw "invalid value for 'ReadOnly', 'ReadOnly' cannot be null." + } + + if ($VirtualInbox -eq $null) { + throw "invalid value for 'VirtualInbox', 'VirtualInbox' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "domainId" = ${DomainId} + "description" = ${Description} + "emailAddress" = ${EmailAddress} + "expiresAt" = ${ExpiresAt} + "favourite" = ${Favourite} + "tags" = ${Tags} + "inboxType" = ${InboxType} + "readOnly" = ${ReadOnly} + "virtualInbox" = ${VirtualInbox} + "functionsAs" = ${FunctionsAs} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxDto + +.DESCRIPTION + +Convert from JSON to InboxDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxDto +#> +function ConvertFrom-JsonToInboxDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxDto + $AllProperties = ("id", "userId", "createdAt", "name", "domainId", "description", "emailAddress", "expiresAt", "favourite", "tags", "inboxType", "readOnly", "virtualInbox", "functionsAs") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "favourite"))) { + throw "Error! JSON cannot be serialized due to the required property 'favourite' missing." + } else { + $Favourite = $JsonParameters.PSobject.Properties["favourite"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "readOnly"))) { + throw "Error! JSON cannot be serialized due to the required property 'readOnly' missing." + } else { + $ReadOnly = $JsonParameters.PSobject.Properties["readOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virtualInbox"))) { + throw "Error! JSON cannot be serialized due to the required property 'virtualInbox' missing." + } else { + $VirtualInbox = $JsonParameters.PSobject.Properties["virtualInbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "expiresAt"))) { #optional property not found + $ExpiresAt = $null + } else { + $ExpiresAt = $JsonParameters.PSobject.Properties["expiresAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { #optional property not found + $Tags = $null + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxType"))) { #optional property not found + $InboxType = $null + } else { + $InboxType = $JsonParameters.PSobject.Properties["inboxType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "functionsAs"))) { #optional property not found + $FunctionsAs = $null + } else { + $FunctionsAs = $JsonParameters.PSobject.Properties["functionsAs"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "domainId" = ${DomainId} + "description" = ${Description} + "emailAddress" = ${EmailAddress} + "expiresAt" = ${ExpiresAt} + "favourite" = ${Favourite} + "tags" = ${Tags} + "inboxType" = ${InboxType} + "readOnly" = ${ReadOnly} + "virtualInbox" = ${VirtualInbox} + "functionsAs" = ${FunctionsAs} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxExistsDto.ps1 b/src/maislurp-client-powershell/Model/InboxExistsDto.ps1 new file mode 100644 index 00000000..21eee03a --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxExistsDto.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of email exists query + +.PARAMETER Exists +No description available. +.OUTPUTS + +InboxExistsDto +#> + +function Initialize-InboxExistsDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Exists} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxExistsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Exists -eq $null) { + throw "invalid value for 'Exists', 'Exists' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "exists" = ${Exists} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxExistsDto + +.DESCRIPTION + +Convert from JSON to InboxExistsDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxExistsDto +#> +function ConvertFrom-JsonToInboxExistsDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxExistsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxExistsDto + $AllProperties = ("exists") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'exists' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "exists"))) { + throw "Error! JSON cannot be serialized due to the required property 'exists' missing." + } else { + $Exists = $JsonParameters.PSobject.Properties["exists"].value + } + + $PSO = [PSCustomObject]@{ + "exists" = ${Exists} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxForwarderDto.ps1 b/src/maislurp-client-powershell/Model/InboxForwarderDto.ps1 new file mode 100644 index 00000000..ae97f1df --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxForwarderDto.ps1 @@ -0,0 +1,205 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox forwarder. Describes how an inbox will forward matching emails to designated recipients. + +.PARAMETER Id +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER Name +Name of inbox forwarder +.PARAMETER Field +Which field to match against +.PARAMETER Match +Wild-card type pattern to apply to field +.PARAMETER ForwardToRecipients +Who to send forwarded email to +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +InboxForwarderDto +#> + +function Initialize-InboxForwarderDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS")] + [String] + ${Field}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Match}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ForwardToRecipients}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxForwarderDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Match -eq $null) { + throw "invalid value for 'Match', 'Match' cannot be null." + } + + if ($ForwardToRecipients -eq $null) { + throw "invalid value for 'ForwardToRecipients', 'ForwardToRecipients' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "forwardToRecipients" = ${ForwardToRecipients} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxForwarderDto + +.DESCRIPTION + +Convert from JSON to InboxForwarderDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxForwarderDto +#> +function ConvertFrom-JsonToInboxForwarderDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxForwarderDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxForwarderDto + $AllProperties = ("id", "inboxId", "name", "field", "match", "forwardToRecipients", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "match"))) { + throw "Error! JSON cannot be serialized due to the required property 'match' missing." + } else { + $Match = $JsonParameters.PSobject.Properties["match"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "forwardToRecipients"))) { + throw "Error! JSON cannot be serialized due to the required property 'forwardToRecipients' missing." + } else { + $ForwardToRecipients = $JsonParameters.PSobject.Properties["forwardToRecipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "forwardToRecipients" = ${ForwardToRecipients} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxForwarderEventDto.ps1 b/src/maislurp-client-powershell/Model/InboxForwarderEventDto.ps1 new file mode 100644 index 00000000..cf8c2ac0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxForwarderEventDto.ps1 @@ -0,0 +1,198 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox forwarder event. Describes how an email was handled by an inbox forwarder. + +.PARAMETER Id +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER EmailId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER ForwarderId +No description available. +.PARAMETER Message +No description available. +.PARAMETER Status +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +InboxForwarderEventDto +#> + +function Initialize-InboxForwarderEventDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ForwarderId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUCCESS", "FAILURE")] + [String] + ${Status}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxForwarderEventDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "emailId" = ${EmailId} + "userId" = ${UserId} + "forwarderId" = ${ForwarderId} + "message" = ${Message} + "status" = ${Status} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxForwarderEventDto + +.DESCRIPTION + +Convert from JSON to InboxForwarderEventDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxForwarderEventDto +#> +function ConvertFrom-JsonToInboxForwarderEventDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxForwarderEventDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxForwarderEventDto + $AllProperties = ("id", "inboxId", "emailId", "userId", "forwarderId", "message", "status", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { #optional property not found + $EmailId = $null + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "forwarderId"))) { #optional property not found + $ForwarderId = $null + } else { + $ForwarderId = $JsonParameters.PSobject.Properties["forwarderId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { #optional property not found + $Status = $null + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "emailId" = ${EmailId} + "userId" = ${UserId} + "forwarderId" = ${ForwarderId} + "message" = ${Message} + "status" = ${Status} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxForwarderEventProjection.ps1 b/src/maislurp-client-powershell/Model/InboxForwarderEventProjection.ps1 new file mode 100644 index 00000000..b634449d --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxForwarderEventProjection.ps1 @@ -0,0 +1,198 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox forwarder event + +.PARAMETER EmailId +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER ForwarderId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Message +No description available. +.PARAMETER Id +No description available. +.PARAMETER Status +No description available. +.OUTPUTS + +InboxForwarderEventProjection +#> + +function Initialize-InboxForwarderEventProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${ForwarderId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUCCESS", "FAILURE")] + [String] + ${Status} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxForwarderEventProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailId" = ${EmailId} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "forwarderId" = ${ForwarderId} + "createdAt" = ${CreatedAt} + "message" = ${Message} + "id" = ${Id} + "status" = ${Status} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxForwarderEventProjection + +.DESCRIPTION + +Convert from JSON to InboxForwarderEventProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxForwarderEventProjection +#> +function ConvertFrom-JsonToInboxForwarderEventProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxForwarderEventProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxForwarderEventProjection + $AllProperties = ("emailId", "inboxId", "userId", "forwarderId", "createdAt", "message", "id", "status") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { #optional property not found + $EmailId = $null + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "forwarderId"))) { #optional property not found + $ForwarderId = $null + } else { + $ForwarderId = $JsonParameters.PSobject.Properties["forwarderId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { #optional property not found + $Status = $null + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + $PSO = [PSCustomObject]@{ + "emailId" = ${EmailId} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "forwarderId" = ${ForwarderId} + "createdAt" = ${CreatedAt} + "message" = ${Message} + "id" = ${Id} + "status" = ${Status} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxForwarderTestOptions.ps1 b/src/maislurp-client-powershell/Model/InboxForwarderTestOptions.ps1 new file mode 100644 index 00000000..d4807e17 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxForwarderTestOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for testing an inbox forwarder against a value + +.PARAMETER TestValue +No description available. +.OUTPUTS + +InboxForwarderTestOptions +#> + +function Initialize-InboxForwarderTestOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${TestValue} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxForwarderTestOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TestValue -eq $null) { + throw "invalid value for 'TestValue', 'TestValue' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "testValue" = ${TestValue} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxForwarderTestOptions + +.DESCRIPTION + +Convert from JSON to InboxForwarderTestOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxForwarderTestOptions +#> +function ConvertFrom-JsonToInboxForwarderTestOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxForwarderTestOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxForwarderTestOptions + $AllProperties = ("testValue") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'testValue' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "testValue"))) { + throw "Error! JSON cannot be serialized due to the required property 'testValue' missing." + } else { + $TestValue = $JsonParameters.PSobject.Properties["testValue"].value + } + + $PSO = [PSCustomObject]@{ + "testValue" = ${TestValue} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxForwarderTestResult.ps1 b/src/maislurp-client-powershell/Model/InboxForwarderTestResult.ps1 new file mode 100644 index 00000000..60297ba4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxForwarderTestResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Results of inbox forwarder test + +.PARAMETER VarMatches +No description available. +.PARAMETER DoesMatch +No description available. +.OUTPUTS + +InboxForwarderTestResult +#> + +function Initialize-InboxForwarderTestResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${VarMatches}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${DoesMatch} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxForwarderTestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarMatches -eq $null) { + throw "invalid value for 'VarMatches', 'VarMatches' cannot be null." + } + + if ($DoesMatch -eq $null) { + throw "invalid value for 'DoesMatch', 'DoesMatch' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "matches" = ${VarMatches} + "doesMatch" = ${DoesMatch} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxForwarderTestResult + +.DESCRIPTION + +Convert from JSON to InboxForwarderTestResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxForwarderTestResult +#> +function ConvertFrom-JsonToInboxForwarderTestResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxForwarderTestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxForwarderTestResult + $AllProperties = ("matches", "doesMatch") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'matches' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "matches"))) { + throw "Error! JSON cannot be serialized due to the required property 'matches' missing." + } else { + $VarMatches = $JsonParameters.PSobject.Properties["matches"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "doesMatch"))) { + throw "Error! JSON cannot be serialized due to the required property 'doesMatch' missing." + } else { + $DoesMatch = $JsonParameters.PSobject.Properties["doesMatch"].value + } + + $PSO = [PSCustomObject]@{ + "matches" = ${VarMatches} + "doesMatch" = ${DoesMatch} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxIdItem.ps1 b/src/maislurp-client-powershell/Model/InboxIdItem.ps1 new file mode 100644 index 00000000..a46de2ae --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxIdItem.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox ID and email address pair + +.PARAMETER Id +No description available. +.PARAMETER EmailAddress +No description available. +.OUTPUTS + +InboxIdItem +#> + +function Initialize-InboxIdItem { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxIdItem' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxIdItem + +.DESCRIPTION + +Convert from JSON to InboxIdItem + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxIdItem +#> +function ConvertFrom-JsonToInboxIdItem { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxIdItem' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxIdItem + $AllProperties = ("id", "emailAddress") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxIdsResult.ps1 b/src/maislurp-client-powershell/Model/InboxIdsResult.ps1 new file mode 100644 index 00000000..0a8fa3f3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxIdsResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +List of inbox IDs and email addresses + +.PARAMETER InboxIds +No description available. +.OUTPUTS + +InboxIdsResult +#> + +function Initialize-InboxIdsResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${InboxIds} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxIdsResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxIds -eq $null) { + throw "invalid value for 'InboxIds', 'InboxIds' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxIdsResult + +.DESCRIPTION + +Convert from JSON to InboxIdsResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxIdsResult +#> +function ConvertFrom-JsonToInboxIdsResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxIdsResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxIdsResult + $AllProperties = ("inboxIds") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxIds' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxIds"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxIds' missing." + } else { + $InboxIds = $JsonParameters.PSobject.Properties["inboxIds"].value + } + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxPreview.ps1 b/src/maislurp-client-powershell/Model/InboxPreview.ps1 new file mode 100644 index 00000000..a544c40f --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxPreview.ps1 @@ -0,0 +1,267 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox data preview element. + +.PARAMETER Id +ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. +.PARAMETER DomainId +ID of custom domain used by the inbox if any +.PARAMETER EmailAddress +The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. +.PARAMETER CreatedAt +When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. +.PARAMETER Favourite +Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering +.PARAMETER Name +Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search +.PARAMETER Tags +Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. +.PARAMETER TeamAccess +Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/ +.PARAMETER InboxType +Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). +.PARAMETER VirtualInbox +Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. +.PARAMETER ExpiresAt +Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. +.PARAMETER FunctionsAs +Inbox function if used as a primitive for another system. +.OUTPUTS + +InboxPreview +#> + +function Initialize-InboxPreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Favourite}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${TeamAccess}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${VirtualInbox}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${ExpiresAt}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR")] + [String] + ${FunctionsAs} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Favourite -eq $null) { + throw "invalid value for 'Favourite', 'Favourite' cannot be null." + } + + if ($TeamAccess -eq $null) { + throw "invalid value for 'TeamAccess', 'TeamAccess' cannot be null." + } + + if ($VirtualInbox -eq $null) { + throw "invalid value for 'VirtualInbox', 'VirtualInbox' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domainId" = ${DomainId} + "emailAddress" = ${EmailAddress} + "createdAt" = ${CreatedAt} + "favourite" = ${Favourite} + "name" = ${Name} + "tags" = ${Tags} + "teamAccess" = ${TeamAccess} + "inboxType" = ${InboxType} + "virtualInbox" = ${VirtualInbox} + "expiresAt" = ${ExpiresAt} + "functionsAs" = ${FunctionsAs} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxPreview + +.DESCRIPTION + +Convert from JSON to InboxPreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxPreview +#> +function ConvertFrom-JsonToInboxPreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxPreview + $AllProperties = ("id", "domainId", "emailAddress", "createdAt", "favourite", "name", "tags", "teamAccess", "inboxType", "virtualInbox", "expiresAt", "functionsAs") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "favourite"))) { + throw "Error! JSON cannot be serialized due to the required property 'favourite' missing." + } else { + $Favourite = $JsonParameters.PSobject.Properties["favourite"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "teamAccess"))) { + throw "Error! JSON cannot be serialized due to the required property 'teamAccess' missing." + } else { + $TeamAccess = $JsonParameters.PSobject.Properties["teamAccess"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virtualInbox"))) { + throw "Error! JSON cannot be serialized due to the required property 'virtualInbox' missing." + } else { + $VirtualInbox = $JsonParameters.PSobject.Properties["virtualInbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { #optional property not found + $EmailAddress = $null + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { #optional property not found + $Tags = $null + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxType"))) { #optional property not found + $InboxType = $null + } else { + $InboxType = $JsonParameters.PSobject.Properties["inboxType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "expiresAt"))) { #optional property not found + $ExpiresAt = $null + } else { + $ExpiresAt = $JsonParameters.PSobject.Properties["expiresAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "functionsAs"))) { #optional property not found + $FunctionsAs = $null + } else { + $FunctionsAs = $JsonParameters.PSobject.Properties["functionsAs"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domainId" = ${DomainId} + "emailAddress" = ${EmailAddress} + "createdAt" = ${CreatedAt} + "favourite" = ${Favourite} + "name" = ${Name} + "tags" = ${Tags} + "teamAccess" = ${TeamAccess} + "inboxType" = ${InboxType} + "virtualInbox" = ${VirtualInbox} + "expiresAt" = ${ExpiresAt} + "functionsAs" = ${FunctionsAs} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxReplierDto.ps1 b/src/maislurp-client-powershell/Model/InboxReplierDto.ps1 new file mode 100644 index 00000000..58b1f529 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxReplierDto.ps1 @@ -0,0 +1,300 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox replier. Will automatically reply to inbound emails that match given field for an inbox. + +.PARAMETER Id +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER Name +No description available. +.PARAMETER Field +No description available. +.PARAMETER Match +No description available. +.PARAMETER ReplyTo +No description available. +.PARAMETER Subject +No description available. +.PARAMETER VarFrom +No description available. +.PARAMETER Charset +No description available. +.PARAMETER IsHTML +No description available. +.PARAMETER TemplateId +No description available. +.PARAMETER TemplateVariables +No description available. +.PARAMETER IgnoreReplyTo +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +InboxReplierDto +#> + +function Initialize-InboxReplierDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS")] + [String] + ${Field}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Match}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsHTML}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${TemplateId}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IgnoreReplyTo}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxReplierDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Match -eq $null) { + throw "invalid value for 'Match', 'Match' cannot be null." + } + + if ($IsHTML -eq $null) { + throw "invalid value for 'IsHTML', 'IsHTML' cannot be null." + } + + if ($IgnoreReplyTo -eq $null) { + throw "invalid value for 'IgnoreReplyTo', 'IgnoreReplyTo' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "replyTo" = ${ReplyTo} + "subject" = ${Subject} + "from" = ${VarFrom} + "charset" = ${Charset} + "isHTML" = ${IsHTML} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + "ignoreReplyTo" = ${IgnoreReplyTo} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxReplierDto + +.DESCRIPTION + +Convert from JSON to InboxReplierDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxReplierDto +#> +function ConvertFrom-JsonToInboxReplierDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxReplierDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxReplierDto + $AllProperties = ("id", "inboxId", "name", "field", "match", "replyTo", "subject", "from", "charset", "isHTML", "templateId", "templateVariables", "ignoreReplyTo", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "match"))) { + throw "Error! JSON cannot be serialized due to the required property 'match' missing." + } else { + $Match = $JsonParameters.PSobject.Properties["match"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { + throw "Error! JSON cannot be serialized due to the required property 'isHTML' missing." + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreReplyTo"))) { + throw "Error! JSON cannot be serialized due to the required property 'ignoreReplyTo' missing." + } else { + $IgnoreReplyTo = $JsonParameters.PSobject.Properties["ignoreReplyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateId"))) { #optional property not found + $TemplateId = $null + } else { + $TemplateId = $JsonParameters.PSobject.Properties["templateId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "replyTo" = ${ReplyTo} + "subject" = ${Subject} + "from" = ${VarFrom} + "charset" = ${Charset} + "isHTML" = ${IsHTML} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + "ignoreReplyTo" = ${IgnoreReplyTo} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxReplierEventProjection.ps1 b/src/maislurp-client-powershell/Model/InboxReplierEventProjection.ps1 new file mode 100644 index 00000000..bd0331a2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxReplierEventProjection.ps1 @@ -0,0 +1,224 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Inbox replier event + +.PARAMETER Recipients +No description available. +.PARAMETER EmailId +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER SentId +No description available. +.PARAMETER ReplierId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Message +No description available. +.PARAMETER Id +No description available. +.PARAMETER Status +No description available. +.OUTPUTS + +InboxReplierEventProjection +#> + +function Initialize-InboxReplierEventProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Recipients}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplierId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUCCESS", "FAILURE")] + [String] + ${Status} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxReplierEventProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "recipients" = ${Recipients} + "emailId" = ${EmailId} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "sentId" = ${SentId} + "replierId" = ${ReplierId} + "createdAt" = ${CreatedAt} + "message" = ${Message} + "id" = ${Id} + "status" = ${Status} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxReplierEventProjection + +.DESCRIPTION + +Convert from JSON to InboxReplierEventProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxReplierEventProjection +#> +function ConvertFrom-JsonToInboxReplierEventProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxReplierEventProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxReplierEventProjection + $AllProperties = ("recipients", "emailId", "inboxId", "userId", "sentId", "replierId", "createdAt", "message", "id", "status") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipients"))) { #optional property not found + $Recipients = $null + } else { + $Recipients = $JsonParameters.PSobject.Properties["recipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { #optional property not found + $EmailId = $null + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentId"))) { #optional property not found + $SentId = $null + } else { + $SentId = $JsonParameters.PSobject.Properties["sentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replierId"))) { #optional property not found + $ReplierId = $null + } else { + $ReplierId = $JsonParameters.PSobject.Properties["replierId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { #optional property not found + $Status = $null + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + $PSO = [PSCustomObject]@{ + "recipients" = ${Recipients} + "emailId" = ${EmailId} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "sentId" = ${SentId} + "replierId" = ${ReplierId} + "createdAt" = ${CreatedAt} + "message" = ${Message} + "id" = ${Id} + "status" = ${Status} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxRulesetDto.ps1 b/src/maislurp-client-powershell/Model/InboxRulesetDto.ps1 new file mode 100644 index 00000000..a840c284 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxRulesetDto.ps1 @@ -0,0 +1,207 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Rules for inbox + +.PARAMETER Id +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER Scope +No description available. +.PARAMETER Action +No description available. +.PARAMETER Target +No description available. +.PARAMETER Handler +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +InboxRulesetDto +#> + +function Initialize-InboxRulesetDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECEIVING_EMAILS", "SENDING_EMAILS")] + [String] + ${Scope}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("BLOCK", "ALLOW", "FILTER_REMOVE")] + [String] + ${Action}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Target}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EXCEPTION")] + [String] + ${Handler}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxRulesetDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Scope -eq $null) { + throw "invalid value for 'Scope', 'Scope' cannot be null." + } + + if ($Action -eq $null) { + throw "invalid value for 'Action', 'Action' cannot be null." + } + + if ($Target -eq $null) { + throw "invalid value for 'Target', 'Target' cannot be null." + } + + if ($Handler -eq $null) { + throw "invalid value for 'Handler', 'Handler' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "scope" = ${Scope} + "action" = ${Action} + "target" = ${Target} + "handler" = ${Handler} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxRulesetDto + +.DESCRIPTION + +Convert from JSON to InboxRulesetDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxRulesetDto +#> +function ConvertFrom-JsonToInboxRulesetDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxRulesetDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxRulesetDto + $AllProperties = ("id", "inboxId", "scope", "action", "target", "handler", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "scope"))) { + throw "Error! JSON cannot be serialized due to the required property 'scope' missing." + } else { + $Scope = $JsonParameters.PSobject.Properties["scope"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "action"))) { + throw "Error! JSON cannot be serialized due to the required property 'action' missing." + } else { + $Action = $JsonParameters.PSobject.Properties["action"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "target"))) { + throw "Error! JSON cannot be serialized due to the required property 'target' missing." + } else { + $Target = $JsonParameters.PSobject.Properties["target"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "handler"))) { + throw "Error! JSON cannot be serialized due to the required property 'handler' missing." + } else { + $Handler = $JsonParameters.PSobject.Properties["handler"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "inboxId" = ${InboxId} + "scope" = ${Scope} + "action" = ${Action} + "target" = ${Target} + "handler" = ${Handler} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxRulesetTestOptions.ps1 b/src/maislurp-client-powershell/Model/InboxRulesetTestOptions.ps1 new file mode 100644 index 00000000..8760a787 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxRulesetTestOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Test options for inbox ruleset + +.PARAMETER TestTarget +No description available. +.OUTPUTS + +InboxRulesetTestOptions +#> + +function Initialize-InboxRulesetTestOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${TestTarget} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxRulesetTestOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TestTarget -eq $null) { + throw "invalid value for 'TestTarget', 'TestTarget' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "testTarget" = ${TestTarget} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxRulesetTestOptions + +.DESCRIPTION + +Convert from JSON to InboxRulesetTestOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxRulesetTestOptions +#> +function ConvertFrom-JsonToInboxRulesetTestOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxRulesetTestOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxRulesetTestOptions + $AllProperties = ("testTarget") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'testTarget' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "testTarget"))) { + throw "Error! JSON cannot be serialized due to the required property 'testTarget' missing." + } else { + $TestTarget = $JsonParameters.PSobject.Properties["testTarget"].value + } + + $PSO = [PSCustomObject]@{ + "testTarget" = ${TestTarget} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InboxRulesetTestResult.ps1 b/src/maislurp-client-powershell/Model/InboxRulesetTestResult.ps1 new file mode 100644 index 00000000..f17e6371 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InboxRulesetTestResult.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of test of inbox ruleset + +.PARAMETER RulesetMatches +Map of inbox ruleset ID to boolean of if target matches +.PARAMETER VarMatches +No description available. +.OUTPUTS + +InboxRulesetTestResult +#> + +function Initialize-InboxRulesetTestResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${RulesetMatches}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${VarMatches} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InboxRulesetTestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($RulesetMatches -eq $null) { + throw "invalid value for 'RulesetMatches', 'RulesetMatches' cannot be null." + } + + if ($VarMatches -eq $null) { + throw "invalid value for 'VarMatches', 'VarMatches' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "rulesetMatches" = ${RulesetMatches} + "matches" = ${VarMatches} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InboxRulesetTestResult + +.DESCRIPTION + +Convert from JSON to InboxRulesetTestResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +InboxRulesetTestResult +#> +function ConvertFrom-JsonToInboxRulesetTestResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InboxRulesetTestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InboxRulesetTestResult + $AllProperties = ("rulesetMatches", "matches") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'rulesetMatches' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rulesetMatches"))) { + throw "Error! JSON cannot be serialized due to the required property 'rulesetMatches' missing." + } else { + $RulesetMatches = $JsonParameters.PSobject.Properties["rulesetMatches"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "matches"))) { + throw "Error! JSON cannot be serialized due to the required property 'matches' missing." + } else { + $VarMatches = $JsonParameters.PSobject.Properties["matches"].value + } + + $PSO = [PSCustomObject]@{ + "rulesetMatches" = ${RulesetMatches} + "matches" = ${VarMatches} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/InlineObject.ps1 b/src/maislurp-client-powershell/Model/InlineObject.ps1 new file mode 100644 index 00000000..38d6d582 --- /dev/null +++ b/src/maislurp-client-powershell/Model/InlineObject.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER ContentTypeHeader +Optional content type header of attachment +.PARAMETER File +No description available. +.OUTPUTS + +InlineObject +#> + +function Initialize-InlineObject { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentTypeHeader}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.IO.FileInfo] + ${File} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => InlineObject' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($File -eq $null) { + throw "invalid value for 'File', 'File' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "contentTypeHeader" = ${ContentTypeHeader} + "file" = ${File} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to InlineObject + +.DESCRIPTION + +Convert from JSON to InlineObject + +.PARAMETER Json + +Json object + +.OUTPUTS + +InlineObject +#> +function ConvertFrom-JsonToInlineObject { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => InlineObject' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in InlineObject + $AllProperties = ("contentTypeHeader", "file") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'file' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "file"))) { + throw "Error! JSON cannot be serialized due to the required property 'file' missing." + } else { + $File = $JsonParameters.PSobject.Properties["file"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentTypeHeader"))) { #optional property not found + $ContentTypeHeader = $null + } else { + $ContentTypeHeader = $JsonParameters.PSobject.Properties["contentTypeHeader"].value + } + + $PSO = [PSCustomObject]@{ + "contentTypeHeader" = ${ContentTypeHeader} + "file" = ${File} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/JSONSchemaDto.ps1 b/src/maislurp-client-powershell/Model/JSONSchemaDto.ps1 new file mode 100644 index 00000000..60a37a64 --- /dev/null +++ b/src/maislurp-client-powershell/Model/JSONSchemaDto.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +JSONSchema for payload + +.PARAMETER Value +No description available. +.OUTPUTS + +JSONSchemaDto +#> + +function Initialize-JSONSchemaDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => JSONSchemaDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to JSONSchemaDto + +.DESCRIPTION + +Convert from JSON to JSONSchemaDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +JSONSchemaDto +#> +function ConvertFrom-JsonToJSONSchemaDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => JSONSchemaDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in JSONSchemaDto + $AllProperties = ("value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'value' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LinkIssue.ps1 b/src/maislurp-client-powershell/Model/LinkIssue.ps1 new file mode 100644 index 00000000..17190cf6 --- /dev/null +++ b/src/maislurp-client-powershell/Model/LinkIssue.ps1 @@ -0,0 +1,154 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Url +No description available. +.PARAMETER ResponseStatus +No description available. +.PARAMETER Severity +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +LinkIssue +#> + +function Initialize-LinkIssue { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${ResponseStatus}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("Warning", "Error")] + [String] + ${Severity}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LinkIssue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($Severity -eq $null) { + throw "invalid value for 'Severity', 'Severity' cannot be null." + } + + if ($Message -eq $null) { + throw "invalid value for 'Message', 'Message' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "responseStatus" = ${ResponseStatus} + "severity" = ${Severity} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LinkIssue + +.DESCRIPTION + +Convert from JSON to LinkIssue + +.PARAMETER Json + +Json object + +.OUTPUTS + +LinkIssue +#> +function ConvertFrom-JsonToLinkIssue { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LinkIssue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LinkIssue + $AllProperties = ("url", "responseStatus", "severity", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'url' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "severity"))) { + throw "Error! JSON cannot be serialized due to the required property 'severity' missing." + } else { + $Severity = $JsonParameters.PSobject.Properties["severity"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { + throw "Error! JSON cannot be serialized due to the required property 'message' missing." + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "responseStatus"))) { #optional property not found + $ResponseStatus = $null + } else { + $ResponseStatus = $JsonParameters.PSobject.Properties["responseStatus"].value + } + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "responseStatus" = ${ResponseStatus} + "severity" = ${Severity} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ListUnsubscribeRecipientProjection.ps1 b/src/maislurp-client-powershell/Model/ListUnsubscribeRecipientProjection.ps1 new file mode 100644 index 00000000..e545909c --- /dev/null +++ b/src/maislurp-client-powershell/Model/ListUnsubscribeRecipientProjection.ps1 @@ -0,0 +1,153 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +List unsubscribe recipient + +.PARAMETER EmailAddress +No description available. +.PARAMETER DomainId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +ListUnsubscribeRecipientProjection +#> + +function Initialize-ListUnsubscribeRecipientProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ListUnsubscribeRecipientProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "domainId" = ${DomainId} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ListUnsubscribeRecipientProjection + +.DESCRIPTION + +Convert from JSON to ListUnsubscribeRecipientProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ListUnsubscribeRecipientProjection +#> +function ConvertFrom-JsonToListUnsubscribeRecipientProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ListUnsubscribeRecipientProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ListUnsubscribeRecipientProjection + $AllProperties = ("emailAddress", "domainId", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddress' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + "domainId" = ${DomainId} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupBimiDomainOptions.ps1 b/src/maislurp-client-powershell/Model/LookupBimiDomainOptions.ps1 new file mode 100644 index 00000000..639797ff --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupBimiDomainOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarHost +No description available. +.OUTPUTS + +LookupBimiDomainOptions +#> + +function Initialize-LookupBimiDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupBimiDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupBimiDomainOptions + +.DESCRIPTION + +Convert from JSON to LookupBimiDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupBimiDomainOptions +#> +function ConvertFrom-JsonToLookupBimiDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupBimiDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupBimiDomainOptions + $AllProperties = ("host") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'host' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupBimiDomainResults.ps1 b/src/maislurp-client-powershell/Model/LookupBimiDomainResults.ps1 new file mode 100644 index 00000000..2f48737c --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupBimiDomainResults.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Valid +No description available. +.PARAMETER Query +No description available. +.PARAMETER Records +No description available. +.PARAMETER Errors +No description available. +.PARAMETER Warnings +No description available. +.OUTPUTS + +LookupBimiDomainResults +#> + +function Initialize-LookupBimiDomainResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Valid}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Query}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Records}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Errors}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Warnings} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupBimiDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Valid -eq $null) { + throw "invalid value for 'Valid', 'Valid' cannot be null." + } + + if ($Query -eq $null) { + throw "invalid value for 'Query', 'Query' cannot be null." + } + + if ($Records -eq $null) { + throw "invalid value for 'Records', 'Records' cannot be null." + } + + if ($Errors -eq $null) { + throw "invalid value for 'Errors', 'Errors' cannot be null." + } + + if ($Warnings -eq $null) { + throw "invalid value for 'Warnings', 'Warnings' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupBimiDomainResults + +.DESCRIPTION + +Convert from JSON to LookupBimiDomainResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupBimiDomainResults +#> +function ConvertFrom-JsonToLookupBimiDomainResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupBimiDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupBimiDomainResults + $AllProperties = ("valid", "query", "records", "errors", "warnings") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'valid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "valid"))) { + throw "Error! JSON cannot be serialized due to the required property 'valid' missing." + } else { + $Valid = $JsonParameters.PSobject.Properties["valid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "query"))) { + throw "Error! JSON cannot be serialized due to the required property 'query' missing." + } else { + $Query = $JsonParameters.PSobject.Properties["query"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "records"))) { + throw "Error! JSON cannot be serialized due to the required property 'records' missing." + } else { + $Records = $JsonParameters.PSobject.Properties["records"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "errors"))) { + throw "Error! JSON cannot be serialized due to the required property 'errors' missing." + } else { + $Errors = $JsonParameters.PSobject.Properties["errors"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "warnings"))) { + throw "Error! JSON cannot be serialized due to the required property 'warnings' missing." + } else { + $Warnings = $JsonParameters.PSobject.Properties["warnings"].value + } + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupDmarcDomainOptions.ps1 b/src/maislurp-client-powershell/Model/LookupDmarcDomainOptions.ps1 new file mode 100644 index 00000000..a1d4f961 --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupDmarcDomainOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarHost +No description available. +.OUTPUTS + +LookupDmarcDomainOptions +#> + +function Initialize-LookupDmarcDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupDmarcDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupDmarcDomainOptions + +.DESCRIPTION + +Convert from JSON to LookupDmarcDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupDmarcDomainOptions +#> +function ConvertFrom-JsonToLookupDmarcDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupDmarcDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupDmarcDomainOptions + $AllProperties = ("host") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'host' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupDmarcDomainResults.ps1 b/src/maislurp-client-powershell/Model/LookupDmarcDomainResults.ps1 new file mode 100644 index 00000000..d0311288 --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupDmarcDomainResults.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Valid +No description available. +.PARAMETER Query +No description available. +.PARAMETER Records +No description available. +.PARAMETER Errors +No description available. +.PARAMETER Warnings +No description available. +.OUTPUTS + +LookupDmarcDomainResults +#> + +function Initialize-LookupDmarcDomainResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Valid}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Query}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Records}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Errors}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Warnings} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupDmarcDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Valid -eq $null) { + throw "invalid value for 'Valid', 'Valid' cannot be null." + } + + if ($Query -eq $null) { + throw "invalid value for 'Query', 'Query' cannot be null." + } + + if ($Records -eq $null) { + throw "invalid value for 'Records', 'Records' cannot be null." + } + + if ($Errors -eq $null) { + throw "invalid value for 'Errors', 'Errors' cannot be null." + } + + if ($Warnings -eq $null) { + throw "invalid value for 'Warnings', 'Warnings' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupDmarcDomainResults + +.DESCRIPTION + +Convert from JSON to LookupDmarcDomainResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupDmarcDomainResults +#> +function ConvertFrom-JsonToLookupDmarcDomainResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupDmarcDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupDmarcDomainResults + $AllProperties = ("valid", "query", "records", "errors", "warnings") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'valid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "valid"))) { + throw "Error! JSON cannot be serialized due to the required property 'valid' missing." + } else { + $Valid = $JsonParameters.PSobject.Properties["valid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "query"))) { + throw "Error! JSON cannot be serialized due to the required property 'query' missing." + } else { + $Query = $JsonParameters.PSobject.Properties["query"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "records"))) { + throw "Error! JSON cannot be serialized due to the required property 'records' missing." + } else { + $Records = $JsonParameters.PSobject.Properties["records"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "errors"))) { + throw "Error! JSON cannot be serialized due to the required property 'errors' missing." + } else { + $Errors = $JsonParameters.PSobject.Properties["errors"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "warnings"))) { + throw "Error! JSON cannot be serialized due to the required property 'warnings' missing." + } else { + $Warnings = $JsonParameters.PSobject.Properties["warnings"].value + } + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupMtaStsDomainOptions.ps1 b/src/maislurp-client-powershell/Model/LookupMtaStsDomainOptions.ps1 new file mode 100644 index 00000000..d6e01e42 --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupMtaStsDomainOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarHost +No description available. +.OUTPUTS + +LookupMtaStsDomainOptions +#> + +function Initialize-LookupMtaStsDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupMtaStsDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupMtaStsDomainOptions + +.DESCRIPTION + +Convert from JSON to LookupMtaStsDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupMtaStsDomainOptions +#> +function ConvertFrom-JsonToLookupMtaStsDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupMtaStsDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupMtaStsDomainOptions + $AllProperties = ("host") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'host' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupMtaStsDomainResults.ps1 b/src/maislurp-client-powershell/Model/LookupMtaStsDomainResults.ps1 new file mode 100644 index 00000000..e274b004 --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupMtaStsDomainResults.ps1 @@ -0,0 +1,225 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Valid +No description available. +.PARAMETER Query +No description available. +.PARAMETER Records +No description available. +.PARAMETER WellKnownQuery +No description available. +.PARAMETER WellKnownPresent +No description available. +.PARAMETER WellKnownValue +No description available. +.PARAMETER Errors +No description available. +.PARAMETER Warnings +No description available. +.OUTPUTS + +LookupMtaStsDomainResults +#> + +function Initialize-LookupMtaStsDomainResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Valid}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Query}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Records}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WellKnownQuery}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${WellKnownPresent}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${WellKnownValue}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Errors}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Warnings} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupMtaStsDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Valid -eq $null) { + throw "invalid value for 'Valid', 'Valid' cannot be null." + } + + if ($Query -eq $null) { + throw "invalid value for 'Query', 'Query' cannot be null." + } + + if ($Records -eq $null) { + throw "invalid value for 'Records', 'Records' cannot be null." + } + + if ($WellKnownQuery -eq $null) { + throw "invalid value for 'WellKnownQuery', 'WellKnownQuery' cannot be null." + } + + if ($WellKnownPresent -eq $null) { + throw "invalid value for 'WellKnownPresent', 'WellKnownPresent' cannot be null." + } + + if ($WellKnownValue -eq $null) { + throw "invalid value for 'WellKnownValue', 'WellKnownValue' cannot be null." + } + + if ($Errors -eq $null) { + throw "invalid value for 'Errors', 'Errors' cannot be null." + } + + if ($Warnings -eq $null) { + throw "invalid value for 'Warnings', 'Warnings' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "wellKnownQuery" = ${WellKnownQuery} + "wellKnownPresent" = ${WellKnownPresent} + "wellKnownValue" = ${WellKnownValue} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupMtaStsDomainResults + +.DESCRIPTION + +Convert from JSON to LookupMtaStsDomainResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupMtaStsDomainResults +#> +function ConvertFrom-JsonToLookupMtaStsDomainResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupMtaStsDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupMtaStsDomainResults + $AllProperties = ("valid", "query", "records", "wellKnownQuery", "wellKnownPresent", "wellKnownValue", "errors", "warnings") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'valid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "valid"))) { + throw "Error! JSON cannot be serialized due to the required property 'valid' missing." + } else { + $Valid = $JsonParameters.PSobject.Properties["valid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "query"))) { + throw "Error! JSON cannot be serialized due to the required property 'query' missing." + } else { + $Query = $JsonParameters.PSobject.Properties["query"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "records"))) { + throw "Error! JSON cannot be serialized due to the required property 'records' missing." + } else { + $Records = $JsonParameters.PSobject.Properties["records"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "wellKnownQuery"))) { + throw "Error! JSON cannot be serialized due to the required property 'wellKnownQuery' missing." + } else { + $WellKnownQuery = $JsonParameters.PSobject.Properties["wellKnownQuery"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "wellKnownPresent"))) { + throw "Error! JSON cannot be serialized due to the required property 'wellKnownPresent' missing." + } else { + $WellKnownPresent = $JsonParameters.PSobject.Properties["wellKnownPresent"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "wellKnownValue"))) { + throw "Error! JSON cannot be serialized due to the required property 'wellKnownValue' missing." + } else { + $WellKnownValue = $JsonParameters.PSobject.Properties["wellKnownValue"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "errors"))) { + throw "Error! JSON cannot be serialized due to the required property 'errors' missing." + } else { + $Errors = $JsonParameters.PSobject.Properties["errors"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "warnings"))) { + throw "Error! JSON cannot be serialized due to the required property 'warnings' missing." + } else { + $Warnings = $JsonParameters.PSobject.Properties["warnings"].value + } + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "wellKnownQuery" = ${WellKnownQuery} + "wellKnownPresent" = ${WellKnownPresent} + "wellKnownValue" = ${WellKnownValue} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupTlsReportingDomainOptions.ps1 b/src/maislurp-client-powershell/Model/LookupTlsReportingDomainOptions.ps1 new file mode 100644 index 00000000..7c42171e --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupTlsReportingDomainOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarHost +No description available. +.OUTPUTS + +LookupTlsReportingDomainOptions +#> + +function Initialize-LookupTlsReportingDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupTlsReportingDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupTlsReportingDomainOptions + +.DESCRIPTION + +Convert from JSON to LookupTlsReportingDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupTlsReportingDomainOptions +#> +function ConvertFrom-JsonToLookupTlsReportingDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupTlsReportingDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupTlsReportingDomainOptions + $AllProperties = ("host") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'host' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/LookupTlsReportingDomainResults.ps1 b/src/maislurp-client-powershell/Model/LookupTlsReportingDomainResults.ps1 new file mode 100644 index 00000000..b4a0fbe6 --- /dev/null +++ b/src/maislurp-client-powershell/Model/LookupTlsReportingDomainResults.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Valid +No description available. +.PARAMETER Query +No description available. +.PARAMETER Records +No description available. +.PARAMETER Errors +No description available. +.PARAMETER Warnings +No description available. +.OUTPUTS + +LookupTlsReportingDomainResults +#> + +function Initialize-LookupTlsReportingDomainResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Valid}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Query}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Records}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Errors}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Warnings} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => LookupTlsReportingDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Valid -eq $null) { + throw "invalid value for 'Valid', 'Valid' cannot be null." + } + + if ($Query -eq $null) { + throw "invalid value for 'Query', 'Query' cannot be null." + } + + if ($Records -eq $null) { + throw "invalid value for 'Records', 'Records' cannot be null." + } + + if ($Errors -eq $null) { + throw "invalid value for 'Errors', 'Errors' cannot be null." + } + + if ($Warnings -eq $null) { + throw "invalid value for 'Warnings', 'Warnings' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to LookupTlsReportingDomainResults + +.DESCRIPTION + +Convert from JSON to LookupTlsReportingDomainResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +LookupTlsReportingDomainResults +#> +function ConvertFrom-JsonToLookupTlsReportingDomainResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => LookupTlsReportingDomainResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in LookupTlsReportingDomainResults + $AllProperties = ("valid", "query", "records", "errors", "warnings") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'valid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "valid"))) { + throw "Error! JSON cannot be serialized due to the required property 'valid' missing." + } else { + $Valid = $JsonParameters.PSobject.Properties["valid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "query"))) { + throw "Error! JSON cannot be serialized due to the required property 'query' missing." + } else { + $Query = $JsonParameters.PSobject.Properties["query"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "records"))) { + throw "Error! JSON cannot be serialized due to the required property 'records' missing." + } else { + $Records = $JsonParameters.PSobject.Properties["records"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "errors"))) { + throw "Error! JSON cannot be serialized due to the required property 'errors' missing." + } else { + $Errors = $JsonParameters.PSobject.Properties["errors"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "warnings"))) { + throw "Error! JSON cannot be serialized due to the required property 'warnings' missing." + } else { + $Warnings = $JsonParameters.PSobject.Properties["warnings"].value + } + + $PSO = [PSCustomObject]@{ + "valid" = ${Valid} + "query" = ${Query} + "records" = ${Records} + "errors" = ${Errors} + "warnings" = ${Warnings} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/MatchOption.ps1 b/src/maislurp-client-powershell/Model/MatchOption.ps1 new file mode 100644 index 00000000..4ff5ccf2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/MatchOption.ps1 @@ -0,0 +1,142 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for matching emails in an inbox. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `SUBJECT` should `CONTAIN` value. + +.PARAMETER Field +Fields of an email object that can be used to filter results +.PARAMETER Should +How the value of the email field specified should be compared to the value given in the match options. +.PARAMETER Value +The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed. +.OUTPUTS + +MatchOption +#> + +function Initialize-MatchOption { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUBJECT", "TO", "BCC", "CC", "FROM", "HEADERS")] + [String] + ${Field}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("MATCH", "CONTAIN", "EQUAL")] + [String] + ${Should}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => MatchOption' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Should -eq $null) { + throw "invalid value for 'Should', 'Should' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "field" = ${Field} + "should" = ${Should} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to MatchOption + +.DESCRIPTION + +Convert from JSON to MatchOption + +.PARAMETER Json + +Json object + +.OUTPUTS + +MatchOption +#> +function ConvertFrom-JsonToMatchOption { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => MatchOption' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in MatchOption + $AllProperties = ("field", "should", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'field' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "should"))) { + throw "Error! JSON cannot be serialized due to the required property 'should' missing." + } else { + $Should = $JsonParameters.PSobject.Properties["should"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "field" = ${Field} + "should" = ${Should} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/MatchOptions.ps1 b/src/maislurp-client-powershell/Model/MatchOptions.ps1 new file mode 100644 index 00000000..55b598af --- /dev/null +++ b/src/maislurp-client-powershell/Model/MatchOptions.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. You can also pass conditions such as `HAS_ATTACHMENT`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController. + +.PARAMETER VarMatches +Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results +.PARAMETER Conditions +Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`. Note the values are the strings `TRUE|FALSE` not booleans. +.OUTPUTS + +MatchOptions +#> + +function Initialize-MatchOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${VarMatches}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Conditions} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => MatchOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "matches" = ${VarMatches} + "conditions" = ${Conditions} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to MatchOptions + +.DESCRIPTION + +Convert from JSON to MatchOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +MatchOptions +#> +function ConvertFrom-JsonToMatchOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => MatchOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in MatchOptions + $AllProperties = ("matches", "conditions") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "matches"))) { #optional property not found + $VarMatches = $null + } else { + $VarMatches = $JsonParameters.PSobject.Properties["matches"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "conditions"))) { #optional property not found + $Conditions = $null + } else { + $Conditions = $JsonParameters.PSobject.Properties["conditions"].value + } + + $PSO = [PSCustomObject]@{ + "matches" = ${VarMatches} + "conditions" = ${Conditions} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/MissedEmailDto.ps1 b/src/maislurp-client-powershell/Model/MissedEmailDto.ps1 new file mode 100644 index 00000000..3a34d879 --- /dev/null +++ b/src/maislurp-client-powershell/Model/MissedEmailDto.ps1 @@ -0,0 +1,329 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Missed email + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER Subject +No description available. +.PARAMETER BodyExcerpt +No description available. +.PARAMETER AttachmentCount +No description available. +.PARAMETER VarFrom +No description available. +.PARAMETER RawUrl +No description available. +.PARAMETER RawKey +No description available. +.PARAMETER RawBucket +No description available. +.PARAMETER CanRestore +No description available. +.PARAMETER To +No description available. +.PARAMETER Cc +No description available. +.PARAMETER Bcc +No description available. +.PARAMETER InboxIds +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +MissedEmailDto +#> + +function Initialize-MissedEmailDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyExcerpt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${AttachmentCount}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${RawUrl}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${RawKey}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${RawBucket}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${CanRestore}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${InboxIds}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => MissedEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($AttachmentCount -eq $null) { + throw "invalid value for 'AttachmentCount', 'AttachmentCount' cannot be null." + } + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + if ($Cc -eq $null) { + throw "invalid value for 'Cc', 'Cc' cannot be null." + } + + if ($Bcc -eq $null) { + throw "invalid value for 'Bcc', 'Bcc' cannot be null." + } + + if ($InboxIds -eq $null) { + throw "invalid value for 'InboxIds', 'InboxIds' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "subject" = ${Subject} + "bodyExcerpt" = ${BodyExcerpt} + "attachmentCount" = ${AttachmentCount} + "from" = ${VarFrom} + "rawUrl" = ${RawUrl} + "rawKey" = ${RawKey} + "rawBucket" = ${RawBucket} + "canRestore" = ${CanRestore} + "to" = ${To} + "cc" = ${Cc} + "bcc" = ${Bcc} + "inboxIds" = ${InboxIds} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to MissedEmailDto + +.DESCRIPTION + +Convert from JSON to MissedEmailDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +MissedEmailDto +#> +function ConvertFrom-JsonToMissedEmailDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => MissedEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in MissedEmailDto + $AllProperties = ("id", "userId", "subject", "bodyExcerpt", "attachmentCount", "from", "rawUrl", "rawKey", "rawBucket", "canRestore", "to", "cc", "bcc", "inboxIds", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachmentCount"))) { + throw "Error! JSON cannot be serialized due to the required property 'attachmentCount' missing." + } else { + $AttachmentCount = $JsonParameters.PSobject.Properties["attachmentCount"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { + throw "Error! JSON cannot be serialized due to the required property 'cc' missing." + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { + throw "Error! JSON cannot be serialized due to the required property 'bcc' missing." + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxIds"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxIds' missing." + } else { + $InboxIds = $JsonParameters.PSobject.Properties["inboxIds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyExcerpt"))) { #optional property not found + $BodyExcerpt = $null + } else { + $BodyExcerpt = $JsonParameters.PSobject.Properties["bodyExcerpt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rawUrl"))) { #optional property not found + $RawUrl = $null + } else { + $RawUrl = $JsonParameters.PSobject.Properties["rawUrl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rawKey"))) { #optional property not found + $RawKey = $null + } else { + $RawKey = $JsonParameters.PSobject.Properties["rawKey"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rawBucket"))) { #optional property not found + $RawBucket = $null + } else { + $RawBucket = $JsonParameters.PSobject.Properties["rawBucket"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "canRestore"))) { #optional property not found + $CanRestore = $null + } else { + $CanRestore = $JsonParameters.PSobject.Properties["canRestore"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "subject" = ${Subject} + "bodyExcerpt" = ${BodyExcerpt} + "attachmentCount" = ${AttachmentCount} + "from" = ${VarFrom} + "rawUrl" = ${RawUrl} + "rawKey" = ${RawKey} + "rawBucket" = ${RawBucket} + "canRestore" = ${CanRestore} + "to" = ${To} + "cc" = ${Cc} + "bcc" = ${Bcc} + "inboxIds" = ${InboxIds} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/MissedEmailProjection.ps1 b/src/maislurp-client-powershell/Model/MissedEmailProjection.ps1 new file mode 100644 index 00000000..03400983 --- /dev/null +++ b/src/maislurp-client-powershell/Model/MissedEmailProjection.ps1 @@ -0,0 +1,162 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Missed email data + +.PARAMETER UserId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Id +No description available. +.PARAMETER VarFrom +No description available. +.OUTPUTS + +MissedEmailProjection +#> + +function Initialize-MissedEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => MissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + "from" = ${VarFrom} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to MissedEmailProjection + +.DESCRIPTION + +Convert from JSON to MissedEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +MissedEmailProjection +#> +function ConvertFrom-JsonToMissedEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => MissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in MissedEmailProjection + $AllProperties = ("userId", "createdAt", "subject", "id", "from") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { #optional property not found + $UserId = $null + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + "from" = ${VarFrom} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ModelSender.ps1 b/src/maislurp-client-powershell/Model/ModelSender.ps1 new file mode 100644 index 00000000..dfbc6685 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ModelSender.ps1 @@ -0,0 +1,136 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Sender object containing from email address and from personal name if provided in address + +.PARAMETER RawValue +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER Name +No description available. +.OUTPUTS + +ModelSender +#> + +function Initialize-ModelSender { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${RawValue}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ModelSender' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($RawValue -eq $null) { + throw "invalid value for 'RawValue', 'RawValue' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "rawValue" = ${RawValue} + "emailAddress" = ${EmailAddress} + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ModelSender + +.DESCRIPTION + +Convert from JSON to ModelSender + +.PARAMETER Json + +Json object + +.OUTPUTS + +ModelSender +#> +function ConvertFrom-JsonToModelSender { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ModelSender' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ModelSender + $AllProperties = ("rawValue", "emailAddress", "name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'rawValue' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rawValue"))) { + throw "Error! JSON cannot be serialized due to the required property 'rawValue' missing." + } else { + $RawValue = $JsonParameters.PSobject.Properties["rawValue"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "rawValue" = ${RawValue} + "emailAddress" = ${EmailAddress} + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/NameServerRecord.ps1 b/src/maislurp-client-powershell/Model/NameServerRecord.ps1 new file mode 100644 index 00000000..58324d38 --- /dev/null +++ b/src/maislurp-client-powershell/Model/NameServerRecord.ps1 @@ -0,0 +1,157 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Name Server Record + +.PARAMETER Raw +No description available. +.PARAMETER RecordType +No description available. +.PARAMETER Priority +No description available. +.PARAMETER Value +No description available. +.OUTPUTS + +NameServerRecord +#> + +function Initialize-NameServerRecord { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Raw}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${RecordType}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Priority}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => NameServerRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Raw -eq $null) { + throw "invalid value for 'Raw', 'Raw' cannot be null." + } + + if ($RecordType -eq $null) { + throw "invalid value for 'RecordType', 'RecordType' cannot be null." + } + + if ($Priority -eq $null) { + throw "invalid value for 'Priority', 'Priority' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "raw" = ${Raw} + "recordType" = ${RecordType} + "priority" = ${Priority} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to NameServerRecord + +.DESCRIPTION + +Convert from JSON to NameServerRecord + +.PARAMETER Json + +Json object + +.OUTPUTS + +NameServerRecord +#> +function ConvertFrom-JsonToNameServerRecord { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => NameServerRecord' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in NameServerRecord + $AllProperties = ("raw", "recordType", "priority", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'raw' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "raw"))) { + throw "Error! JSON cannot be serialized due to the required property 'raw' missing." + } else { + $Raw = $JsonParameters.PSobject.Properties["raw"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recordType"))) { + throw "Error! JSON cannot be serialized due to the required property 'recordType' missing." + } else { + $RecordType = $JsonParameters.PSobject.Properties["recordType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "priority"))) { + throw "Error! JSON cannot be serialized due to the required property 'priority' missing." + } else { + $Priority = $JsonParameters.PSobject.Properties["priority"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "raw" = ${Raw} + "recordType" = ${RecordType} + "priority" = ${Priority} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/NewFakeEmailAddressResult.ps1 b/src/maislurp-client-powershell/Model/NewFakeEmailAddressResult.ps1 new file mode 100644 index 00000000..ab365072 --- /dev/null +++ b/src/maislurp-client-powershell/Model/NewFakeEmailAddressResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER EmailAddress +No description available. +.OUTPUTS + +NewFakeEmailAddressResult +#> + +function Initialize-NewFakeEmailAddressResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => NewFakeEmailAddressResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to NewFakeEmailAddressResult + +.DESCRIPTION + +Convert from JSON to NewFakeEmailAddressResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +NewFakeEmailAddressResult +#> +function ConvertFrom-JsonToNewFakeEmailAddressResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => NewFakeEmailAddressResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in NewFakeEmailAddressResult + $AllProperties = ("emailAddress") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddress' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddress" = ${EmailAddress} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/OrganizationInboxProjection.ps1 b/src/maislurp-client-powershell/Model/OrganizationInboxProjection.ps1 new file mode 100644 index 00000000..5e7f6381 --- /dev/null +++ b/src/maislurp-client-powershell/Model/OrganizationInboxProjection.ps1 @@ -0,0 +1,271 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Organization team inbox + +.PARAMETER Id +ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. +.PARAMETER DomainId +ID of custom domain used by the inbox if any +.PARAMETER CreatedAt +When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. +.PARAMETER Name +Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search +.PARAMETER EmailAddress +The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. +.PARAMETER Favourite +Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering +.PARAMETER Tags +Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. +.PARAMETER TeamAccess +Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/ +.PARAMETER InboxType +Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). +.PARAMETER ReadOnly +Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes. +.PARAMETER VirtualInbox +Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. +.PARAMETER FunctionsAs +Inbox function if used as a primitive for another system. +.OUTPUTS + +OrganizationInboxProjection +#> + +function Initialize-OrganizationInboxProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Favourite}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${TeamAccess}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${ReadOnly}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${VirtualInbox}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR")] + [String] + ${FunctionsAs} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => OrganizationInboxProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Favourite -eq $null) { + throw "invalid value for 'Favourite', 'Favourite' cannot be null." + } + + if ($TeamAccess -eq $null) { + throw "invalid value for 'TeamAccess', 'TeamAccess' cannot be null." + } + + if ($ReadOnly -eq $null) { + throw "invalid value for 'ReadOnly', 'ReadOnly' cannot be null." + } + + if ($VirtualInbox -eq $null) { + throw "invalid value for 'VirtualInbox', 'VirtualInbox' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domainId" = ${DomainId} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "emailAddress" = ${EmailAddress} + "favourite" = ${Favourite} + "tags" = ${Tags} + "teamAccess" = ${TeamAccess} + "inboxType" = ${InboxType} + "readOnly" = ${ReadOnly} + "virtualInbox" = ${VirtualInbox} + "functionsAs" = ${FunctionsAs} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to OrganizationInboxProjection + +.DESCRIPTION + +Convert from JSON to OrganizationInboxProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +OrganizationInboxProjection +#> +function ConvertFrom-JsonToOrganizationInboxProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => OrganizationInboxProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in OrganizationInboxProjection + $AllProperties = ("id", "domainId", "createdAt", "name", "emailAddress", "favourite", "tags", "teamAccess", "inboxType", "readOnly", "virtualInbox", "functionsAs") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "favourite"))) { + throw "Error! JSON cannot be serialized due to the required property 'favourite' missing." + } else { + $Favourite = $JsonParameters.PSobject.Properties["favourite"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "teamAccess"))) { + throw "Error! JSON cannot be serialized due to the required property 'teamAccess' missing." + } else { + $TeamAccess = $JsonParameters.PSobject.Properties["teamAccess"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "readOnly"))) { + throw "Error! JSON cannot be serialized due to the required property 'readOnly' missing." + } else { + $ReadOnly = $JsonParameters.PSobject.Properties["readOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virtualInbox"))) { + throw "Error! JSON cannot be serialized due to the required property 'virtualInbox' missing." + } else { + $VirtualInbox = $JsonParameters.PSobject.Properties["virtualInbox"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { #optional property not found + $EmailAddress = $null + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { #optional property not found + $Tags = $null + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxType"))) { #optional property not found + $InboxType = $null + } else { + $InboxType = $JsonParameters.PSobject.Properties["inboxType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "functionsAs"))) { #optional property not found + $FunctionsAs = $null + } else { + $FunctionsAs = $JsonParameters.PSobject.Properties["functionsAs"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "domainId" = ${DomainId} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "emailAddress" = ${EmailAddress} + "favourite" = ${Favourite} + "tags" = ${Tags} + "teamAccess" = ${TeamAccess} + "inboxType" = ${InboxType} + "readOnly" = ${ReadOnly} + "virtualInbox" = ${VirtualInbox} + "functionsAs" = ${FunctionsAs} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageAlias.ps1 b/src/maislurp-client-powershell/Model/PageAlias.ps1 new file mode 100644 index 00000000..4a609c62 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageAlias.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated email alias results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageAlias +#> + +function Initialize-PageAlias { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageAlias' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageAlias + +.DESCRIPTION + +Convert from JSON to PageAlias + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageAlias +#> +function ConvertFrom-JsonToPageAlias { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageAlias' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageAlias + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageAttachmentEntity.ps1 b/src/maislurp-client-powershell/Model/PageAttachmentEntity.ps1 new file mode 100644 index 00000000..4970f6da --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageAttachmentEntity.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated attachment entity results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageAttachmentEntity +#> + +function Initialize-PageAttachmentEntity { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageAttachmentEntity' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageAttachmentEntity + +.DESCRIPTION + +Convert from JSON to PageAttachmentEntity + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageAttachmentEntity +#> +function ConvertFrom-JsonToPageAttachmentEntity { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageAttachmentEntity' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageAttachmentEntity + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageBouncedEmail.ps1 b/src/maislurp-client-powershell/Model/PageBouncedEmail.ps1 new file mode 100644 index 00000000..565045d1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageBouncedEmail.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated bounced email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageBouncedEmail +#> + +function Initialize-PageBouncedEmail { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageBouncedEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageBouncedEmail + +.DESCRIPTION + +Convert from JSON to PageBouncedEmail + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageBouncedEmail +#> +function ConvertFrom-JsonToPageBouncedEmail { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageBouncedEmail' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageBouncedEmail + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageBouncedRecipients.ps1 b/src/maislurp-client-powershell/Model/PageBouncedRecipients.ps1 new file mode 100644 index 00000000..531fa4ee --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageBouncedRecipients.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated bounced recipients. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageBouncedRecipients +#> + +function Initialize-PageBouncedRecipients { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageBouncedRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageBouncedRecipients + +.DESCRIPTION + +Convert from JSON to PageBouncedRecipients + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageBouncedRecipients +#> +function ConvertFrom-JsonToPageBouncedRecipients { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageBouncedRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageBouncedRecipients + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageComplaint.ps1 b/src/maislurp-client-powershell/Model/PageComplaint.ps1 new file mode 100644 index 00000000..2f1d779d --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageComplaint.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated complaint email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageComplaint +#> + +function Initialize-PageComplaint { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageComplaint' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageComplaint + +.DESCRIPTION + +Convert from JSON to PageComplaint + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageComplaint +#> +function ConvertFrom-JsonToPageComplaint { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageComplaint' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageComplaint + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageConnector.ps1 b/src/maislurp-client-powershell/Model/PageConnector.ps1 new file mode 100644 index 00000000..fb1db3ca --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageConnector.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox connectors. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageConnector +#> + +function Initialize-PageConnector { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageConnector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageConnector + +.DESCRIPTION + +Convert from JSON to PageConnector + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageConnector +#> +function ConvertFrom-JsonToPageConnector { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageConnector' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageConnector + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageConnectorSyncEvents.ps1 b/src/maislurp-client-powershell/Model/PageConnectorSyncEvents.ps1 new file mode 100644 index 00000000..f494b365 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageConnectorSyncEvents.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox connector sync events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageConnectorSyncEvents +#> + +function Initialize-PageConnectorSyncEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageConnectorSyncEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageConnectorSyncEvents + +.DESCRIPTION + +Convert from JSON to PageConnectorSyncEvents + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageConnectorSyncEvents +#> +function ConvertFrom-JsonToPageConnectorSyncEvents { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageConnectorSyncEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageConnectorSyncEvents + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageContactProjection.ps1 b/src/maislurp-client-powershell/Model/PageContactProjection.ps1 new file mode 100644 index 00000000..8e0609f7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageContactProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated contact results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageContactProjection +#> + +function Initialize-PageContactProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageContactProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageContactProjection + +.DESCRIPTION + +Convert from JSON to PageContactProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageContactProjection +#> +function ConvertFrom-JsonToPageContactProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageContactProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageContactProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageDeliveryStatus.ps1 b/src/maislurp-client-powershell/Model/PageDeliveryStatus.ps1 new file mode 100644 index 00000000..da3367ba --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageDeliveryStatus.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated delivery status results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageDeliveryStatus +#> + +function Initialize-PageDeliveryStatus { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageDeliveryStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageDeliveryStatus + +.DESCRIPTION + +Convert from JSON to PageDeliveryStatus + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageDeliveryStatus +#> +function ConvertFrom-JsonToPageDeliveryStatus { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageDeliveryStatus' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageDeliveryStatus + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageEmailPreview.ps1 b/src/maislurp-client-powershell/Model/PageEmailPreview.ps1 new file mode 100644 index 00000000..aad59797 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageEmailPreview.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated email preview results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageEmailPreview +#> + +function Initialize-PageEmailPreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageEmailPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageEmailPreview + +.DESCRIPTION + +Convert from JSON to PageEmailPreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageEmailPreview +#> +function ConvertFrom-JsonToPageEmailPreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageEmailPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageEmailPreview + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageEmailProjection.ps1 b/src/maislurp-client-powershell/Model/PageEmailProjection.ps1 new file mode 100644 index 00000000..fc51e623 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageEmailProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full email entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageEmailProjection +#> + +function Initialize-PageEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageEmailProjection + +.DESCRIPTION + +Convert from JSON to PageEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageEmailProjection +#> +function ConvertFrom-JsonToPageEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageEmailProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageEmailValidationRequest.ps1 b/src/maislurp-client-powershell/Model/PageEmailValidationRequest.ps1 new file mode 100644 index 00000000..8e0e75c1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageEmailValidationRequest.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated email validation request records. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageEmailValidationRequest +#> + +function Initialize-PageEmailValidationRequest { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageEmailValidationRequest' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageEmailValidationRequest + +.DESCRIPTION + +Convert from JSON to PageEmailValidationRequest + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageEmailValidationRequest +#> +function ConvertFrom-JsonToPageEmailValidationRequest { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageEmailValidationRequest' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageEmailValidationRequest + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageExpiredInboxRecordProjection.ps1 b/src/maislurp-client-powershell/Model/PageExpiredInboxRecordProjection.ps1 new file mode 100644 index 00000000..d53a1fd8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageExpiredInboxRecordProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated expired inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageExpiredInboxRecordProjection +#> + +function Initialize-PageExpiredInboxRecordProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageExpiredInboxRecordProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageExpiredInboxRecordProjection + +.DESCRIPTION + +Convert from JSON to PageExpiredInboxRecordProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageExpiredInboxRecordProjection +#> +function ConvertFrom-JsonToPageExpiredInboxRecordProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageExpiredInboxRecordProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageExpiredInboxRecordProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageGroupProjection.ps1 b/src/maislurp-client-powershell/Model/PageGroupProjection.ps1 new file mode 100644 index 00000000..5122d0d0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageGroupProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated missed email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageGroupProjection +#> + +function Initialize-PageGroupProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageGroupProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageGroupProjection + +.DESCRIPTION + +Convert from JSON to PageGroupProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageGroupProjection +#> +function ConvertFrom-JsonToPageGroupProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageGroupProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageGroupProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageInboxForwarderDto.ps1 b/src/maislurp-client-powershell/Model/PageInboxForwarderDto.ps1 new file mode 100644 index 00000000..28a3f465 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageInboxForwarderDto.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox forwarder results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageInboxForwarderDto +#> + +function Initialize-PageInboxForwarderDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageInboxForwarderDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageInboxForwarderDto + +.DESCRIPTION + +Convert from JSON to PageInboxForwarderDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageInboxForwarderDto +#> +function ConvertFrom-JsonToPageInboxForwarderDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageInboxForwarderDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageInboxForwarderDto + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageInboxForwarderEvents.ps1 b/src/maislurp-client-powershell/Model/PageInboxForwarderEvents.ps1 new file mode 100644 index 00000000..bfdf752f --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageInboxForwarderEvents.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox forwarder events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageInboxForwarderEvents +#> + +function Initialize-PageInboxForwarderEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageInboxForwarderEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageInboxForwarderEvents + +.DESCRIPTION + +Convert from JSON to PageInboxForwarderEvents + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageInboxForwarderEvents +#> +function ConvertFrom-JsonToPageInboxForwarderEvents { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageInboxForwarderEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageInboxForwarderEvents + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageInboxProjection.ps1 b/src/maislurp-client-powershell/Model/PageInboxProjection.ps1 new file mode 100644 index 00000000..350f10dc --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageInboxProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageInboxProjection +#> + +function Initialize-PageInboxProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageInboxProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageInboxProjection + +.DESCRIPTION + +Convert from JSON to PageInboxProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageInboxProjection +#> +function ConvertFrom-JsonToPageInboxProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageInboxProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageInboxProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageInboxReplierDto.ps1 b/src/maislurp-client-powershell/Model/PageInboxReplierDto.ps1 new file mode 100644 index 00000000..cc944924 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageInboxReplierDto.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox replier results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageInboxReplierDto +#> + +function Initialize-PageInboxReplierDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageInboxReplierDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageInboxReplierDto + +.DESCRIPTION + +Convert from JSON to PageInboxReplierDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageInboxReplierDto +#> +function ConvertFrom-JsonToPageInboxReplierDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageInboxReplierDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageInboxReplierDto + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageInboxReplierEvents.ps1 b/src/maislurp-client-powershell/Model/PageInboxReplierEvents.ps1 new file mode 100644 index 00000000..a848303a --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageInboxReplierEvents.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox replier events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageInboxReplierEvents +#> + +function Initialize-PageInboxReplierEvents { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageInboxReplierEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageInboxReplierEvents + +.DESCRIPTION + +Convert from JSON to PageInboxReplierEvents + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageInboxReplierEvents +#> +function ConvertFrom-JsonToPageInboxReplierEvents { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageInboxReplierEvents' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageInboxReplierEvents + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageInboxRulesetDto.ps1 b/src/maislurp-client-powershell/Model/PageInboxRulesetDto.ps1 new file mode 100644 index 00000000..caa6b62d --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageInboxRulesetDto.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated inbox ruleset results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageInboxRulesetDto +#> + +function Initialize-PageInboxRulesetDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageInboxRulesetDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageInboxRulesetDto + +.DESCRIPTION + +Convert from JSON to PageInboxRulesetDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageInboxRulesetDto +#> +function ConvertFrom-JsonToPageInboxRulesetDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageInboxRulesetDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageInboxRulesetDto + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageListUnsubscribeRecipients.ps1 b/src/maislurp-client-powershell/Model/PageListUnsubscribeRecipients.ps1 new file mode 100644 index 00000000..9e567e44 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageListUnsubscribeRecipients.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated list unsubscribe recipients. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageListUnsubscribeRecipients +#> + +function Initialize-PageListUnsubscribeRecipients { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageListUnsubscribeRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageListUnsubscribeRecipients + +.DESCRIPTION + +Convert from JSON to PageListUnsubscribeRecipients + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageListUnsubscribeRecipients +#> +function ConvertFrom-JsonToPageListUnsubscribeRecipients { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageListUnsubscribeRecipients' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageListUnsubscribeRecipients + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageMissedEmailProjection.ps1 b/src/maislurp-client-powershell/Model/PageMissedEmailProjection.ps1 new file mode 100644 index 00000000..9fe8abaa --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageMissedEmailProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated MissedEmail results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageMissedEmailProjection +#> + +function Initialize-PageMissedEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageMissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageMissedEmailProjection + +.DESCRIPTION + +Convert from JSON to PageMissedEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageMissedEmailProjection +#> +function ConvertFrom-JsonToPageMissedEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageMissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageMissedEmailProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageOrganizationInboxProjection.ps1 b/src/maislurp-client-powershell/Model/PageOrganizationInboxProjection.ps1 new file mode 100644 index 00000000..e7c8bfe7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageOrganizationInboxProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated organization inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageOrganizationInboxProjection +#> + +function Initialize-PageOrganizationInboxProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageOrganizationInboxProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageOrganizationInboxProjection + +.DESCRIPTION + +Convert from JSON to PageOrganizationInboxProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageOrganizationInboxProjection +#> +function ConvertFrom-JsonToPageOrganizationInboxProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageOrganizationInboxProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageOrganizationInboxProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PagePhoneNumberProjection.ps1 b/src/maislurp-client-powershell/Model/PagePhoneNumberProjection.ps1 new file mode 100644 index 00000000..097ecca8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PagePhoneNumberProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated phone numbers. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PagePhoneNumberProjection +#> + +function Initialize-PagePhoneNumberProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PagePhoneNumberProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PagePhoneNumberProjection + +.DESCRIPTION + +Convert from JSON to PagePhoneNumberProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PagePhoneNumberProjection +#> +function ConvertFrom-JsonToPagePhoneNumberProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PagePhoneNumberProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PagePhoneNumberProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageScheduledJobs.ps1 b/src/maislurp-client-powershell/Model/PageScheduledJobs.ps1 new file mode 100644 index 00000000..9fd84c30 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageScheduledJobs.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated scheduled jobs results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageScheduledJobs +#> + +function Initialize-PageScheduledJobs { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageScheduledJobs' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageScheduledJobs + +.DESCRIPTION + +Convert from JSON to PageScheduledJobs + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageScheduledJobs +#> +function ConvertFrom-JsonToPageScheduledJobs { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageScheduledJobs' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageScheduledJobs + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageSentEmailProjection.ps1 b/src/maislurp-client-powershell/Model/PageSentEmailProjection.ps1 new file mode 100644 index 00000000..5782eff5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageSentEmailProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated sent email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageSentEmailProjection +#> + +function Initialize-PageSentEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageSentEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageSentEmailProjection + +.DESCRIPTION + +Convert from JSON to PageSentEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageSentEmailProjection +#> +function ConvertFrom-JsonToPageSentEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageSentEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageSentEmailProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageSentEmailWithQueueProjection.ps1 b/src/maislurp-client-powershell/Model/PageSentEmailWithQueueProjection.ps1 new file mode 100644 index 00000000..e1aad4ed --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageSentEmailWithQueueProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated sent email results for emails sent with queue. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageSentEmailWithQueueProjection +#> + +function Initialize-PageSentEmailWithQueueProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageSentEmailWithQueueProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageSentEmailWithQueueProjection + +.DESCRIPTION + +Convert from JSON to PageSentEmailWithQueueProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageSentEmailWithQueueProjection +#> +function ConvertFrom-JsonToPageSentEmailWithQueueProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageSentEmailWithQueueProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageSentEmailWithQueueProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageSmsProjection.ps1 b/src/maislurp-client-powershell/Model/PageSmsProjection.ps1 new file mode 100644 index 00000000..f1106d66 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageSmsProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageSmsProjection +#> + +function Initialize-PageSmsProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageSmsProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageSmsProjection + +.DESCRIPTION + +Convert from JSON to PageSmsProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageSmsProjection +#> +function ConvertFrom-JsonToPageSmsProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageSmsProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageSmsProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageTemplateProjection.ps1 b/src/maislurp-client-powershell/Model/PageTemplateProjection.ps1 new file mode 100644 index 00000000..72d32ac4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageTemplateProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated email template results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageTemplateProjection +#> + +function Initialize-PageTemplateProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageTemplateProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageTemplateProjection + +.DESCRIPTION + +Convert from JSON to PageTemplateProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageTemplateProjection +#> +function ConvertFrom-JsonToPageTemplateProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageTemplateProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageTemplateProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageThreadProjection.ps1 b/src/maislurp-client-powershell/Model/PageThreadProjection.ps1 new file mode 100644 index 00000000..c7a9ff7b --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageThreadProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full email entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageThreadProjection +#> + +function Initialize-PageThreadProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageThreadProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageThreadProjection + +.DESCRIPTION + +Convert from JSON to PageThreadProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageThreadProjection +#> +function ConvertFrom-JsonToPageThreadProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageThreadProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageThreadProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageTrackingPixelProjection.ps1 b/src/maislurp-client-powershell/Model/PageTrackingPixelProjection.ps1 new file mode 100644 index 00000000..eb859b0d --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageTrackingPixelProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated TrackingPixel results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageTrackingPixelProjection +#> + +function Initialize-PageTrackingPixelProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageTrackingPixelProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageTrackingPixelProjection + +.DESCRIPTION + +Convert from JSON to PageTrackingPixelProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageTrackingPixelProjection +#> +function ConvertFrom-JsonToPageTrackingPixelProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageTrackingPixelProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageTrackingPixelProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageUnknownMissedEmailProjection.ps1 b/src/maislurp-client-powershell/Model/PageUnknownMissedEmailProjection.ps1 new file mode 100644 index 00000000..b4b7e75a --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageUnknownMissedEmailProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated unknown MissedEmail results. Unknown missed emails are emails that were sent to MailSlurp /Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageUnknownMissedEmailProjection +#> + +function Initialize-PageUnknownMissedEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageUnknownMissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageUnknownMissedEmailProjection + +.DESCRIPTION + +Convert from JSON to PageUnknownMissedEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageUnknownMissedEmailProjection +#> +function ConvertFrom-JsonToPageUnknownMissedEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageUnknownMissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageUnknownMissedEmailProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageWebhookProjection.ps1 b/src/maislurp-client-powershell/Model/PageWebhookProjection.ps1 new file mode 100644 index 00000000..0a2c5fd3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageWebhookProjection.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated webhook entity. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageWebhookProjection +#> + +function Initialize-PageWebhookProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageWebhookProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageWebhookProjection + +.DESCRIPTION + +Convert from JSON to PageWebhookProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageWebhookProjection +#> +function ConvertFrom-JsonToPageWebhookProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageWebhookProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageWebhookProjection + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageWebhookResult.ps1 b/src/maislurp-client-powershell/Model/PageWebhookResult.ps1 new file mode 100644 index 00000000..f4d1eac3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageWebhookResult.ps1 @@ -0,0 +1,240 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Paginated webhook results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. + +.PARAMETER Content +No description available. +.PARAMETER Pageable +No description available. +.PARAMETER TotalPages +No description available. +.PARAMETER TotalElements +No description available. +.PARAMETER Last +No description available. +.PARAMETER NumberOfElements +No description available. +.PARAMETER Size +No description available. +.PARAMETER Number +No description available. +.PARAMETER Sort +No description available. +.PARAMETER First +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +PageWebhookResult +#> + +function Initialize-PageWebhookResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Content}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Pageable}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${TotalPages}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${TotalElements}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Last}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${NumberOfElements}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Size}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Number}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${First}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageWebhookResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($TotalPages -eq $null) { + throw "invalid value for 'TotalPages', 'TotalPages' cannot be null." + } + + if ($TotalElements -eq $null) { + throw "invalid value for 'TotalElements', 'TotalElements' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageWebhookResult + +.DESCRIPTION + +Convert from JSON to PageWebhookResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageWebhookResult +#> +function ConvertFrom-JsonToPageWebhookResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageWebhookResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageWebhookResult + $AllProperties = ("content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "size", "number", "sort", "first", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'totalPages' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalPages"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalPages' missing." + } else { + $TotalPages = $JsonParameters.PSobject.Properties["totalPages"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "totalElements"))) { + throw "Error! JSON cannot be serialized due to the required property 'totalElements' missing." + } else { + $TotalElements = $JsonParameters.PSobject.Properties["totalElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { #optional property not found + $Content = $null + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageable"))) { #optional property not found + $Pageable = $null + } else { + $Pageable = $JsonParameters.PSobject.Properties["pageable"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "last"))) { #optional property not found + $Last = $null + } else { + $Last = $JsonParameters.PSobject.Properties["last"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "numberOfElements"))) { #optional property not found + $NumberOfElements = $null + } else { + $NumberOfElements = $JsonParameters.PSobject.Properties["numberOfElements"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "size"))) { #optional property not found + $Size = $null + } else { + $Size = $JsonParameters.PSobject.Properties["size"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "number"))) { #optional property not found + $Number = $null + } else { + $Number = $JsonParameters.PSobject.Properties["number"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "first"))) { #optional property not found + $First = $null + } else { + $First = $JsonParameters.PSobject.Properties["first"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + "pageable" = ${Pageable} + "totalPages" = ${TotalPages} + "totalElements" = ${TotalElements} + "last" = ${Last} + "numberOfElements" = ${NumberOfElements} + "size" = ${Size} + "number" = ${Number} + "sort" = ${Sort} + "first" = ${First} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PageableObject.ps1 b/src/maislurp-client-powershell/Model/PageableObject.ps1 new file mode 100644 index 00000000..7ac4b0bf --- /dev/null +++ b/src/maislurp-client-powershell/Model/PageableObject.ps1 @@ -0,0 +1,163 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PageNumber +No description available. +.PARAMETER PageSize +No description available. +.PARAMETER Paged +No description available. +.PARAMETER Unpaged +No description available. +.PARAMETER Offset +No description available. +.PARAMETER Sort +No description available. +.OUTPUTS + +PageableObject +#> + +function Initialize-PageableObject { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${PageNumber}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${PageSize}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Paged}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Unpaged}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${Offset}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Sort} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PageableObject' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "pageNumber" = ${PageNumber} + "pageSize" = ${PageSize} + "paged" = ${Paged} + "unpaged" = ${Unpaged} + "offset" = ${Offset} + "sort" = ${Sort} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PageableObject + +.DESCRIPTION + +Convert from JSON to PageableObject + +.PARAMETER Json + +Json object + +.OUTPUTS + +PageableObject +#> +function ConvertFrom-JsonToPageableObject { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PageableObject' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PageableObject + $AllProperties = ("pageNumber", "pageSize", "paged", "unpaged", "offset", "sort") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageNumber"))) { #optional property not found + $PageNumber = $null + } else { + $PageNumber = $JsonParameters.PSobject.Properties["pageNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageSize"))) { #optional property not found + $PageSize = $null + } else { + $PageSize = $JsonParameters.PSobject.Properties["pageSize"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "paged"))) { #optional property not found + $Paged = $null + } else { + $Paged = $JsonParameters.PSobject.Properties["paged"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unpaged"))) { #optional property not found + $Unpaged = $null + } else { + $Unpaged = $JsonParameters.PSobject.Properties["unpaged"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "offset"))) { #optional property not found + $Offset = $null + } else { + $Offset = $JsonParameters.PSobject.Properties["offset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sort"))) { #optional property not found + $Sort = $null + } else { + $Sort = $JsonParameters.PSobject.Properties["sort"].value + } + + $PSO = [PSCustomObject]@{ + "pageNumber" = ${PageNumber} + "pageSize" = ${PageSize} + "paged" = ${Paged} + "unpaged" = ${Unpaged} + "offset" = ${Offset} + "sort" = ${Sort} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PhoneNumberDto.ps1 b/src/maislurp-client-powershell/Model/PhoneNumberDto.ps1 new file mode 100644 index 00000000..9b045b64 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PhoneNumberDto.ps1 @@ -0,0 +1,235 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER ComplianceAddress +No description available. +.PARAMETER EmergencyAddress +No description available. +.PARAMETER PhoneNumber +No description available. +.PARAMETER PhoneCountry +No description available. +.PARAMETER PhonePlan +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +PhoneNumberDto +#> + +function Initialize-PhoneNumberDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${ComplianceAddress}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmergencyAddress}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("US", "GB", "AU")] + [String] + ${PhoneCountry}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhonePlan}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PhoneNumberDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($PhoneCountry -eq $null) { + throw "invalid value for 'PhoneCountry', 'PhoneCountry' cannot be null." + } + + if ($PhonePlan -eq $null) { + throw "invalid value for 'PhonePlan', 'PhonePlan' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "complianceAddress" = ${ComplianceAddress} + "emergencyAddress" = ${EmergencyAddress} + "phoneNumber" = ${PhoneNumber} + "phoneCountry" = ${PhoneCountry} + "phonePlan" = ${PhonePlan} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PhoneNumberDto + +.DESCRIPTION + +Convert from JSON to PhoneNumberDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +PhoneNumberDto +#> +function ConvertFrom-JsonToPhoneNumberDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PhoneNumberDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PhoneNumberDto + $AllProperties = ("id", "userId", "complianceAddress", "emergencyAddress", "phoneNumber", "phoneCountry", "phonePlan", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneCountry"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneCountry' missing." + } else { + $PhoneCountry = $JsonParameters.PSobject.Properties["phoneCountry"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phonePlan"))) { + throw "Error! JSON cannot be serialized due to the required property 'phonePlan' missing." + } else { + $PhonePlan = $JsonParameters.PSobject.Properties["phonePlan"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "complianceAddress"))) { #optional property not found + $ComplianceAddress = $null + } else { + $ComplianceAddress = $JsonParameters.PSobject.Properties["complianceAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emergencyAddress"))) { #optional property not found + $EmergencyAddress = $null + } else { + $EmergencyAddress = $JsonParameters.PSobject.Properties["emergencyAddress"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "complianceAddress" = ${ComplianceAddress} + "emergencyAddress" = ${EmergencyAddress} + "phoneNumber" = ${PhoneNumber} + "phoneCountry" = ${PhoneCountry} + "phonePlan" = ${PhonePlan} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PhoneNumberProjection.ps1 b/src/maislurp-client-powershell/Model/PhoneNumberProjection.ps1 new file mode 100644 index 00000000..85245cd5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PhoneNumberProjection.ps1 @@ -0,0 +1,175 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Phone number projection + +.PARAMETER UserId +No description available. +.PARAMETER PhoneNumber +No description available. +.PARAMETER PhoneCountry +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +PhoneNumberProjection +#> + +function Initialize-PhoneNumberProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("US", "GB", "AU")] + [String] + ${PhoneCountry}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PhoneNumberProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($PhoneCountry -eq $null) { + throw "invalid value for 'PhoneCountry', 'PhoneCountry' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "phoneCountry" = ${PhoneCountry} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PhoneNumberProjection + +.DESCRIPTION + +Convert from JSON to PhoneNumberProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +PhoneNumberProjection +#> +function ConvertFrom-JsonToPhoneNumberProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PhoneNumberProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PhoneNumberProjection + $AllProperties = ("userId", "phoneNumber", "phoneCountry", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'userId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneCountry"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneCountry' missing." + } else { + $PhoneCountry = $JsonParameters.PSobject.Properties["phoneCountry"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "phoneCountry" = ${PhoneCountry} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/PhonePlanDto.ps1 b/src/maislurp-client-powershell/Model/PhonePlanDto.ps1 new file mode 100644 index 00000000..e4b6e204 --- /dev/null +++ b/src/maislurp-client-powershell/Model/PhonePlanDto.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER PhoneCountry +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +PhonePlanDto +#> + +function Initialize-PhonePlanDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("US", "GB", "AU")] + [String] + ${PhoneCountry}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => PhonePlanDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneCountry -eq $null) { + throw "invalid value for 'PhoneCountry', 'PhoneCountry' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "phoneCountry" = ${PhoneCountry} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to PhonePlanDto + +.DESCRIPTION + +Convert from JSON to PhonePlanDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +PhonePlanDto +#> +function ConvertFrom-JsonToPhonePlanDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => PhonePlanDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in PhonePlanDto + $AllProperties = ("id", "userId", "phoneCountry", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneCountry"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneCountry' missing." + } else { + $PhoneCountry = $JsonParameters.PSobject.Properties["phoneCountry"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "phoneCountry" = ${PhoneCountry} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/RawEmailJson.ps1 b/src/maislurp-client-powershell/Model/RawEmailJson.ps1 new file mode 100644 index 00000000..5122f2c7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/RawEmailJson.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Content in raw format + +.PARAMETER Content +No description available. +.OUTPUTS + +RawEmailJson +#> + +function Initialize-RawEmailJson { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Content} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => RawEmailJson' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Content -eq $null) { + throw "invalid value for 'Content', 'Content' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to RawEmailJson + +.DESCRIPTION + +Convert from JSON to RawEmailJson + +.PARAMETER Json + +Json object + +.OUTPUTS + +RawEmailJson +#> +function ConvertFrom-JsonToRawEmailJson { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => RawEmailJson' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in RawEmailJson + $AllProperties = ("content") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'content' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { + throw "Error! JSON cannot be serialized due to the required property 'content' missing." + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + $PSO = [PSCustomObject]@{ + "content" = ${Content} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/Recipient.ps1 b/src/maislurp-client-powershell/Model/Recipient.ps1 new file mode 100644 index 00000000..d75b9c15 --- /dev/null +++ b/src/maislurp-client-powershell/Model/Recipient.ps1 @@ -0,0 +1,136 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email recipient + +.PARAMETER RawValue +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER Name +No description available. +.OUTPUTS + +Recipient +#> + +function Initialize-Recipient { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${RawValue}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => Recipient' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($RawValue -eq $null) { + throw "invalid value for 'RawValue', 'RawValue' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "rawValue" = ${RawValue} + "emailAddress" = ${EmailAddress} + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to Recipient + +.DESCRIPTION + +Convert from JSON to Recipient + +.PARAMETER Json + +Json object + +.OUTPUTS + +Recipient +#> +function ConvertFrom-JsonToRecipient { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => Recipient' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in Recipient + $AllProperties = ("rawValue", "emailAddress", "name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'rawValue' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rawValue"))) { + throw "Error! JSON cannot be serialized due to the required property 'rawValue' missing." + } else { + $RawValue = $JsonParameters.PSobject.Properties["rawValue"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "rawValue" = ${RawValue} + "emailAddress" = ${EmailAddress} + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ReplyForSms.ps1 b/src/maislurp-client-powershell/Model/ReplyForSms.ps1 new file mode 100644 index 00000000..c7b41f8b --- /dev/null +++ b/src/maislurp-client-powershell/Model/ReplyForSms.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Reply +No description available. +.OUTPUTS + +ReplyForSms +#> + +function Initialize-ReplyForSms { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Reply} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ReplyForSms' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "reply" = ${Reply} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ReplyForSms + +.DESCRIPTION + +Convert from JSON to ReplyForSms + +.PARAMETER Json + +Json object + +.OUTPUTS + +ReplyForSms +#> +function ConvertFrom-JsonToReplyForSms { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ReplyForSms' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ReplyForSms + $AllProperties = ("reply") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reply"))) { #optional property not found + $Reply = $null + } else { + $Reply = $JsonParameters.PSobject.Properties["reply"].value + } + + $PSO = [PSCustomObject]@{ + "reply" = ${Reply} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ReplyToAliasEmailOptions.ps1 b/src/maislurp-client-powershell/Model/ReplyToAliasEmailOptions.ps1 new file mode 100644 index 00000000..946e51ee --- /dev/null +++ b/src/maislurp-client-powershell/Model/ReplyToAliasEmailOptions.ps1 @@ -0,0 +1,228 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for replying to an alias email using the alias inbox + +.PARAMETER Body +Body of the reply email you want to send +.PARAMETER IsHTML +Is the reply HTML +.PARAMETER Charset +The charset that your message should be sent with. Optional. Default is UTF-8 +.PARAMETER Attachments +List of uploaded attachments to send with the reply. Optional. +.PARAMETER TemplateVariables +Template variables if using a template +.PARAMETER Template +Template ID to use instead of body. Will use template variable map to fill defined variable slots. +.PARAMETER SendStrategy +How an email should be sent based on its recipients +.PARAMETER CustomHeaders +Optional custom headers +.PARAMETER UseInboxName +Optionally use inbox name as display name for sender email address +.PARAMETER Html +No description available. +.OUTPUTS + +ReplyToAliasEmailOptions +#> + +function Initialize-ReplyToAliasEmailOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsHTML}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Template}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SINGLE_MESSAGE")] + [String] + ${SendStrategy}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${CustomHeaders}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseInboxName}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Html} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ReplyToAliasEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($IsHTML -eq $null) { + throw "invalid value for 'IsHTML', 'IsHTML' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "body" = ${Body} + "isHTML" = ${IsHTML} + "charset" = ${Charset} + "attachments" = ${Attachments} + "templateVariables" = ${TemplateVariables} + "template" = ${Template} + "sendStrategy" = ${SendStrategy} + "customHeaders" = ${CustomHeaders} + "useInboxName" = ${UseInboxName} + "html" = ${Html} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ReplyToAliasEmailOptions + +.DESCRIPTION + +Convert from JSON to ReplyToAliasEmailOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ReplyToAliasEmailOptions +#> +function ConvertFrom-JsonToReplyToAliasEmailOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ReplyToAliasEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ReplyToAliasEmailOptions + $AllProperties = ("body", "isHTML", "charset", "attachments", "templateVariables", "template", "sendStrategy", "customHeaders", "useInboxName", "html") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'body' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { + throw "Error! JSON cannot be serialized due to the required property 'isHTML' missing." + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "template"))) { #optional property not found + $Template = $null + } else { + $Template = $JsonParameters.PSobject.Properties["template"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sendStrategy"))) { #optional property not found + $SendStrategy = $null + } else { + $SendStrategy = $JsonParameters.PSobject.Properties["sendStrategy"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "customHeaders"))) { #optional property not found + $CustomHeaders = $null + } else { + $CustomHeaders = $JsonParameters.PSobject.Properties["customHeaders"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useInboxName"))) { #optional property not found + $UseInboxName = $null + } else { + $UseInboxName = $JsonParameters.PSobject.Properties["useInboxName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { #optional property not found + $Html = $null + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + $PSO = [PSCustomObject]@{ + "body" = ${Body} + "isHTML" = ${IsHTML} + "charset" = ${Charset} + "attachments" = ${Attachments} + "templateVariables" = ${TemplateVariables} + "template" = ${Template} + "sendStrategy" = ${SendStrategy} + "customHeaders" = ${CustomHeaders} + "useInboxName" = ${UseInboxName} + "html" = ${Html} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ReplyToEmailOptions.ps1 b/src/maislurp-client-powershell/Model/ReplyToEmailOptions.ps1 new file mode 100644 index 00000000..aac158a3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ReplyToEmailOptions.ps1 @@ -0,0 +1,254 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for replying to email with API + +.PARAMETER Body +Body of the reply email you want to send +.PARAMETER IsHTML +Is the reply HTML +.PARAMETER VarFrom +The from header that should be used. Optional +.PARAMETER ReplyTo +The replyTo header that should be used. Optional +.PARAMETER CustomHeaders +Optional custom headers +.PARAMETER Charset +The charset that your message should be sent with. Optional. Default is UTF-8 +.PARAMETER Attachments +List of uploaded attachments to send with the reply. Optional. +.PARAMETER TemplateVariables +Template variables if using a template +.PARAMETER Template +Template ID to use instead of body. Will use template variable map to fill defined variable slots. +.PARAMETER SendStrategy +How an email should be sent based on its recipients +.PARAMETER UseInboxName +Optionally use inbox name as display name for sender email address +.PARAMETER Html +No description available. +.OUTPUTS + +ReplyToEmailOptions +#> + +function Initialize-ReplyToEmailOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsHTML}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${CustomHeaders}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Template}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SINGLE_MESSAGE")] + [String] + ${SendStrategy}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseInboxName}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Html} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ReplyToEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($IsHTML -eq $null) { + throw "invalid value for 'IsHTML', 'IsHTML' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "body" = ${Body} + "isHTML" = ${IsHTML} + "from" = ${VarFrom} + "replyTo" = ${ReplyTo} + "customHeaders" = ${CustomHeaders} + "charset" = ${Charset} + "attachments" = ${Attachments} + "templateVariables" = ${TemplateVariables} + "template" = ${Template} + "sendStrategy" = ${SendStrategy} + "useInboxName" = ${UseInboxName} + "html" = ${Html} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ReplyToEmailOptions + +.DESCRIPTION + +Convert from JSON to ReplyToEmailOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ReplyToEmailOptions +#> +function ConvertFrom-JsonToReplyToEmailOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ReplyToEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ReplyToEmailOptions + $AllProperties = ("body", "isHTML", "from", "replyTo", "customHeaders", "charset", "attachments", "templateVariables", "template", "sendStrategy", "useInboxName", "html") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'body' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { + throw "Error! JSON cannot be serialized due to the required property 'isHTML' missing." + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "customHeaders"))) { #optional property not found + $CustomHeaders = $null + } else { + $CustomHeaders = $JsonParameters.PSobject.Properties["customHeaders"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "template"))) { #optional property not found + $Template = $null + } else { + $Template = $JsonParameters.PSobject.Properties["template"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sendStrategy"))) { #optional property not found + $SendStrategy = $null + } else { + $SendStrategy = $JsonParameters.PSobject.Properties["sendStrategy"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useInboxName"))) { #optional property not found + $UseInboxName = $null + } else { + $UseInboxName = $JsonParameters.PSobject.Properties["useInboxName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { #optional property not found + $Html = $null + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + $PSO = [PSCustomObject]@{ + "body" = ${Body} + "isHTML" = ${IsHTML} + "from" = ${VarFrom} + "replyTo" = ${ReplyTo} + "customHeaders" = ${CustomHeaders} + "charset" = ${Charset} + "attachments" = ${Attachments} + "templateVariables" = ${TemplateVariables} + "template" = ${Template} + "sendStrategy" = ${SendStrategy} + "useInboxName" = ${UseInboxName} + "html" = ${Html} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ScheduledJob.ps1 b/src/maislurp-client-powershell/Model/ScheduledJob.ps1 new file mode 100644 index 00000000..ddb9e241 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ScheduledJob.ps1 @@ -0,0 +1,260 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER JobId +No description available. +.PARAMETER GroupId +No description available. +.PARAMETER TriggerId +No description available. +.PARAMETER Status +No description available. +.PARAMETER SendAtTimestamp +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +ScheduledJob +#> + +function Initialize-ScheduledJob { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${JobId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${GroupId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${TriggerId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUBMITTED", "COMPLETED", "ABORTED", "FAILED", "CANCELLED")] + [String] + ${Status}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${SendAtTimestamp}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ScheduledJob' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($JobId -eq $null) { + throw "invalid value for 'JobId', 'JobId' cannot be null." + } + + if ($GroupId -eq $null) { + throw "invalid value for 'GroupId', 'GroupId' cannot be null." + } + + if ($TriggerId -eq $null) { + throw "invalid value for 'TriggerId', 'TriggerId' cannot be null." + } + + if ($Status -eq $null) { + throw "invalid value for 'Status', 'Status' cannot be null." + } + + if ($SendAtTimestamp -eq $null) { + throw "invalid value for 'SendAtTimestamp', 'SendAtTimestamp' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "jobId" = ${JobId} + "groupId" = ${GroupId} + "triggerId" = ${TriggerId} + "status" = ${Status} + "sendAtTimestamp" = ${SendAtTimestamp} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ScheduledJob + +.DESCRIPTION + +Convert from JSON to ScheduledJob + +.PARAMETER Json + +Json object + +.OUTPUTS + +ScheduledJob +#> +function ConvertFrom-JsonToScheduledJob { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ScheduledJob' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ScheduledJob + $AllProperties = ("id", "userId", "inboxId", "jobId", "groupId", "triggerId", "status", "sendAtTimestamp", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "jobId"))) { + throw "Error! JSON cannot be serialized due to the required property 'jobId' missing." + } else { + $JobId = $JsonParameters.PSobject.Properties["jobId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "groupId"))) { + throw "Error! JSON cannot be serialized due to the required property 'groupId' missing." + } else { + $GroupId = $JsonParameters.PSobject.Properties["groupId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "triggerId"))) { + throw "Error! JSON cannot be serialized due to the required property 'triggerId' missing." + } else { + $TriggerId = $JsonParameters.PSobject.Properties["triggerId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { + throw "Error! JSON cannot be serialized due to the required property 'status' missing." + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sendAtTimestamp"))) { + throw "Error! JSON cannot be serialized due to the required property 'sendAtTimestamp' missing." + } else { + $SendAtTimestamp = $JsonParameters.PSobject.Properties["sendAtTimestamp"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "jobId" = ${JobId} + "groupId" = ${GroupId} + "triggerId" = ${TriggerId} + "status" = ${Status} + "sendAtTimestamp" = ${SendAtTimestamp} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ScheduledJobDto.ps1 b/src/maislurp-client-powershell/Model/ScheduledJobDto.ps1 new file mode 100644 index 00000000..edb01d86 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ScheduledJobDto.ps1 @@ -0,0 +1,260 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER JobId +No description available. +.PARAMETER GroupId +No description available. +.PARAMETER TriggerId +No description available. +.PARAMETER Status +No description available. +.PARAMETER SendAtTimestamp +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +ScheduledJobDto +#> + +function Initialize-ScheduledJobDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${JobId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${GroupId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${TriggerId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SUBMITTED", "COMPLETED", "ABORTED", "FAILED", "CANCELLED")] + [String] + ${Status}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${SendAtTimestamp}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ScheduledJobDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($JobId -eq $null) { + throw "invalid value for 'JobId', 'JobId' cannot be null." + } + + if ($GroupId -eq $null) { + throw "invalid value for 'GroupId', 'GroupId' cannot be null." + } + + if ($TriggerId -eq $null) { + throw "invalid value for 'TriggerId', 'TriggerId' cannot be null." + } + + if ($Status -eq $null) { + throw "invalid value for 'Status', 'Status' cannot be null." + } + + if ($SendAtTimestamp -eq $null) { + throw "invalid value for 'SendAtTimestamp', 'SendAtTimestamp' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "jobId" = ${JobId} + "groupId" = ${GroupId} + "triggerId" = ${TriggerId} + "status" = ${Status} + "sendAtTimestamp" = ${SendAtTimestamp} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ScheduledJobDto + +.DESCRIPTION + +Convert from JSON to ScheduledJobDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ScheduledJobDto +#> +function ConvertFrom-JsonToScheduledJobDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ScheduledJobDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ScheduledJobDto + $AllProperties = ("id", "userId", "inboxId", "jobId", "groupId", "triggerId", "status", "sendAtTimestamp", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "jobId"))) { + throw "Error! JSON cannot be serialized due to the required property 'jobId' missing." + } else { + $JobId = $JsonParameters.PSobject.Properties["jobId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "groupId"))) { + throw "Error! JSON cannot be serialized due to the required property 'groupId' missing." + } else { + $GroupId = $JsonParameters.PSobject.Properties["groupId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "triggerId"))) { + throw "Error! JSON cannot be serialized due to the required property 'triggerId' missing." + } else { + $TriggerId = $JsonParameters.PSobject.Properties["triggerId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { + throw "Error! JSON cannot be serialized due to the required property 'status' missing." + } else { + $Status = $JsonParameters.PSobject.Properties["status"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sendAtTimestamp"))) { + throw "Error! JSON cannot be serialized due to the required property 'sendAtTimestamp' missing." + } else { + $SendAtTimestamp = $JsonParameters.PSobject.Properties["sendAtTimestamp"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "jobId" = ${JobId} + "groupId" = ${GroupId} + "triggerId" = ${TriggerId} + "status" = ${Status} + "sendAtTimestamp" = ${SendAtTimestamp} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SearchEmailsOptions.ps1 b/src/maislurp-client-powershell/Model/SearchEmailsOptions.ps1 new file mode 100644 index 00000000..076656fc --- /dev/null +++ b/src/maislurp-client-powershell/Model/SearchEmailsOptions.ps1 @@ -0,0 +1,194 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER InboxIds +Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. +.PARAMETER PageIndex +Optional page index in email list pagination +.PARAMETER PageSize +Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results +.PARAMETER SortDirection +Optional createdAt sort direction ASC or DESC +.PARAMETER UnreadOnly +Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly +.PARAMETER SearchFilter +Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body +.PARAMETER Since +Optional filter emails received after given date time +.PARAMETER Before +Optional filter emails received before given date time +.OUTPUTS + +SearchEmailsOptions +#> + +function Initialize-SearchEmailsOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${InboxIds}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${PageIndex}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${PageSize}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ASC", "DESC")] + [String] + ${SortDirection}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${SearchFilter}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Before} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SearchEmailsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($PageSize -and $PageSize -gt 100) { + throw "invalid value for 'PageSize', must be smaller than or equal to 100." + } + + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + "pageIndex" = ${PageIndex} + "pageSize" = ${PageSize} + "sortDirection" = ${SortDirection} + "unreadOnly" = ${UnreadOnly} + "searchFilter" = ${SearchFilter} + "since" = ${Since} + "before" = ${Before} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SearchEmailsOptions + +.DESCRIPTION + +Convert from JSON to SearchEmailsOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SearchEmailsOptions +#> +function ConvertFrom-JsonToSearchEmailsOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SearchEmailsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SearchEmailsOptions + $AllProperties = ("inboxIds", "pageIndex", "pageSize", "sortDirection", "unreadOnly", "searchFilter", "since", "before") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxIds"))) { #optional property not found + $InboxIds = $null + } else { + $InboxIds = $JsonParameters.PSobject.Properties["inboxIds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageIndex"))) { #optional property not found + $PageIndex = $null + } else { + $PageIndex = $JsonParameters.PSobject.Properties["pageIndex"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageSize"))) { #optional property not found + $PageSize = $null + } else { + $PageSize = $JsonParameters.PSobject.Properties["pageSize"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sortDirection"))) { #optional property not found + $SortDirection = $null + } else { + $SortDirection = $JsonParameters.PSobject.Properties["sortDirection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unreadOnly"))) { #optional property not found + $UnreadOnly = $null + } else { + $UnreadOnly = $JsonParameters.PSobject.Properties["unreadOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "searchFilter"))) { #optional property not found + $SearchFilter = $null + } else { + $SearchFilter = $JsonParameters.PSobject.Properties["searchFilter"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found + $Since = $null + } else { + $Since = $JsonParameters.PSobject.Properties["since"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "before"))) { #optional property not found + $Before = $null + } else { + $Before = $JsonParameters.PSobject.Properties["before"].value + } + + $PSO = [PSCustomObject]@{ + "inboxIds" = ${InboxIds} + "pageIndex" = ${PageIndex} + "pageSize" = ${PageSize} + "sortDirection" = ${SortDirection} + "unreadOnly" = ${UnreadOnly} + "searchFilter" = ${SearchFilter} + "since" = ${Since} + "before" = ${Before} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SearchInboxesOptions.ps1 b/src/maislurp-client-powershell/Model/SearchInboxesOptions.ps1 new file mode 100644 index 00000000..afcc2644 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SearchInboxesOptions.ps1 @@ -0,0 +1,231 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PageIndex +Optional page index in list pagination +.PARAMETER PageSize +Optional page size in list pagination +.PARAMETER SortDirection +Optional createdAt sort direction ASC or DESC +.PARAMETER Favourite +Optionally filter results for favourites only +.PARAMETER Search +Optionally filter by search words partial matching ID, tags, name, and email address +.PARAMETER Tag +Optionally filter by tags. Will return inboxes that include given tags +.PARAMETER Since +Optional filter by created after given date time +.PARAMETER Before +Optional filter by created before given date time +.PARAMETER InboxType +Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). +.PARAMETER InboxFunction +Optional filter by inbox function +.PARAMETER DomainId +Optional domain ID filter +.OUTPUTS + +SearchInboxesOptions +#> + +function Initialize-SearchInboxesOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${PageIndex}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${PageSize}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ASC", "DESC")] + [String] + ${SortDirection}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Favourite}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Search}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Tag}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("HTTP_INBOX", "SMTP_INBOX")] + [String] + ${InboxType}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR")] + [String] + ${InboxFunction}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SearchInboxesOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "pageIndex" = ${PageIndex} + "pageSize" = ${PageSize} + "sortDirection" = ${SortDirection} + "favourite" = ${Favourite} + "search" = ${Search} + "tag" = ${Tag} + "since" = ${Since} + "before" = ${Before} + "inboxType" = ${InboxType} + "inboxFunction" = ${InboxFunction} + "domainId" = ${DomainId} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SearchInboxesOptions + +.DESCRIPTION + +Convert from JSON to SearchInboxesOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SearchInboxesOptions +#> +function ConvertFrom-JsonToSearchInboxesOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SearchInboxesOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SearchInboxesOptions + $AllProperties = ("pageIndex", "pageSize", "sortDirection", "favourite", "search", "tag", "since", "before", "inboxType", "inboxFunction", "domainId") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageIndex"))) { #optional property not found + $PageIndex = $null + } else { + $PageIndex = $JsonParameters.PSobject.Properties["pageIndex"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pageSize"))) { #optional property not found + $PageSize = $null + } else { + $PageSize = $JsonParameters.PSobject.Properties["pageSize"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sortDirection"))) { #optional property not found + $SortDirection = $null + } else { + $SortDirection = $JsonParameters.PSobject.Properties["sortDirection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "favourite"))) { #optional property not found + $Favourite = $null + } else { + $Favourite = $JsonParameters.PSobject.Properties["favourite"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "search"))) { #optional property not found + $Search = $null + } else { + $Search = $JsonParameters.PSobject.Properties["search"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tag"))) { #optional property not found + $Tag = $null + } else { + $Tag = $JsonParameters.PSobject.Properties["tag"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found + $Since = $null + } else { + $Since = $JsonParameters.PSobject.Properties["since"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "before"))) { #optional property not found + $Before = $null + } else { + $Before = $JsonParameters.PSobject.Properties["before"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxType"))) { #optional property not found + $InboxType = $null + } else { + $InboxType = $JsonParameters.PSobject.Properties["inboxType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxFunction"))) { #optional property not found + $InboxFunction = $null + } else { + $InboxFunction = $JsonParameters.PSobject.Properties["inboxFunction"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + $PSO = [PSCustomObject]@{ + "pageIndex" = ${PageIndex} + "pageSize" = ${PageSize} + "sortDirection" = ${SortDirection} + "favourite" = ${Favourite} + "search" = ${Search} + "tag" = ${Tag} + "since" = ${Since} + "before" = ${Before} + "inboxType" = ${InboxType} + "inboxFunction" = ${InboxFunction} + "domainId" = ${DomainId} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SendEmailBodyPart.ps1 b/src/maislurp-client-powershell/Model/SendEmailBodyPart.ps1 new file mode 100644 index 00000000..b0f8da39 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SendEmailBodyPart.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email body content parts for multipart mime message. Will override body. + +.PARAMETER ContentType +No description available. +.PARAMETER ContentBody +No description available. +.OUTPUTS + +SendEmailBodyPart +#> + +function Initialize-SendEmailBodyPart { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentBody} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SendEmailBodyPart' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ContentType -eq $null) { + throw "invalid value for 'ContentType', 'ContentType' cannot be null." + } + + if ($ContentBody -eq $null) { + throw "invalid value for 'ContentBody', 'ContentBody' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "contentType" = ${ContentType} + "contentBody" = ${ContentBody} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SendEmailBodyPart + +.DESCRIPTION + +Convert from JSON to SendEmailBodyPart + +.PARAMETER Json + +Json object + +.OUTPUTS + +SendEmailBodyPart +#> +function ConvertFrom-JsonToSendEmailBodyPart { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SendEmailBodyPart' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SendEmailBodyPart + $AllProperties = ("contentType", "contentBody") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'contentType' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentType' missing." + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentBody"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentBody' missing." + } else { + $ContentBody = $JsonParameters.PSobject.Properties["contentBody"].value + } + + $PSO = [PSCustomObject]@{ + "contentType" = ${ContentType} + "contentBody" = ${ContentBody} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SendEmailOptions.ps1 b/src/maislurp-client-powershell/Model/SendEmailOptions.ps1 new file mode 100644 index 00000000..09c1e107 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SendEmailOptions.ps1 @@ -0,0 +1,399 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for the email to be sent + +.PARAMETER ToContacts +Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. +.PARAMETER ToGroup +Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients +.PARAMETER To +List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. +.PARAMETER VarFrom +Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox `). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name `. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used. +.PARAMETER Cc +Optional list of cc destination email addresses +.PARAMETER Bcc +Optional list of bcc destination email addresses +.PARAMETER Subject +Optional email subject line +.PARAMETER ReplyTo +Optional replyTo header +.PARAMETER CustomHeaders +Optional custom headers +.PARAMETER Body +Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. +.PARAMETER Html +Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) +.PARAMETER IsHTML +Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients +.PARAMETER Charset +Optional charset +.PARAMETER Attachments +Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. +.PARAMETER TemplateVariables +Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. +.PARAMETER Template +Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. +.PARAMETER SendStrategy +How an email should be sent based on its recipients +.PARAMETER UseInboxName +Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name ` if the inbox has a name. +.PARAMETER AddTrackingPixel +Add tracking pixel to email +.PARAMETER FilterBouncedRecipients +Filter recipients to remove any bounced recipients from to, bcc, and cc before sending +.PARAMETER ValidateEmailAddresses +Validate recipient email addresses before sending +.PARAMETER IgnoreEmptyRecipients +Ignore empty recipients after validation removes all recipients as invalid and fail silently +.PARAMETER IsXAmpHtml +Is content AMP4EMAIL compatible. If set will send as x-amp-html part. +.PARAMETER BodyParts +Email body content parts for multipart mime message. Will override body. +.OUTPUTS + +SendEmailOptions +#> + +function Initialize-SendEmailOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ToContacts}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ToGroup}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${CustomHeaders}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Html}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsHTML}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [String] + ${Template}, + [Parameter(Position = 16, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SINGLE_MESSAGE")] + [String] + ${SendStrategy}, + [Parameter(Position = 17, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseInboxName}, + [Parameter(Position = 18, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${AddTrackingPixel}, + [Parameter(Position = 19, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${FilterBouncedRecipients}, + [Parameter(Position = 20, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("VALIDATE_FILTER_REMOVE_INVALID", "VALIDATE_ERROR_IF_INVALID", "NO_VALIDATION")] + [String] + ${ValidateEmailAddresses}, + [Parameter(Position = 21, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IgnoreEmptyRecipients}, + [Parameter(Position = 22, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsXAmpHtml}, + [Parameter(Position = 23, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${BodyParts} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SendEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "toContacts" = ${ToContacts} + "toGroup" = ${ToGroup} + "to" = ${To} + "from" = ${VarFrom} + "cc" = ${Cc} + "bcc" = ${Bcc} + "subject" = ${Subject} + "replyTo" = ${ReplyTo} + "customHeaders" = ${CustomHeaders} + "body" = ${Body} + "html" = ${Html} + "isHTML" = ${IsHTML} + "charset" = ${Charset} + "attachments" = ${Attachments} + "templateVariables" = ${TemplateVariables} + "template" = ${Template} + "sendStrategy" = ${SendStrategy} + "useInboxName" = ${UseInboxName} + "addTrackingPixel" = ${AddTrackingPixel} + "filterBouncedRecipients" = ${FilterBouncedRecipients} + "validateEmailAddresses" = ${ValidateEmailAddresses} + "ignoreEmptyRecipients" = ${IgnoreEmptyRecipients} + "isXAmpHtml" = ${IsXAmpHtml} + "bodyParts" = ${BodyParts} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SendEmailOptions + +.DESCRIPTION + +Convert from JSON to SendEmailOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SendEmailOptions +#> +function ConvertFrom-JsonToSendEmailOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SendEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SendEmailOptions + $AllProperties = ("toContacts", "toGroup", "to", "from", "cc", "bcc", "subject", "replyTo", "customHeaders", "body", "html", "isHTML", "charset", "attachments", "templateVariables", "template", "sendStrategy", "useInboxName", "addTrackingPixel", "filterBouncedRecipients", "validateEmailAddresses", "ignoreEmptyRecipients", "isXAmpHtml", "bodyParts") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "toContacts"))) { #optional property not found + $ToContacts = $null + } else { + $ToContacts = $JsonParameters.PSobject.Properties["toContacts"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "toGroup"))) { #optional property not found + $ToGroup = $null + } else { + $ToGroup = $JsonParameters.PSobject.Properties["toGroup"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { #optional property not found + $To = $null + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "customHeaders"))) { #optional property not found + $CustomHeaders = $null + } else { + $CustomHeaders = $JsonParameters.PSobject.Properties["customHeaders"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { #optional property not found + $Html = $null + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { #optional property not found + $IsHTML = $null + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "template"))) { #optional property not found + $Template = $null + } else { + $Template = $JsonParameters.PSobject.Properties["template"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sendStrategy"))) { #optional property not found + $SendStrategy = $null + } else { + $SendStrategy = $JsonParameters.PSobject.Properties["sendStrategy"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useInboxName"))) { #optional property not found + $UseInboxName = $null + } else { + $UseInboxName = $JsonParameters.PSobject.Properties["useInboxName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "addTrackingPixel"))) { #optional property not found + $AddTrackingPixel = $null + } else { + $AddTrackingPixel = $JsonParameters.PSobject.Properties["addTrackingPixel"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "filterBouncedRecipients"))) { #optional property not found + $FilterBouncedRecipients = $null + } else { + $FilterBouncedRecipients = $JsonParameters.PSobject.Properties["filterBouncedRecipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "validateEmailAddresses"))) { #optional property not found + $ValidateEmailAddresses = $null + } else { + $ValidateEmailAddresses = $JsonParameters.PSobject.Properties["validateEmailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreEmptyRecipients"))) { #optional property not found + $IgnoreEmptyRecipients = $null + } else { + $IgnoreEmptyRecipients = $JsonParameters.PSobject.Properties["ignoreEmptyRecipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isXAmpHtml"))) { #optional property not found + $IsXAmpHtml = $null + } else { + $IsXAmpHtml = $JsonParameters.PSobject.Properties["isXAmpHtml"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyParts"))) { #optional property not found + $BodyParts = $null + } else { + $BodyParts = $JsonParameters.PSobject.Properties["bodyParts"].value + } + + $PSO = [PSCustomObject]@{ + "toContacts" = ${ToContacts} + "toGroup" = ${ToGroup} + "to" = ${To} + "from" = ${VarFrom} + "cc" = ${Cc} + "bcc" = ${Bcc} + "subject" = ${Subject} + "replyTo" = ${ReplyTo} + "customHeaders" = ${CustomHeaders} + "body" = ${Body} + "html" = ${Html} + "isHTML" = ${IsHTML} + "charset" = ${Charset} + "attachments" = ${Attachments} + "templateVariables" = ${TemplateVariables} + "template" = ${Template} + "sendStrategy" = ${SendStrategy} + "useInboxName" = ${UseInboxName} + "addTrackingPixel" = ${AddTrackingPixel} + "filterBouncedRecipients" = ${FilterBouncedRecipients} + "validateEmailAddresses" = ${ValidateEmailAddresses} + "ignoreEmptyRecipients" = ${IgnoreEmptyRecipients} + "isXAmpHtml" = ${IsXAmpHtml} + "bodyParts" = ${BodyParts} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SendSMTPEnvelopeOptions.ps1 b/src/maislurp-client-powershell/Model/SendSMTPEnvelopeOptions.ps1 new file mode 100644 index 00000000..58682198 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SendSMTPEnvelopeOptions.ps1 @@ -0,0 +1,140 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for the email envelope + +.PARAMETER RcptTo +No description available. +.PARAMETER MailFrom +No description available. +.PARAMETER VarData +No description available. +.OUTPUTS + +SendSMTPEnvelopeOptions +#> + +function Initialize-SendSMTPEnvelopeOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${RcptTo}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${MailFrom}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarData} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SendSMTPEnvelopeOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($RcptTo -eq $null) { + throw "invalid value for 'RcptTo', 'RcptTo' cannot be null." + } + + if ($MailFrom -eq $null) { + throw "invalid value for 'MailFrom', 'MailFrom' cannot be null." + } + + if ($VarData -eq $null) { + throw "invalid value for 'VarData', 'VarData' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "rcptTo" = ${RcptTo} + "mailFrom" = ${MailFrom} + "data" = ${VarData} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SendSMTPEnvelopeOptions + +.DESCRIPTION + +Convert from JSON to SendSMTPEnvelopeOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SendSMTPEnvelopeOptions +#> +function ConvertFrom-JsonToSendSMTPEnvelopeOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SendSMTPEnvelopeOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SendSMTPEnvelopeOptions + $AllProperties = ("rcptTo", "mailFrom", "data") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'rcptTo' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "rcptTo"))) { + throw "Error! JSON cannot be serialized due to the required property 'rcptTo' missing." + } else { + $RcptTo = $JsonParameters.PSobject.Properties["rcptTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mailFrom"))) { + throw "Error! JSON cannot be serialized due to the required property 'mailFrom' missing." + } else { + $MailFrom = $JsonParameters.PSobject.Properties["mailFrom"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "data"))) { + throw "Error! JSON cannot be serialized due to the required property 'data' missing." + } else { + $VarData = $JsonParameters.PSobject.Properties["data"].value + } + + $PSO = [PSCustomObject]@{ + "rcptTo" = ${RcptTo} + "mailFrom" = ${MailFrom} + "data" = ${VarData} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SendWithQueueResult.ps1 b/src/maislurp-client-powershell/Model/SendWithQueueResult.ps1 new file mode 100644 index 00000000..e7f94c0c --- /dev/null +++ b/src/maislurp-client-powershell/Model/SendWithQueueResult.ps1 @@ -0,0 +1,243 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER Subject +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER HeaderId +No description available. +.PARAMETER Delivered +No description available. +.PARAMETER ExceptionName +No description available. +.PARAMETER Message +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +SendWithQueueResult +#> + +function Initialize-SendWithQueueResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${HeaderId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Delivered}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ExceptionName}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SendWithQueueResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($HeaderId -eq $null) { + throw "invalid value for 'HeaderId', 'HeaderId' cannot be null." + } + + if ($Delivered -eq $null) { + throw "invalid value for 'Delivered', 'Delivered' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "subject" = ${Subject} + "inboxId" = ${InboxId} + "headerId" = ${HeaderId} + "delivered" = ${Delivered} + "exceptionName" = ${ExceptionName} + "message" = ${Message} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SendWithQueueResult + +.DESCRIPTION + +Convert from JSON to SendWithQueueResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +SendWithQueueResult +#> +function ConvertFrom-JsonToSendWithQueueResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SendWithQueueResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SendWithQueueResult + $AllProperties = ("id", "userId", "subject", "inboxId", "headerId", "delivered", "exceptionName", "message", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "headerId"))) { + throw "Error! JSON cannot be serialized due to the required property 'headerId' missing." + } else { + $HeaderId = $JsonParameters.PSobject.Properties["headerId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "delivered"))) { + throw "Error! JSON cannot be serialized due to the required property 'delivered' missing." + } else { + $Delivered = $JsonParameters.PSobject.Properties["delivered"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "exceptionName"))) { #optional property not found + $ExceptionName = $null + } else { + $ExceptionName = $JsonParameters.PSobject.Properties["exceptionName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "subject" = ${Subject} + "inboxId" = ${InboxId} + "headerId" = ${HeaderId} + "delivered" = ${Delivered} + "exceptionName" = ${ExceptionName} + "message" = ${Message} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SentEmailDto.ps1 b/src/maislurp-client-powershell/Model/SentEmailDto.ps1 new file mode 100644 index 00000000..97ac0a98 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SentEmailDto.ps1 @@ -0,0 +1,443 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Sent email details + +.PARAMETER Id +ID of sent email +.PARAMETER UserId +User ID +.PARAMETER InboxId +Inbox ID email was sent from +.PARAMETER DomainId +Domain ID +.PARAMETER To +Recipients email was sent to +.PARAMETER VarFrom +Sent from address +.PARAMETER ReplyTo +No description available. +.PARAMETER Cc +No description available. +.PARAMETER Bcc +No description available. +.PARAMETER Attachments +Array of IDs of attachments that were sent with this email +.PARAMETER Subject +No description available. +.PARAMETER BodyMD5Hash +MD5 Hash +.PARAMETER Body +Sent email body +.PARAMETER ToContacts +No description available. +.PARAMETER ToGroup +No description available. +.PARAMETER Charset +No description available. +.PARAMETER IsHTML +No description available. +.PARAMETER SentAt +No description available. +.PARAMETER PixelIds +No description available. +.PARAMETER MessageId +No description available. +.PARAMETER MessageIds +No description available. +.PARAMETER VirtualSend +No description available. +.PARAMETER TemplateId +No description available. +.PARAMETER TemplateVariables +No description available. +.PARAMETER Headers +No description available. +.PARAMETER Html +No description available. +.OUTPUTS + +SentEmailDto +#> + +function Initialize-SentEmailDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyMD5Hash}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ToContacts}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [String] + ${ToGroup}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 16, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsHTML}, + [Parameter(Position = 17, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${SentAt}, + [Parameter(Position = 18, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${PixelIds}, + [Parameter(Position = 19, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 20, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${MessageIds}, + [Parameter(Position = 21, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${VirtualSend}, + [Parameter(Position = 22, ValueFromPipelineByPropertyName = $true)] + [String] + ${TemplateId}, + [Parameter(Position = 23, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables}, + [Parameter(Position = 24, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${Headers}, + [Parameter(Position = 25, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Html} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SentEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($SentAt -eq $null) { + throw "invalid value for 'SentAt', 'SentAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "domainId" = ${DomainId} + "to" = ${To} + "from" = ${VarFrom} + "replyTo" = ${ReplyTo} + "cc" = ${Cc} + "bcc" = ${Bcc} + "attachments" = ${Attachments} + "subject" = ${Subject} + "bodyMD5Hash" = ${BodyMD5Hash} + "body" = ${Body} + "toContacts" = ${ToContacts} + "toGroup" = ${ToGroup} + "charset" = ${Charset} + "isHTML" = ${IsHTML} + "sentAt" = ${SentAt} + "pixelIds" = ${PixelIds} + "messageId" = ${MessageId} + "messageIds" = ${MessageIds} + "virtualSend" = ${VirtualSend} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + "headers" = ${Headers} + "html" = ${Html} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SentEmailDto + +.DESCRIPTION + +Convert from JSON to SentEmailDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +SentEmailDto +#> +function ConvertFrom-JsonToSentEmailDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SentEmailDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SentEmailDto + $AllProperties = ("id", "userId", "inboxId", "domainId", "to", "from", "replyTo", "cc", "bcc", "attachments", "subject", "bodyMD5Hash", "body", "toContacts", "toGroup", "charset", "isHTML", "sentAt", "pixelIds", "messageId", "messageIds", "virtualSend", "templateId", "templateVariables", "headers", "html") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'sentAt' missing." + } else { + $SentAt = $JsonParameters.PSobject.Properties["sentAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { #optional property not found + $To = $null + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { #optional property not found + $Attachments = $null + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyMD5Hash"))) { #optional property not found + $BodyMD5Hash = $null + } else { + $BodyMD5Hash = $JsonParameters.PSobject.Properties["bodyMD5Hash"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "toContacts"))) { #optional property not found + $ToContacts = $null + } else { + $ToContacts = $JsonParameters.PSobject.Properties["toContacts"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "toGroup"))) { #optional property not found + $ToGroup = $null + } else { + $ToGroup = $JsonParameters.PSobject.Properties["toGroup"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { #optional property not found + $IsHTML = $null + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pixelIds"))) { #optional property not found + $PixelIds = $null + } else { + $PixelIds = $JsonParameters.PSobject.Properties["pixelIds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { #optional property not found + $MessageId = $null + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageIds"))) { #optional property not found + $MessageIds = $null + } else { + $MessageIds = $JsonParameters.PSobject.Properties["messageIds"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virtualSend"))) { #optional property not found + $VirtualSend = $null + } else { + $VirtualSend = $JsonParameters.PSobject.Properties["virtualSend"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateId"))) { #optional property not found + $TemplateId = $null + } else { + $TemplateId = $JsonParameters.PSobject.Properties["templateId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "headers"))) { #optional property not found + $Headers = $null + } else { + $Headers = $JsonParameters.PSobject.Properties["headers"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { #optional property not found + $Html = $null + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "inboxId" = ${InboxId} + "domainId" = ${DomainId} + "to" = ${To} + "from" = ${VarFrom} + "replyTo" = ${ReplyTo} + "cc" = ${Cc} + "bcc" = ${Bcc} + "attachments" = ${Attachments} + "subject" = ${Subject} + "bodyMD5Hash" = ${BodyMD5Hash} + "body" = ${Body} + "toContacts" = ${ToContacts} + "toGroup" = ${ToGroup} + "charset" = ${Charset} + "isHTML" = ${IsHTML} + "sentAt" = ${SentAt} + "pixelIds" = ${PixelIds} + "messageId" = ${MessageId} + "messageIds" = ${MessageIds} + "virtualSend" = ${VirtualSend} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + "headers" = ${Headers} + "html" = ${Html} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SentEmailProjection.ps1 b/src/maislurp-client-powershell/Model/SentEmailProjection.ps1 new file mode 100644 index 00000000..7813eccb --- /dev/null +++ b/src/maislurp-client-powershell/Model/SentEmailProjection.ps1 @@ -0,0 +1,281 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER VarFrom +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Attachments +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER To +No description available. +.PARAMETER Bcc +No description available. +.PARAMETER Cc +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER BodyMD5Hash +No description available. +.PARAMETER VirtualSend +No description available. +.OUTPUTS + +SentEmailProjection +#> + +function Initialize-SentEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Attachments}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${BodyMD5Hash}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${VirtualSend} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SentEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Attachments -eq $null) { + throw "invalid value for 'Attachments', 'Attachments' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + if ($Bcc -eq $null) { + throw "invalid value for 'Bcc', 'Bcc' cannot be null." + } + + if ($Cc -eq $null) { + throw "invalid value for 'Cc', 'Cc' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($VirtualSend -eq $null) { + throw "invalid value for 'VirtualSend', 'VirtualSend' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "from" = ${VarFrom} + "subject" = ${Subject} + "attachments" = ${Attachments} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "to" = ${To} + "bcc" = ${Bcc} + "cc" = ${Cc} + "createdAt" = ${CreatedAt} + "bodyMD5Hash" = ${BodyMD5Hash} + "virtualSend" = ${VirtualSend} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SentEmailProjection + +.DESCRIPTION + +Convert from JSON to SentEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +SentEmailProjection +#> +function ConvertFrom-JsonToSentEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SentEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SentEmailProjection + $AllProperties = ("id", "from", "subject", "attachments", "inboxId", "userId", "to", "bcc", "cc", "createdAt", "bodyMD5Hash", "virtualSend") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachments"))) { + throw "Error! JSON cannot be serialized due to the required property 'attachments' missing." + } else { + $Attachments = $JsonParameters.PSobject.Properties["attachments"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { + throw "Error! JSON cannot be serialized due to the required property 'bcc' missing." + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { + throw "Error! JSON cannot be serialized due to the required property 'cc' missing." + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "virtualSend"))) { + throw "Error! JSON cannot be serialized due to the required property 'virtualSend' missing." + } else { + $VirtualSend = $JsonParameters.PSobject.Properties["virtualSend"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bodyMD5Hash"))) { #optional property not found + $BodyMD5Hash = $null + } else { + $BodyMD5Hash = $JsonParameters.PSobject.Properties["bodyMD5Hash"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "from" = ${VarFrom} + "subject" = ${Subject} + "attachments" = ${Attachments} + "inboxId" = ${InboxId} + "userId" = ${UserId} + "to" = ${To} + "bcc" = ${Bcc} + "cc" = ${Cc} + "createdAt" = ${CreatedAt} + "bodyMD5Hash" = ${BodyMD5Hash} + "virtualSend" = ${VirtualSend} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SentSmsDto.ps1 b/src/maislurp-client-powershell/Model/SentSmsDto.ps1 new file mode 100644 index 00000000..b95eb69b --- /dev/null +++ b/src/maislurp-client-powershell/Model/SentSmsDto.ps1 @@ -0,0 +1,276 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER PhoneNumber +No description available. +.PARAMETER FromNumber +No description available. +.PARAMETER ToNumber +No description available. +.PARAMETER Body +No description available. +.PARAMETER Sid +No description available. +.PARAMETER ReplyToSid +No description available. +.PARAMETER ReplyToId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +SentSmsDto +#> + +function Initialize-SentSmsDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${FromNumber}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ToNumber}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Sid}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyToSid}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyToId}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SentSmsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($FromNumber -eq $null) { + throw "invalid value for 'FromNumber', 'FromNumber' cannot be null." + } + + if ($ToNumber -eq $null) { + throw "invalid value for 'ToNumber', 'ToNumber' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($Sid -eq $null) { + throw "invalid value for 'Sid', 'Sid' cannot be null." + } + + if ($ReplyToSid -eq $null) { + throw "invalid value for 'ReplyToSid', 'ReplyToSid' cannot be null." + } + + if ($ReplyToId -eq $null) { + throw "invalid value for 'ReplyToId', 'ReplyToId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "toNumber" = ${ToNumber} + "body" = ${Body} + "sid" = ${Sid} + "replyToSid" = ${ReplyToSid} + "replyToId" = ${ReplyToId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SentSmsDto + +.DESCRIPTION + +Convert from JSON to SentSmsDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +SentSmsDto +#> +function ConvertFrom-JsonToSentSmsDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SentSmsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SentSmsDto + $AllProperties = ("id", "userId", "phoneNumber", "fromNumber", "toNumber", "body", "sid", "replyToSid", "replyToId", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fromNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'fromNumber' missing." + } else { + $FromNumber = $JsonParameters.PSobject.Properties["fromNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "toNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'toNumber' missing." + } else { + $ToNumber = $JsonParameters.PSobject.Properties["toNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sid"))) { + throw "Error! JSON cannot be serialized due to the required property 'sid' missing." + } else { + $Sid = $JsonParameters.PSobject.Properties["sid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyToSid"))) { + throw "Error! JSON cannot be serialized due to the required property 'replyToSid' missing." + } else { + $ReplyToSid = $JsonParameters.PSobject.Properties["replyToSid"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyToId"))) { + throw "Error! JSON cannot be serialized due to the required property 'replyToId' missing." + } else { + $ReplyToId = $JsonParameters.PSobject.Properties["replyToId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "toNumber" = ${ToNumber} + "body" = ${Body} + "sid" = ${Sid} + "replyToSid" = ${ReplyToSid} + "replyToId" = ${ReplyToId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ServerEndpoints.ps1 b/src/maislurp-client-powershell/Model/ServerEndpoints.ps1 new file mode 100644 index 00000000..710db206 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ServerEndpoints.ps1 @@ -0,0 +1,157 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER VarHost +No description available. +.PARAMETER Port +No description available. +.PARAMETER Tls +No description available. +.PARAMETER AltPorts +No description available. +.OUTPUTS + +ServerEndpoints +#> + +function Initialize-ServerEndpoints { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarHost}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${Port}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Tls}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int32[]] + ${AltPorts} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ServerEndpoints' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($VarHost -eq $null) { + throw "invalid value for 'VarHost', 'VarHost' cannot be null." + } + + if ($Port -eq $null) { + throw "invalid value for 'Port', 'Port' cannot be null." + } + + if ($Tls -eq $null) { + throw "invalid value for 'Tls', 'Tls' cannot be null." + } + + if ($AltPorts -eq $null) { + throw "invalid value for 'AltPorts', 'AltPorts' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + "port" = ${Port} + "tls" = ${Tls} + "altPorts" = ${AltPorts} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ServerEndpoints + +.DESCRIPTION + +Convert from JSON to ServerEndpoints + +.PARAMETER Json + +Json object + +.OUTPUTS + +ServerEndpoints +#> +function ConvertFrom-JsonToServerEndpoints { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ServerEndpoints' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ServerEndpoints + $AllProperties = ("host", "port", "tls", "altPorts") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'host' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "host"))) { + throw "Error! JSON cannot be serialized due to the required property 'host' missing." + } else { + $VarHost = $JsonParameters.PSobject.Properties["host"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "port"))) { + throw "Error! JSON cannot be serialized due to the required property 'port' missing." + } else { + $Port = $JsonParameters.PSobject.Properties["port"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tls"))) { + throw "Error! JSON cannot be serialized due to the required property 'tls' missing." + } else { + $Tls = $JsonParameters.PSobject.Properties["tls"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "altPorts"))) { + throw "Error! JSON cannot be serialized due to the required property 'altPorts' missing." + } else { + $AltPorts = $JsonParameters.PSobject.Properties["altPorts"].value + } + + $PSO = [PSCustomObject]@{ + "host" = ${VarHost} + "port" = ${Port} + "tls" = ${Tls} + "altPorts" = ${AltPorts} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SetInboxFavouritedOptions.ps1 b/src/maislurp-client-powershell/Model/SetInboxFavouritedOptions.ps1 new file mode 100644 index 00000000..f2369b59 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SetInboxFavouritedOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for setting inbox favourite state + +.PARAMETER State +Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering +.OUTPUTS + +SetInboxFavouritedOptions +#> + +function Initialize-SetInboxFavouritedOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${State} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SetInboxFavouritedOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($State -eq $null) { + throw "invalid value for 'State', 'State' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "state" = ${State} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SetInboxFavouritedOptions + +.DESCRIPTION + +Convert from JSON to SetInboxFavouritedOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SetInboxFavouritedOptions +#> +function ConvertFrom-JsonToSetInboxFavouritedOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SetInboxFavouritedOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SetInboxFavouritedOptions + $AllProperties = ("state") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'state' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "state"))) { + throw "Error! JSON cannot be serialized due to the required property 'state' missing." + } else { + $State = $JsonParameters.PSobject.Properties["state"].value + } + + $PSO = [PSCustomObject]@{ + "state" = ${State} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SimpleSendEmailOptions.ps1 b/src/maislurp-client-powershell/Model/SimpleSendEmailOptions.ps1 new file mode 100644 index 00000000..aa4fee98 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SimpleSendEmailOptions.ps1 @@ -0,0 +1,145 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Simplified send email options + +.PARAMETER SenderId +ID of inbox to send from. If null an inbox will be created for sending +.PARAMETER To +Email address to send to +.PARAMETER Body +Body of the email message. Supports HTML +.PARAMETER Subject +Subject line of the email +.OUTPUTS + +SimpleSendEmailOptions +#> + +function Initialize-SimpleSendEmailOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SenderId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${To}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SimpleSendEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "senderId" = ${SenderId} + "to" = ${To} + "body" = ${Body} + "subject" = ${Subject} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SimpleSendEmailOptions + +.DESCRIPTION + +Convert from JSON to SimpleSendEmailOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SimpleSendEmailOptions +#> +function ConvertFrom-JsonToSimpleSendEmailOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SimpleSendEmailOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SimpleSendEmailOptions + $AllProperties = ("senderId", "to", "body", "subject") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'to' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "senderId"))) { #optional property not found + $SenderId = $null + } else { + $SenderId = $JsonParameters.PSobject.Properties["senderId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + $PSO = [PSCustomObject]@{ + "senderId" = ${SenderId} + "to" = ${To} + "body" = ${Body} + "subject" = ${Subject} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SmsDto.ps1 b/src/maislurp-client-powershell/Model/SmsDto.ps1 new file mode 100644 index 00000000..dd01cc74 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SmsDto.ps1 @@ -0,0 +1,225 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER PhoneNumber +No description available. +.PARAMETER FromNumber +No description available. +.PARAMETER Body +No description available. +.PARAMETER Read +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.OUTPUTS + +SmsDto +#> + +function Initialize-SmsDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${FromNumber}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SmsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($FromNumber -eq $null) { + throw "invalid value for 'FromNumber', 'FromNumber' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "body" = ${Body} + "read" = ${Read} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SmsDto + +.DESCRIPTION + +Convert from JSON to SmsDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +SmsDto +#> +function ConvertFrom-JsonToSmsDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SmsDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SmsDto + $AllProperties = ("id", "userId", "phoneNumber", "fromNumber", "body", "read", "createdAt", "updatedAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fromNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'fromNumber' missing." + } else { + $FromNumber = $JsonParameters.PSobject.Properties["fromNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "body" = ${Body} + "read" = ${Read} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SmsMatchOption.ps1 b/src/maislurp-client-powershell/Model/SmsMatchOption.ps1 new file mode 100644 index 00000000..798ae0a7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SmsMatchOption.ps1 @@ -0,0 +1,142 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for matching SMS messages in a phone number. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `BODY` should `CONTAIN` value. + +.PARAMETER Field +Fields of an SMS object that can be used to filter results +.PARAMETER Should +How the value of the email field specified should be compared to the value given in the match options. +.PARAMETER Value +The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed. +.OUTPUTS + +SmsMatchOption +#> + +function Initialize-SmsMatchOption { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("BODY", "FROM")] + [String] + ${Field}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("MATCH", "CONTAIN", "EQUAL")] + [String] + ${Should}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SmsMatchOption' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Should -eq $null) { + throw "invalid value for 'Should', 'Should' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "field" = ${Field} + "should" = ${Should} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SmsMatchOption + +.DESCRIPTION + +Convert from JSON to SmsMatchOption + +.PARAMETER Json + +Json object + +.OUTPUTS + +SmsMatchOption +#> +function ConvertFrom-JsonToSmsMatchOption { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SmsMatchOption' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SmsMatchOption + $AllProperties = ("field", "should", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'field' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "should"))) { + throw "Error! JSON cannot be serialized due to the required property 'should' missing." + } else { + $Should = $JsonParameters.PSobject.Properties["should"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "field" = ${Field} + "should" = ${Should} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SmsPreview.ps1 b/src/maislurp-client-powershell/Model/SmsPreview.ps1 new file mode 100644 index 00000000..92530535 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SmsPreview.ps1 @@ -0,0 +1,191 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER Body +No description available. +.PARAMETER PhoneNumber +No description available. +.PARAMETER FromNumber +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +SmsPreview +#> + +function Initialize-SmsPreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${FromNumber}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SmsPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($FromNumber -eq $null) { + throw "invalid value for 'FromNumber', 'FromNumber' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "body" = ${Body} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SmsPreview + +.DESCRIPTION + +Convert from JSON to SmsPreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +SmsPreview +#> +function ConvertFrom-JsonToSmsPreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SmsPreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SmsPreview + $AllProperties = ("id", "userId", "body", "phoneNumber", "fromNumber", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fromNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'fromNumber' missing." + } else { + $FromNumber = $JsonParameters.PSobject.Properties["fromNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "body" = ${Body} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SmsProjection.ps1 b/src/maislurp-client-powershell/Model/SmsProjection.ps1 new file mode 100644 index 00000000..d73bd2b3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SmsProjection.ps1 @@ -0,0 +1,208 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +SMS projection + +.PARAMETER UserId +No description available. +.PARAMETER PhoneNumber +No description available. +.PARAMETER FromNumber +No description available. +.PARAMETER Read +No description available. +.PARAMETER Body +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +SmsProjection +#> + +function Initialize-SmsProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${FromNumber}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SmsProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($FromNumber -eq $null) { + throw "invalid value for 'FromNumber', 'FromNumber' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "read" = ${Read} + "body" = ${Body} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SmsProjection + +.DESCRIPTION + +Convert from JSON to SmsProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +SmsProjection +#> +function ConvertFrom-JsonToSmsProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SmsProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SmsProjection + $AllProperties = ("userId", "phoneNumber", "fromNumber", "read", "body", "createdAt", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'userId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fromNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'fromNumber' missing." + } else { + $FromNumber = $JsonParameters.PSobject.Properties["fromNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "fromNumber" = ${FromNumber} + "read" = ${Read} + "body" = ${Body} + "createdAt" = ${CreatedAt} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SmsReplyOptions.ps1 b/src/maislurp-client-powershell/Model/SmsReplyOptions.ps1 new file mode 100644 index 00000000..947288e7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SmsReplyOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Body +No description available. +.OUTPUTS + +SmsReplyOptions +#> + +function Initialize-SmsReplyOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SmsReplyOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "body" = ${Body} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SmsReplyOptions + +.DESCRIPTION + +Convert from JSON to SmsReplyOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +SmsReplyOptions +#> +function ConvertFrom-JsonToSmsReplyOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SmsReplyOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SmsReplyOptions + $AllProperties = ("body") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'body' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + $PSO = [PSCustomObject]@{ + "body" = ${Body} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SmtpAccessDetails.ps1 b/src/maislurp-client-powershell/Model/SmtpAccessDetails.ps1 new file mode 100644 index 00000000..5f6ada35 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SmtpAccessDetails.ps1 @@ -0,0 +1,238 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Access details for inbox using SMTP + +.PARAMETER SecureSmtpServerHost +Secure TLS SMTP server host domain +.PARAMETER SecureSmtpServerPort +Secure TLS SMTP server host port +.PARAMETER SecureSmtpUsername +Secure TLS SMTP username for login +.PARAMETER SecureSmtpPassword +Secure TLS SMTP password for login +.PARAMETER SmtpServerHost +SMTP server host domain +.PARAMETER SmtpServerPort +SMTP server host port +.PARAMETER SmtpUsername +SMTP username for login +.PARAMETER SmtpPassword +SMTP password for login +.PARAMETER MailFromDomain +Mail from domain or SMTP HELO value +.OUTPUTS + +SmtpAccessDetails +#> + +function Initialize-SmtpAccessDetails { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureSmtpServerHost}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${SecureSmtpServerPort}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureSmtpUsername}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${SecureSmtpPassword}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpServerHost}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${SmtpServerPort}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpUsername}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpPassword}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${MailFromDomain} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SmtpAccessDetails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($SecureSmtpServerHost -eq $null) { + throw "invalid value for 'SecureSmtpServerHost', 'SecureSmtpServerHost' cannot be null." + } + + if ($SecureSmtpServerPort -eq $null) { + throw "invalid value for 'SecureSmtpServerPort', 'SecureSmtpServerPort' cannot be null." + } + + if ($SecureSmtpUsername -eq $null) { + throw "invalid value for 'SecureSmtpUsername', 'SecureSmtpUsername' cannot be null." + } + + if ($SecureSmtpPassword -eq $null) { + throw "invalid value for 'SecureSmtpPassword', 'SecureSmtpPassword' cannot be null." + } + + if ($SmtpServerHost -eq $null) { + throw "invalid value for 'SmtpServerHost', 'SmtpServerHost' cannot be null." + } + + if ($SmtpServerPort -eq $null) { + throw "invalid value for 'SmtpServerPort', 'SmtpServerPort' cannot be null." + } + + if ($SmtpUsername -eq $null) { + throw "invalid value for 'SmtpUsername', 'SmtpUsername' cannot be null." + } + + if ($SmtpPassword -eq $null) { + throw "invalid value for 'SmtpPassword', 'SmtpPassword' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "secureSmtpServerHost" = ${SecureSmtpServerHost} + "secureSmtpServerPort" = ${SecureSmtpServerPort} + "secureSmtpUsername" = ${SecureSmtpUsername} + "secureSmtpPassword" = ${SecureSmtpPassword} + "smtpServerHost" = ${SmtpServerHost} + "smtpServerPort" = ${SmtpServerPort} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + "mailFromDomain" = ${MailFromDomain} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SmtpAccessDetails + +.DESCRIPTION + +Convert from JSON to SmtpAccessDetails + +.PARAMETER Json + +Json object + +.OUTPUTS + +SmtpAccessDetails +#> +function ConvertFrom-JsonToSmtpAccessDetails { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SmtpAccessDetails' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SmtpAccessDetails + $AllProperties = ("secureSmtpServerHost", "secureSmtpServerPort", "secureSmtpUsername", "secureSmtpPassword", "smtpServerHost", "smtpServerPort", "smtpUsername", "smtpPassword", "mailFromDomain") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'secureSmtpServerHost' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpServerHost' missing." + } else { + $SecureSmtpServerHost = $JsonParameters.PSobject.Properties["secureSmtpServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpServerPort' missing." + } else { + $SecureSmtpServerPort = $JsonParameters.PSobject.Properties["secureSmtpServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpUsername' missing." + } else { + $SecureSmtpUsername = $JsonParameters.PSobject.Properties["secureSmtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "secureSmtpPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'secureSmtpPassword' missing." + } else { + $SecureSmtpPassword = $JsonParameters.PSobject.Properties["secureSmtpPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpServerHost"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpServerHost' missing." + } else { + $SmtpServerHost = $JsonParameters.PSobject.Properties["smtpServerHost"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpServerPort"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpServerPort' missing." + } else { + $SmtpServerPort = $JsonParameters.PSobject.Properties["smtpServerPort"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpUsername"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpUsername' missing." + } else { + $SmtpUsername = $JsonParameters.PSobject.Properties["smtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPassword"))) { + throw "Error! JSON cannot be serialized due to the required property 'smtpPassword' missing." + } else { + $SmtpPassword = $JsonParameters.PSobject.Properties["smtpPassword"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mailFromDomain"))) { #optional property not found + $MailFromDomain = $null + } else { + $MailFromDomain = $JsonParameters.PSobject.Properties["mailFromDomain"].value + } + + $PSO = [PSCustomObject]@{ + "secureSmtpServerHost" = ${SecureSmtpServerHost} + "secureSmtpServerPort" = ${SecureSmtpServerPort} + "secureSmtpUsername" = ${SecureSmtpUsername} + "secureSmtpPassword" = ${SecureSmtpPassword} + "smtpServerHost" = ${SmtpServerHost} + "smtpServerPort" = ${SmtpServerPort} + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + "mailFromDomain" = ${MailFromDomain} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SortObject.ps1 b/src/maislurp-client-powershell/Model/SortObject.ps1 new file mode 100644 index 00000000..f6d69d5e --- /dev/null +++ b/src/maislurp-client-powershell/Model/SortObject.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Sorted +No description available. +.PARAMETER Unsorted +No description available. +.PARAMETER Empty +No description available. +.OUTPUTS + +SortObject +#> + +function Initialize-SortObject { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Sorted}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Unsorted}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Empty} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SortObject' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "sorted" = ${Sorted} + "unsorted" = ${Unsorted} + "empty" = ${Empty} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SortObject + +.DESCRIPTION + +Convert from JSON to SortObject + +.PARAMETER Json + +Json object + +.OUTPUTS + +SortObject +#> +function ConvertFrom-JsonToSortObject { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SortObject' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SortObject + $AllProperties = ("sorted", "unsorted", "empty") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sorted"))) { #optional property not found + $Sorted = $null + } else { + $Sorted = $JsonParameters.PSobject.Properties["sorted"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unsorted"))) { #optional property not found + $Unsorted = $null + } else { + $Unsorted = $JsonParameters.PSobject.Properties["unsorted"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "empty"))) { #optional property not found + $Empty = $null + } else { + $Empty = $JsonParameters.PSobject.Properties["empty"].value + } + + $PSO = [PSCustomObject]@{ + "sorted" = ${Sorted} + "unsorted" = ${Unsorted} + "empty" = ${Empty} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/SpellingIssue.ps1 b/src/maislurp-client-powershell/Model/SpellingIssue.ps1 new file mode 100644 index 00000000..ad094f60 --- /dev/null +++ b/src/maislurp-client-powershell/Model/SpellingIssue.ps1 @@ -0,0 +1,158 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Group +No description available. +.PARAMETER Suggestion +No description available. +.PARAMETER Severity +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +SpellingIssue +#> + +function Initialize-SpellingIssue { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Group}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Suggestion}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("Warning", "Error")] + [String] + ${Severity}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => SpellingIssue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Group -eq $null) { + throw "invalid value for 'Group', 'Group' cannot be null." + } + + if ($Suggestion -eq $null) { + throw "invalid value for 'Suggestion', 'Suggestion' cannot be null." + } + + if ($Severity -eq $null) { + throw "invalid value for 'Severity', 'Severity' cannot be null." + } + + if ($Message -eq $null) { + throw "invalid value for 'Message', 'Message' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "group" = ${Group} + "suggestion" = ${Suggestion} + "severity" = ${Severity} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to SpellingIssue + +.DESCRIPTION + +Convert from JSON to SpellingIssue + +.PARAMETER Json + +Json object + +.OUTPUTS + +SpellingIssue +#> +function ConvertFrom-JsonToSpellingIssue { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => SpellingIssue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in SpellingIssue + $AllProperties = ("group", "suggestion", "severity", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'group' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "group"))) { + throw "Error! JSON cannot be serialized due to the required property 'group' missing." + } else { + $Group = $JsonParameters.PSobject.Properties["group"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "suggestion"))) { + throw "Error! JSON cannot be serialized due to the required property 'suggestion' missing." + } else { + $Suggestion = $JsonParameters.PSobject.Properties["suggestion"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "severity"))) { + throw "Error! JSON cannot be serialized due to the required property 'severity' missing." + } else { + $Severity = $JsonParameters.PSobject.Properties["severity"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { + throw "Error! JSON cannot be serialized due to the required property 'message' missing." + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "group" = ${Group} + "suggestion" = ${Suggestion} + "severity" = ${Severity} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TemplateDto.ps1 b/src/maislurp-client-powershell/Model/TemplateDto.ps1 new file mode 100644 index 00000000..a2519c94 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TemplateDto.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email template + +.PARAMETER Id +ID of template +.PARAMETER Name +Template name +.PARAMETER Variables +Variables available in template that can be replaced with values +.PARAMETER Content +Content of the template +.PARAMETER CreatedAt +Created at time +.OUTPUTS + +TemplateDto +#> + +function Initialize-TemplateDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Variables}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Content}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TemplateDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Variables -eq $null) { + throw "invalid value for 'Variables', 'Variables' cannot be null." + } + + if ($Content -eq $null) { + throw "invalid value for 'Content', 'Content' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "name" = ${Name} + "variables" = ${Variables} + "content" = ${Content} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TemplateDto + +.DESCRIPTION + +Convert from JSON to TemplateDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +TemplateDto +#> +function ConvertFrom-JsonToTemplateDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TemplateDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TemplateDto + $AllProperties = ("id", "name", "variables", "content", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "variables"))) { + throw "Error! JSON cannot be serialized due to the required property 'variables' missing." + } else { + $Variables = $JsonParameters.PSobject.Properties["variables"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "content"))) { + throw "Error! JSON cannot be serialized due to the required property 'content' missing." + } else { + $Content = $JsonParameters.PSobject.Properties["content"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "name" = ${Name} + "variables" = ${Variables} + "content" = ${Content} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TemplatePreview.ps1 b/src/maislurp-client-powershell/Model/TemplatePreview.ps1 new file mode 100644 index 00000000..41f28c27 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TemplatePreview.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Preview +No description available. +.OUTPUTS + +TemplatePreview +#> + +function Initialize-TemplatePreview { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Preview} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TemplatePreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Preview -eq $null) { + throw "invalid value for 'Preview', 'Preview' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "preview" = ${Preview} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TemplatePreview + +.DESCRIPTION + +Convert from JSON to TemplatePreview + +.PARAMETER Json + +Json object + +.OUTPUTS + +TemplatePreview +#> +function ConvertFrom-JsonToTemplatePreview { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TemplatePreview' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TemplatePreview + $AllProperties = ("preview") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'preview' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "preview"))) { + throw "Error! JSON cannot be serialized due to the required property 'preview' missing." + } else { + $Preview = $JsonParameters.PSobject.Properties["preview"].value + } + + $PSO = [PSCustomObject]@{ + "preview" = ${Preview} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TemplateProjection.ps1 b/src/maislurp-client-powershell/Model/TemplateProjection.ps1 new file mode 100644 index 00000000..9a0a4ff0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TemplateProjection.ps1 @@ -0,0 +1,174 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Email template data + +.PARAMETER Variables +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +TemplateProjection +#> + +function Initialize-TemplateProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Variables}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TemplateProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Variables -eq $null) { + throw "invalid value for 'Variables', 'Variables' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "variables" = ${Variables} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TemplateProjection + +.DESCRIPTION + +Convert from JSON to TemplateProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +TemplateProjection +#> +function ConvertFrom-JsonToTemplateProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TemplateProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TemplateProjection + $AllProperties = ("variables", "createdAt", "updatedAt", "name", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'variables' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "variables"))) { + throw "Error! JSON cannot be serialized due to the required property 'variables' missing." + } else { + $Variables = $JsonParameters.PSobject.Properties["variables"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + $PSO = [PSCustomObject]@{ + "variables" = ${Variables} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TemplateVariable.ps1 b/src/maislurp-client-powershell/Model/TemplateVariable.ps1 new file mode 100644 index 00000000..65687bfe --- /dev/null +++ b/src/maislurp-client-powershell/Model/TemplateVariable.ps1 @@ -0,0 +1,124 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Variable for use with email template + +.PARAMETER Name +Name of variable. This can be used in a template as {{name}} +.PARAMETER VariableType +The type of variable +.OUTPUTS + +TemplateVariable +#> + +function Initialize-TemplateVariable { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("STRING")] + [String] + ${VariableType} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TemplateVariable' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($VariableType -eq $null) { + throw "invalid value for 'VariableType', 'VariableType' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "variableType" = ${VariableType} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TemplateVariable + +.DESCRIPTION + +Convert from JSON to TemplateVariable + +.PARAMETER Json + +Json object + +.OUTPUTS + +TemplateVariable +#> +function ConvertFrom-JsonToTemplateVariable { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TemplateVariable' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TemplateVariable + $AllProperties = ("name", "variableType") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "variableType"))) { + throw "Error! JSON cannot be serialized due to the required property 'variableType' missing." + } else { + $VariableType = $JsonParameters.PSobject.Properties["variableType"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "variableType" = ${VariableType} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestInboxRulesetReceivingOptions.ps1 b/src/maislurp-client-powershell/Model/TestInboxRulesetReceivingOptions.ps1 new file mode 100644 index 00000000..5e0e0561 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestInboxRulesetReceivingOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Test options for inbox ruleset receiving test + +.PARAMETER InboxId +No description available. +.PARAMETER FromSender +No description available. +.OUTPUTS + +TestInboxRulesetReceivingOptions +#> + +function Initialize-TestInboxRulesetReceivingOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${FromSender} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestInboxRulesetReceivingOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($FromSender -eq $null) { + throw "invalid value for 'FromSender', 'FromSender' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "fromSender" = ${FromSender} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestInboxRulesetReceivingOptions + +.DESCRIPTION + +Convert from JSON to TestInboxRulesetReceivingOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestInboxRulesetReceivingOptions +#> +function ConvertFrom-JsonToTestInboxRulesetReceivingOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestInboxRulesetReceivingOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestInboxRulesetReceivingOptions + $AllProperties = ("inboxId", "fromSender") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fromSender"))) { + throw "Error! JSON cannot be serialized due to the required property 'fromSender' missing." + } else { + $FromSender = $JsonParameters.PSobject.Properties["fromSender"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "fromSender" = ${FromSender} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestInboxRulesetReceivingResult.ps1 b/src/maislurp-client-powershell/Model/TestInboxRulesetReceivingResult.ps1 new file mode 100644 index 00000000..f4f40020 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestInboxRulesetReceivingResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER CanReceive +No description available. +.OUTPUTS + +TestInboxRulesetReceivingResult +#> + +function Initialize-TestInboxRulesetReceivingResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${CanReceive} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestInboxRulesetReceivingResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CanReceive -eq $null) { + throw "invalid value for 'CanReceive', 'CanReceive' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "canReceive" = ${CanReceive} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestInboxRulesetReceivingResult + +.DESCRIPTION + +Convert from JSON to TestInboxRulesetReceivingResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestInboxRulesetReceivingResult +#> +function ConvertFrom-JsonToTestInboxRulesetReceivingResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestInboxRulesetReceivingResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestInboxRulesetReceivingResult + $AllProperties = ("canReceive") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'canReceive' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "canReceive"))) { + throw "Error! JSON cannot be serialized due to the required property 'canReceive' missing." + } else { + $CanReceive = $JsonParameters.PSobject.Properties["canReceive"].value + } + + $PSO = [PSCustomObject]@{ + "canReceive" = ${CanReceive} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestInboxRulesetSendingOptions.ps1 b/src/maislurp-client-powershell/Model/TestInboxRulesetSendingOptions.ps1 new file mode 100644 index 00000000..776f4d7a --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestInboxRulesetSendingOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Test options for inbox ruleset sending test + +.PARAMETER InboxId +No description available. +.PARAMETER Recipient +No description available. +.OUTPUTS + +TestInboxRulesetSendingOptions +#> + +function Initialize-TestInboxRulesetSendingOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestInboxRulesetSendingOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($Recipient -eq $null) { + throw "invalid value for 'Recipient', 'Recipient' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "recipient" = ${Recipient} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestInboxRulesetSendingOptions + +.DESCRIPTION + +Convert from JSON to TestInboxRulesetSendingOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestInboxRulesetSendingOptions +#> +function ConvertFrom-JsonToTestInboxRulesetSendingOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestInboxRulesetSendingOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestInboxRulesetSendingOptions + $AllProperties = ("inboxId", "recipient") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { + throw "Error! JSON cannot be serialized due to the required property 'recipient' missing." + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "recipient" = ${Recipient} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestInboxRulesetSendingResult.ps1 b/src/maislurp-client-powershell/Model/TestInboxRulesetSendingResult.ps1 new file mode 100644 index 00000000..2001b49d --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestInboxRulesetSendingResult.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER CanSend +No description available. +.OUTPUTS + +TestInboxRulesetSendingResult +#> + +function Initialize-TestInboxRulesetSendingResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${CanSend} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestInboxRulesetSendingResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CanSend -eq $null) { + throw "invalid value for 'CanSend', 'CanSend' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "canSend" = ${CanSend} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestInboxRulesetSendingResult + +.DESCRIPTION + +Convert from JSON to TestInboxRulesetSendingResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestInboxRulesetSendingResult +#> +function ConvertFrom-JsonToTestInboxRulesetSendingResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestInboxRulesetSendingResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestInboxRulesetSendingResult + $AllProperties = ("canSend") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'canSend' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "canSend"))) { + throw "Error! JSON cannot be serialized due to the required property 'canSend' missing." + } else { + $CanSend = $JsonParameters.PSobject.Properties["canSend"].value + } + + $PSO = [PSCustomObject]@{ + "canSend" = ${CanSend} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestNewInboxForwarderOptions.ps1 b/src/maislurp-client-powershell/Model/TestNewInboxForwarderOptions.ps1 new file mode 100644 index 00000000..7737e917 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestNewInboxForwarderOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for testing new inbox forwarder rules + +.PARAMETER InboxForwarderTestOptions +No description available. +.PARAMETER CreateInboxForwarderOptions +No description available. +.OUTPUTS + +TestNewInboxForwarderOptions +#> + +function Initialize-TestNewInboxForwarderOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${InboxForwarderTestOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${CreateInboxForwarderOptions} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestNewInboxForwarderOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxForwarderTestOptions -eq $null) { + throw "invalid value for 'InboxForwarderTestOptions', 'InboxForwarderTestOptions' cannot be null." + } + + if ($CreateInboxForwarderOptions -eq $null) { + throw "invalid value for 'CreateInboxForwarderOptions', 'CreateInboxForwarderOptions' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxForwarderTestOptions" = ${InboxForwarderTestOptions} + "createInboxForwarderOptions" = ${CreateInboxForwarderOptions} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestNewInboxForwarderOptions + +.DESCRIPTION + +Convert from JSON to TestNewInboxForwarderOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestNewInboxForwarderOptions +#> +function ConvertFrom-JsonToTestNewInboxForwarderOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestNewInboxForwarderOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestNewInboxForwarderOptions + $AllProperties = ("inboxForwarderTestOptions", "createInboxForwarderOptions") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxForwarderTestOptions' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxForwarderTestOptions"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxForwarderTestOptions' missing." + } else { + $InboxForwarderTestOptions = $JsonParameters.PSobject.Properties["inboxForwarderTestOptions"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createInboxForwarderOptions"))) { + throw "Error! JSON cannot be serialized due to the required property 'createInboxForwarderOptions' missing." + } else { + $CreateInboxForwarderOptions = $JsonParameters.PSobject.Properties["createInboxForwarderOptions"].value + } + + $PSO = [PSCustomObject]@{ + "inboxForwarderTestOptions" = ${InboxForwarderTestOptions} + "createInboxForwarderOptions" = ${CreateInboxForwarderOptions} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestNewInboxRulesetOptions.ps1 b/src/maislurp-client-powershell/Model/TestNewInboxRulesetOptions.ps1 new file mode 100644 index 00000000..3cdf2283 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestNewInboxRulesetOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Test inbox ruleset options + +.PARAMETER InboxRulesetTestOptions +No description available. +.PARAMETER CreateInboxRulesetOptions +No description available. +.OUTPUTS + +TestNewInboxRulesetOptions +#> + +function Initialize-TestNewInboxRulesetOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${InboxRulesetTestOptions}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${CreateInboxRulesetOptions} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestNewInboxRulesetOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxRulesetTestOptions -eq $null) { + throw "invalid value for 'InboxRulesetTestOptions', 'InboxRulesetTestOptions' cannot be null." + } + + if ($CreateInboxRulesetOptions -eq $null) { + throw "invalid value for 'CreateInboxRulesetOptions', 'CreateInboxRulesetOptions' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxRulesetTestOptions" = ${InboxRulesetTestOptions} + "createInboxRulesetOptions" = ${CreateInboxRulesetOptions} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestNewInboxRulesetOptions + +.DESCRIPTION + +Convert from JSON to TestNewInboxRulesetOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestNewInboxRulesetOptions +#> +function ConvertFrom-JsonToTestNewInboxRulesetOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestNewInboxRulesetOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestNewInboxRulesetOptions + $AllProperties = ("inboxRulesetTestOptions", "createInboxRulesetOptions") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxRulesetTestOptions' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxRulesetTestOptions"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxRulesetTestOptions' missing." + } else { + $InboxRulesetTestOptions = $JsonParameters.PSobject.Properties["inboxRulesetTestOptions"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createInboxRulesetOptions"))) { + throw "Error! JSON cannot be serialized due to the required property 'createInboxRulesetOptions' missing." + } else { + $CreateInboxRulesetOptions = $JsonParameters.PSobject.Properties["createInboxRulesetOptions"].value + } + + $PSO = [PSCustomObject]@{ + "inboxRulesetTestOptions" = ${InboxRulesetTestOptions} + "createInboxRulesetOptions" = ${CreateInboxRulesetOptions} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TestPhoneNumberOptions.ps1 b/src/maislurp-client-powershell/Model/TestPhoneNumberOptions.ps1 new file mode 100644 index 00000000..fa9b7e6d --- /dev/null +++ b/src/maislurp-client-powershell/Model/TestPhoneNumberOptions.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Message +No description available. +.OUTPUTS + +TestPhoneNumberOptions +#> + +function Initialize-TestPhoneNumberOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TestPhoneNumberOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Message -eq $null) { + throw "invalid value for 'Message', 'Message' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TestPhoneNumberOptions + +.DESCRIPTION + +Convert from JSON to TestPhoneNumberOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +TestPhoneNumberOptions +#> +function ConvertFrom-JsonToTestPhoneNumberOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TestPhoneNumberOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TestPhoneNumberOptions + $AllProperties = ("message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'message' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { + throw "Error! JSON cannot be serialized due to the required property 'message' missing." + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ThreadProjection.ps1 b/src/maislurp-client-powershell/Model/ThreadProjection.ps1 new file mode 100644 index 00000000..0f81d3bd --- /dev/null +++ b/src/maislurp-client-powershell/Model/ThreadProjection.ps1 @@ -0,0 +1,260 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +A thread is a message thread created for a message received by an alias + +.PARAMETER InboxId +Inbox ID +.PARAMETER UserId +User ID +.PARAMETER To +To recipients +.PARAMETER Bcc +BCC recipients +.PARAMETER Cc +CC recipients +.PARAMETER AliasId +Alias ID +.PARAMETER CreatedAt +Created at DateTime +.PARAMETER UpdatedAt +Updated at DateTime +.PARAMETER Subject +Thread subject +.PARAMETER Name +Name of thread +.PARAMETER Id +ID of email thread +.OUTPUTS + +ThreadProjection +#> + +function Initialize-ThreadProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${AliasId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ThreadProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + if ($AliasId -eq $null) { + throw "invalid value for 'AliasId', 'AliasId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "userId" = ${UserId} + "to" = ${To} + "bcc" = ${Bcc} + "cc" = ${Cc} + "aliasId" = ${AliasId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "subject" = ${Subject} + "name" = ${Name} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ThreadProjection + +.DESCRIPTION + +Convert from JSON to ThreadProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +ThreadProjection +#> +function ConvertFrom-JsonToThreadProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ThreadProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ThreadProjection + $AllProperties = ("inboxId", "userId", "to", "bcc", "cc", "aliasId", "createdAt", "updatedAt", "subject", "name", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "aliasId"))) { + throw "Error! JSON cannot be serialized due to the required property 'aliasId' missing." + } else { + $AliasId = $JsonParameters.PSobject.Properties["aliasId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { #optional property not found + $Bcc = $null + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { #optional property not found + $Cc = $null + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "userId" = ${UserId} + "to" = ${To} + "bcc" = ${Bcc} + "cc" = ${Cc} + "aliasId" = ${AliasId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "subject" = ${Subject} + "name" = ${Name} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TrackingPixelDto.ps1 b/src/maislurp-client-powershell/Model/TrackingPixelDto.ps1 new file mode 100644 index 00000000..ad1380b7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/TrackingPixelDto.ps1 @@ -0,0 +1,226 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Tracking pixel + +.PARAMETER Id +No description available. +.PARAMETER Seen +No description available. +.PARAMETER Recipient +No description available. +.PARAMETER Html +No description available. +.PARAMETER Url +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER SentEmailId +No description available. +.PARAMETER SeenAt +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +TrackingPixelDto +#> + +function Initialize-TrackingPixelDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Seen}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Html}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentEmailId}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${SeenAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TrackingPixelDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($Seen -eq $null) { + throw "invalid value for 'Seen', 'Seen' cannot be null." + } + + if ($Html -eq $null) { + throw "invalid value for 'Html', 'Html' cannot be null." + } + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "seen" = ${Seen} + "recipient" = ${Recipient} + "html" = ${Html} + "url" = ${Url} + "inboxId" = ${InboxId} + "sentEmailId" = ${SentEmailId} + "seenAt" = ${SeenAt} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TrackingPixelDto + +.DESCRIPTION + +Convert from JSON to TrackingPixelDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +TrackingPixelDto +#> +function ConvertFrom-JsonToTrackingPixelDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TrackingPixelDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TrackingPixelDto + $AllProperties = ("id", "seen", "recipient", "html", "url", "inboxId", "sentEmailId", "seenAt", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seen"))) { + throw "Error! JSON cannot be serialized due to the required property 'seen' missing." + } else { + $Seen = $JsonParameters.PSobject.Properties["seen"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { + throw "Error! JSON cannot be serialized due to the required property 'html' missing." + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { #optional property not found + $Recipient = $null + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentEmailId"))) { #optional property not found + $SentEmailId = $null + } else { + $SentEmailId = $JsonParameters.PSobject.Properties["sentEmailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seenAt"))) { #optional property not found + $SeenAt = $null + } else { + $SeenAt = $JsonParameters.PSobject.Properties["seenAt"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "seen" = ${Seen} + "recipient" = ${Recipient} + "html" = ${Html} + "url" = ${Url} + "inboxId" = ${InboxId} + "sentEmailId" = ${SentEmailId} + "seenAt" = ${SeenAt} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/TrackingPixelProjection.ps1 b/src/maislurp-client-powershell/Model/TrackingPixelProjection.ps1 new file mode 100644 index 00000000..399cf85c --- /dev/null +++ b/src/maislurp-client-powershell/Model/TrackingPixelProjection.ps1 @@ -0,0 +1,222 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Tracking pixel data + +.PARAMETER InboxId +No description available. +.PARAMETER UserId +No description available. +.PARAMETER SentEmailId +No description available. +.PARAMETER Recipient +No description available. +.PARAMETER Seen +No description available. +.PARAMETER SeenAt +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +TrackingPixelProjection +#> + +function Initialize-TrackingPixelProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentEmailId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Seen}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${SeenAt}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => TrackingPixelProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($Seen -eq $null) { + throw "invalid value for 'Seen', 'Seen' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "userId" = ${UserId} + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "seen" = ${Seen} + "seenAt" = ${SeenAt} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to TrackingPixelProjection + +.DESCRIPTION + +Convert from JSON to TrackingPixelProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +TrackingPixelProjection +#> +function ConvertFrom-JsonToTrackingPixelProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => TrackingPixelProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in TrackingPixelProjection + $AllProperties = ("inboxId", "userId", "sentEmailId", "recipient", "seen", "seenAt", "createdAt", "name", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'userId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seen"))) { + throw "Error! JSON cannot be serialized due to the required property 'seen' missing." + } else { + $Seen = $JsonParameters.PSobject.Properties["seen"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentEmailId"))) { #optional property not found + $SentEmailId = $null + } else { + $SentEmailId = $JsonParameters.PSobject.Properties["sentEmailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { #optional property not found + $Recipient = $null + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seenAt"))) { #optional property not found + $SeenAt = $null + } else { + $SeenAt = $JsonParameters.PSobject.Properties["seenAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "userId" = ${UserId} + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "seen" = ${Seen} + "seenAt" = ${SeenAt} + "createdAt" = ${CreatedAt} + "name" = ${Name} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UnknownMissedEmailProjection.ps1 b/src/maislurp-client-powershell/Model/UnknownMissedEmailProjection.ps1 new file mode 100644 index 00000000..b379112c --- /dev/null +++ b/src/maislurp-client-powershell/Model/UnknownMissedEmailProjection.ps1 @@ -0,0 +1,162 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Unknown missed email projection + +.PARAMETER To +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER Subject +No description available. +.PARAMETER Id +No description available. +.PARAMETER VarFrom +No description available. +.OUTPUTS + +UnknownMissedEmailProjection +#> + +function Initialize-UnknownMissedEmailProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UnknownMissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "to" = ${To} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + "from" = ${VarFrom} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UnknownMissedEmailProjection + +.DESCRIPTION + +Convert from JSON to UnknownMissedEmailProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +UnknownMissedEmailProjection +#> +function ConvertFrom-JsonToUnknownMissedEmailProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UnknownMissedEmailProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UnknownMissedEmailProjection + $AllProperties = ("to", "createdAt", "subject", "id", "from") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'createdAt' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { #optional property not found + $To = $null + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + $PSO = [PSCustomObject]@{ + "to" = ${To} + "createdAt" = ${CreatedAt} + "subject" = ${Subject} + "id" = ${Id} + "from" = ${VarFrom} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UnreadCount.ps1 b/src/maislurp-client-powershell/Model/UnreadCount.ps1 new file mode 100644 index 00000000..44712169 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UnreadCount.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Number of unread entities + +.PARAMETER Count +No description available. +.OUTPUTS + +UnreadCount +#> + +function Initialize-UnreadCount { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Count} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UnreadCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Count -eq $null) { + throw "invalid value for 'Count', 'Count' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "count" = ${Count} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UnreadCount + +.DESCRIPTION + +Convert from JSON to UnreadCount + +.PARAMETER Json + +Json object + +.OUTPUTS + +UnreadCount +#> +function ConvertFrom-JsonToUnreadCount { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UnreadCount' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UnreadCount + $AllProperties = ("count") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'count' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "count"))) { + throw "Error! JSON cannot be serialized due to the required property 'count' missing." + } else { + $Count = $JsonParameters.PSobject.Properties["count"].value + } + + $PSO = [PSCustomObject]@{ + "count" = ${Count} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UnseenErrorCountDto.ps1 b/src/maislurp-client-powershell/Model/UnseenErrorCountDto.ps1 new file mode 100644 index 00000000..5606f062 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UnseenErrorCountDto.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Number of unseen errors + +.PARAMETER Count +No description available. +.OUTPUTS + +UnseenErrorCountDto +#> + +function Initialize-UnseenErrorCountDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Count} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UnseenErrorCountDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Count -eq $null) { + throw "invalid value for 'Count', 'Count' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "count" = ${Count} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UnseenErrorCountDto + +.DESCRIPTION + +Convert from JSON to UnseenErrorCountDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +UnseenErrorCountDto +#> +function ConvertFrom-JsonToUnseenErrorCountDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UnseenErrorCountDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UnseenErrorCountDto + $AllProperties = ("count") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'count' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "count"))) { + throw "Error! JSON cannot be serialized due to the required property 'count' missing." + } else { + $Count = $JsonParameters.PSobject.Properties["count"].value + } + + $PSO = [PSCustomObject]@{ + "count" = ${Count} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateAliasOptions.ps1 b/src/maislurp-client-powershell/Model/UpdateAliasOptions.ps1 new file mode 100644 index 00000000..0be3fc8c --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateAliasOptions.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Update an email alias + +.PARAMETER Name +Optional name for alias +.OUTPUTS + +UpdateAliasOptions +#> + +function Initialize-UpdateAliasOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateAliasOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateAliasOptions + +.DESCRIPTION + +Convert from JSON to UpdateAliasOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateAliasOptions +#> +function ConvertFrom-JsonToUpdateAliasOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateAliasOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateAliasOptions + $AllProperties = ("name") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateDomainOptions.ps1 b/src/maislurp-client-powershell/Model/UpdateDomainOptions.ps1 new file mode 100644 index 00000000..dc3a7880 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateDomainOptions.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not functionally currently until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. + +.PARAMETER CatchAllInboxId +No description available. +.OUTPUTS + +UpdateDomainOptions +#> + +function Initialize-UpdateDomainOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${CatchAllInboxId} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "catchAllInboxId" = ${CatchAllInboxId} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateDomainOptions + +.DESCRIPTION + +Convert from JSON to UpdateDomainOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateDomainOptions +#> +function ConvertFrom-JsonToUpdateDomainOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateDomainOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateDomainOptions + $AllProperties = ("catchAllInboxId") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "catchAllInboxId"))) { #optional property not found + $CatchAllInboxId = $null + } else { + $CatchAllInboxId = $JsonParameters.PSobject.Properties["catchAllInboxId"].value + } + + $PSO = [PSCustomObject]@{ + "catchAllInboxId" = ${CatchAllInboxId} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateGroupContacts.ps1 b/src/maislurp-client-powershell/Model/UpdateGroupContacts.ps1 new file mode 100644 index 00000000..f48de733 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateGroupContacts.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Update group contacts options. Pass a list of contact ids to replace existing group contacts. + +.PARAMETER ContactIds +No description available. +.OUTPUTS + +UpdateGroupContacts +#> + +function Initialize-UpdateGroupContacts { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ContactIds} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateGroupContacts' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ContactIds -eq $null) { + throw "invalid value for 'ContactIds', 'ContactIds' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "contactIds" = ${ContactIds} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateGroupContacts + +.DESCRIPTION + +Convert from JSON to UpdateGroupContacts + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateGroupContacts +#> +function ConvertFrom-JsonToUpdateGroupContacts { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateGroupContacts' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateGroupContacts + $AllProperties = ("contactIds") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'contactIds' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contactIds"))) { + throw "Error! JSON cannot be serialized due to the required property 'contactIds' missing." + } else { + $ContactIds = $JsonParameters.PSobject.Properties["contactIds"].value + } + + $PSO = [PSCustomObject]@{ + "contactIds" = ${ContactIds} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateImapAccessOptions.ps1 b/src/maislurp-client-powershell/Model/UpdateImapAccessOptions.ps1 new file mode 100644 index 00000000..cdb55ea0 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateImapAccessOptions.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Edit access details for inbox using IMAP + +.PARAMETER ImapUsername +IMAP username for login +.PARAMETER ImapPassword +IMAP password for login +.OUTPUTS + +UpdateImapAccessOptions +#> + +function Initialize-UpdateImapAccessOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapUsername}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ImapPassword} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateImapAccessOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateImapAccessOptions + +.DESCRIPTION + +Convert from JSON to UpdateImapAccessOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateImapAccessOptions +#> +function ConvertFrom-JsonToUpdateImapAccessOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateImapAccessOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateImapAccessOptions + $AllProperties = ("imapUsername", "imapPassword") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapUsername"))) { #optional property not found + $ImapUsername = $null + } else { + $ImapUsername = $JsonParameters.PSobject.Properties["imapUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "imapPassword"))) { #optional property not found + $ImapPassword = $null + } else { + $ImapPassword = $JsonParameters.PSobject.Properties["imapPassword"].value + } + + $PSO = [PSCustomObject]@{ + "imapUsername" = ${ImapUsername} + "imapPassword" = ${ImapPassword} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateInboxOptions.ps1 b/src/maislurp-client-powershell/Model/UpdateInboxOptions.ps1 new file mode 100644 index 00000000..fecdf0a1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateInboxOptions.ps1 @@ -0,0 +1,150 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for updating inbox properties + +.PARAMETER Name +Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search +.PARAMETER Description +Description of an inbox for labelling and searching purposes +.PARAMETER Tags +Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. +.PARAMETER ExpiresAt +Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. +.PARAMETER Favourite +Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering +.OUTPUTS + +UpdateInboxOptions +#> + +function Initialize-UpdateInboxOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Description}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${ExpiresAt}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${Favourite} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateInboxOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "description" = ${Description} + "tags" = ${Tags} + "expiresAt" = ${ExpiresAt} + "favourite" = ${Favourite} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateInboxOptions + +.DESCRIPTION + +Convert from JSON to UpdateInboxOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateInboxOptions +#> +function ConvertFrom-JsonToUpdateInboxOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateInboxOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateInboxOptions + $AllProperties = ("name", "description", "tags", "expiresAt", "favourite") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found + $Description = $null + } else { + $Description = $JsonParameters.PSobject.Properties["description"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { #optional property not found + $Tags = $null + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "expiresAt"))) { #optional property not found + $ExpiresAt = $null + } else { + $ExpiresAt = $JsonParameters.PSobject.Properties["expiresAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "favourite"))) { #optional property not found + $Favourite = $null + } else { + $Favourite = $JsonParameters.PSobject.Properties["favourite"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "description" = ${Description} + "tags" = ${Tags} + "expiresAt" = ${ExpiresAt} + "favourite" = ${Favourite} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateInboxReplierOptions.ps1 b/src/maislurp-client-powershell/Model/UpdateInboxReplierOptions.ps1 new file mode 100644 index 00000000..215f920a --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateInboxReplierOptions.ps1 @@ -0,0 +1,271 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for updating an inbox replier + +.PARAMETER InboxId +Inbox ID to attach replier to +.PARAMETER Name +Name for replier +.PARAMETER Field +Field to match against to trigger inbox replier for inbound email +.PARAMETER Match +String or wildcard style match for field specified when evaluating reply rules +.PARAMETER ReplyTo +Reply-to email address when sending replying +.PARAMETER Subject +Subject override when replying to email +.PARAMETER VarFrom +Send email from address +.PARAMETER Charset +Email reply charset +.PARAMETER IsHTML +Send HTML email +.PARAMETER IgnoreReplyTo +Ignore sender replyTo when responding. Send directly to the sender if enabled. +.PARAMETER Body +Email body for reply +.PARAMETER TemplateId +ID of template to use when sending a reply +.PARAMETER TemplateVariables +Template variable values +.OUTPUTS + +UpdateInboxReplierOptions +#> + +function Initialize-UpdateInboxReplierOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS")] + [String] + ${Field}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Match}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReplyTo}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Charset}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IsHTML}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IgnoreReplyTo}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String] + ${TemplateId}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${TemplateVariables} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateInboxReplierOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($Field -eq $null) { + throw "invalid value for 'Field', 'Field' cannot be null." + } + + if ($Match -eq $null) { + throw "invalid value for 'Match', 'Match' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "replyTo" = ${ReplyTo} + "subject" = ${Subject} + "from" = ${VarFrom} + "charset" = ${Charset} + "isHTML" = ${IsHTML} + "ignoreReplyTo" = ${IgnoreReplyTo} + "body" = ${Body} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateInboxReplierOptions + +.DESCRIPTION + +Convert from JSON to UpdateInboxReplierOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateInboxReplierOptions +#> +function ConvertFrom-JsonToUpdateInboxReplierOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateInboxReplierOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateInboxReplierOptions + $AllProperties = ("inboxId", "name", "field", "match", "replyTo", "subject", "from", "charset", "isHTML", "ignoreReplyTo", "body", "templateId", "templateVariables") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "field"))) { + throw "Error! JSON cannot be serialized due to the required property 'field' missing." + } else { + $Field = $JsonParameters.PSobject.Properties["field"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "match"))) { + throw "Error! JSON cannot be serialized due to the required property 'match' missing." + } else { + $Match = $JsonParameters.PSobject.Properties["match"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "replyTo"))) { #optional property not found + $ReplyTo = $null + } else { + $ReplyTo = $JsonParameters.PSobject.Properties["replyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { #optional property not found + $VarFrom = $null + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "charset"))) { #optional property not found + $Charset = $null + } else { + $Charset = $JsonParameters.PSobject.Properties["charset"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isHTML"))) { #optional property not found + $IsHTML = $null + } else { + $IsHTML = $JsonParameters.PSobject.Properties["isHTML"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreReplyTo"))) { #optional property not found + $IgnoreReplyTo = $null + } else { + $IgnoreReplyTo = $JsonParameters.PSobject.Properties["ignoreReplyTo"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { #optional property not found + $Body = $null + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateId"))) { #optional property not found + $TemplateId = $null + } else { + $TemplateId = $JsonParameters.PSobject.Properties["templateId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "templateVariables"))) { #optional property not found + $TemplateVariables = $null + } else { + $TemplateVariables = $JsonParameters.PSobject.Properties["templateVariables"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "name" = ${Name} + "field" = ${Field} + "match" = ${Match} + "replyTo" = ${ReplyTo} + "subject" = ${Subject} + "from" = ${VarFrom} + "charset" = ${Charset} + "isHTML" = ${IsHTML} + "ignoreReplyTo" = ${IgnoreReplyTo} + "body" = ${Body} + "templateId" = ${TemplateId} + "templateVariables" = ${TemplateVariables} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UpdateSmtpAccessOptions.ps1 b/src/maislurp-client-powershell/Model/UpdateSmtpAccessOptions.ps1 new file mode 100644 index 00000000..c0f591fe --- /dev/null +++ b/src/maislurp-client-powershell/Model/UpdateSmtpAccessOptions.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Edit access details for inbox using SMTP + +.PARAMETER SmtpUsername +SMTP username for login +.PARAMETER SmtpPassword +SMTP password for login +.OUTPUTS + +UpdateSmtpAccessOptions +#> + +function Initialize-UpdateSmtpAccessOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpUsername}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpPassword} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UpdateSmtpAccessOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UpdateSmtpAccessOptions + +.DESCRIPTION + +Convert from JSON to UpdateSmtpAccessOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UpdateSmtpAccessOptions +#> +function ConvertFrom-JsonToUpdateSmtpAccessOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UpdateSmtpAccessOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UpdateSmtpAccessOptions + $AllProperties = ("smtpUsername", "smtpPassword") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpUsername"))) { #optional property not found + $SmtpUsername = $null + } else { + $SmtpUsername = $JsonParameters.PSobject.Properties["smtpUsername"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpPassword"))) { #optional property not found + $SmtpPassword = $null + } else { + $SmtpPassword = $JsonParameters.PSobject.Properties["smtpPassword"].value + } + + $PSO = [PSCustomObject]@{ + "smtpUsername" = ${SmtpUsername} + "smtpPassword" = ${SmtpPassword} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UploadAttachmentOptions.ps1 b/src/maislurp-client-powershell/Model/UploadAttachmentOptions.ps1 new file mode 100644 index 00000000..1a73d543 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UploadAttachmentOptions.ps1 @@ -0,0 +1,145 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for uploading files for attachments. When sending emails with the API that require attachments first upload each attachment. Then use the returned attachment ID in your `SendEmailOptions` when sending an email. This way you can use attachments multiple times once they have been uploaded. + +.PARAMETER ContentId +Optional contentId for file. +.PARAMETER ContentType +Optional contentType for file. For instance `application/pdf` +.PARAMETER Filename +Optional filename to save upload with. Will be the name that is shown in email clients +.PARAMETER Base64Contents +Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/ +.OUTPUTS + +UploadAttachmentOptions +#> + +function Initialize-UploadAttachmentOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Filename}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Base64Contents} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UploadAttachmentOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Base64Contents -eq $null) { + throw "invalid value for 'Base64Contents', 'Base64Contents' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "contentId" = ${ContentId} + "contentType" = ${ContentType} + "filename" = ${Filename} + "base64Contents" = ${Base64Contents} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UploadAttachmentOptions + +.DESCRIPTION + +Convert from JSON to UploadAttachmentOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +UploadAttachmentOptions +#> +function ConvertFrom-JsonToUploadAttachmentOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UploadAttachmentOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UploadAttachmentOptions + $AllProperties = ("contentId", "contentType", "filename", "base64Contents") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'base64Contents' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "base64Contents"))) { + throw "Error! JSON cannot be serialized due to the required property 'base64Contents' missing." + } else { + $Base64Contents = $JsonParameters.PSobject.Properties["base64Contents"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentId"))) { #optional property not found + $ContentId = $null + } else { + $ContentId = $JsonParameters.PSobject.Properties["contentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { #optional property not found + $ContentType = $null + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "filename"))) { #optional property not found + $Filename = $null + } else { + $Filename = $JsonParameters.PSobject.Properties["filename"].value + } + + $PSO = [PSCustomObject]@{ + "contentId" = ${ContentId} + "contentType" = ${ContentType} + "filename" = ${Filename} + "base64Contents" = ${Base64Contents} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/UserInfoDto.ps1 b/src/maislurp-client-powershell/Model/UserInfoDto.ps1 new file mode 100644 index 00000000..e76a4041 --- /dev/null +++ b/src/maislurp-client-powershell/Model/UserInfoDto.ps1 @@ -0,0 +1,190 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER Id +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER AccountState +No description available. +.PARAMETER SubscriptionType +No description available. +.PARAMETER AccountType +No description available. +.PARAMETER CreatedAt +No description available. +.OUTPUTS + +UserInfoDto +#> + +function Initialize-UserInfoDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("FROZEN", "ACTIVE")] + [String] + ${AccountState}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("PRO_MONTHLY", "STARTER", "PRO", "TEAM", "ENTERPRISE")] + [String] + ${SubscriptionType}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("SOLO", "CHILD_SOLO", "CHILD_TEAM", "CHILD_ADMIN")] + [String] + ${AccountType}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => UserInfoDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + if ($AccountState -eq $null) { + throw "invalid value for 'AccountState', 'AccountState' cannot be null." + } + + if ($AccountType -eq $null) { + throw "invalid value for 'AccountType', 'AccountType' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "accountState" = ${AccountState} + "subscriptionType" = ${SubscriptionType} + "accountType" = ${AccountType} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to UserInfoDto + +.DESCRIPTION + +Convert from JSON to UserInfoDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +UserInfoDto +#> +function ConvertFrom-JsonToUserInfoDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => UserInfoDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in UserInfoDto + $AllProperties = ("id", "emailAddress", "accountState", "subscriptionType", "accountType", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "accountState"))) { + throw "Error! JSON cannot be serialized due to the required property 'accountState' missing." + } else { + $AccountState = $JsonParameters.PSobject.Properties["accountState"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "accountType"))) { + throw "Error! JSON cannot be serialized due to the required property 'accountType' missing." + } else { + $AccountType = $JsonParameters.PSobject.Properties["accountType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subscriptionType"))) { #optional property not found + $SubscriptionType = $null + } else { + $SubscriptionType = $JsonParameters.PSobject.Properties["subscriptionType"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "emailAddress" = ${EmailAddress} + "accountState" = ${AccountState} + "subscriptionType" = ${SubscriptionType} + "accountType" = ${AccountType} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ValidateEmailAddressListOptions.ps1 b/src/maislurp-client-powershell/Model/ValidateEmailAddressListOptions.ps1 new file mode 100644 index 00000000..d01c9e02 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ValidateEmailAddressListOptions.ps1 @@ -0,0 +1,127 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for validating a list of email addresses + +.PARAMETER EmailAddressList +No description available. +.PARAMETER IgnoreOldResults +No description available. +.OUTPUTS + +ValidateEmailAddressListOptions +#> + +function Initialize-ValidateEmailAddressListOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${EmailAddressList}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IgnoreOldResults} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ValidateEmailAddressListOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddressList -eq $null) { + throw "invalid value for 'EmailAddressList', 'EmailAddressList' cannot be null." + } + + if ($EmailAddressList.length -gt 50) { + throw "invalid value for 'EmailAddressList', number of items must be less than or equal to 50." + } + + if ($EmailAddressList.length -lt 1) { + throw "invalid value for 'EmailAddressList', number of items must be greater than or equal to 1." + } + + + $PSO = [PSCustomObject]@{ + "emailAddressList" = ${EmailAddressList} + "ignoreOldResults" = ${IgnoreOldResults} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ValidateEmailAddressListOptions + +.DESCRIPTION + +Convert from JSON to ValidateEmailAddressListOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +ValidateEmailAddressListOptions +#> +function ConvertFrom-JsonToValidateEmailAddressListOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ValidateEmailAddressListOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ValidateEmailAddressListOptions + $AllProperties = ("emailAddressList", "ignoreOldResults") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddressList' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddressList"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddressList' missing." + } else { + $EmailAddressList = $JsonParameters.PSobject.Properties["emailAddressList"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreOldResults"))) { #optional property not found + $IgnoreOldResults = $null + } else { + $IgnoreOldResults = $JsonParameters.PSobject.Properties["ignoreOldResults"].value + } + + $PSO = [PSCustomObject]@{ + "emailAddressList" = ${EmailAddressList} + "ignoreOldResults" = ${IgnoreOldResults} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ValidateEmailAddressListResult.ps1 b/src/maislurp-client-powershell/Model/ValidateEmailAddressListResult.ps1 new file mode 100644 index 00000000..967d3aff --- /dev/null +++ b/src/maislurp-client-powershell/Model/ValidateEmailAddressListResult.ps1 @@ -0,0 +1,140 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of validating a list of email addresses + +.PARAMETER ValidEmailAddresses +No description available. +.PARAMETER InvalidEmailAddresses +No description available. +.PARAMETER ResultMapEmailAddressIsValid +No description available. +.OUTPUTS + +ValidateEmailAddressListResult +#> + +function Initialize-ValidateEmailAddressListResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${ValidEmailAddresses}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${InvalidEmailAddresses}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${ResultMapEmailAddressIsValid} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ValidateEmailAddressListResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($ValidEmailAddresses -eq $null) { + throw "invalid value for 'ValidEmailAddresses', 'ValidEmailAddresses' cannot be null." + } + + if ($InvalidEmailAddresses -eq $null) { + throw "invalid value for 'InvalidEmailAddresses', 'InvalidEmailAddresses' cannot be null." + } + + if ($ResultMapEmailAddressIsValid -eq $null) { + throw "invalid value for 'ResultMapEmailAddressIsValid', 'ResultMapEmailAddressIsValid' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "validEmailAddresses" = ${ValidEmailAddresses} + "invalidEmailAddresses" = ${InvalidEmailAddresses} + "resultMapEmailAddressIsValid" = ${ResultMapEmailAddressIsValid} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ValidateEmailAddressListResult + +.DESCRIPTION + +Convert from JSON to ValidateEmailAddressListResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +ValidateEmailAddressListResult +#> +function ConvertFrom-JsonToValidateEmailAddressListResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ValidateEmailAddressListResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ValidateEmailAddressListResult + $AllProperties = ("validEmailAddresses", "invalidEmailAddresses", "resultMapEmailAddressIsValid") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'validEmailAddresses' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "validEmailAddresses"))) { + throw "Error! JSON cannot be serialized due to the required property 'validEmailAddresses' missing." + } else { + $ValidEmailAddresses = $JsonParameters.PSobject.Properties["validEmailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "invalidEmailAddresses"))) { + throw "Error! JSON cannot be serialized due to the required property 'invalidEmailAddresses' missing." + } else { + $InvalidEmailAddresses = $JsonParameters.PSobject.Properties["invalidEmailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "resultMapEmailAddressIsValid"))) { + throw "Error! JSON cannot be serialized due to the required property 'resultMapEmailAddressIsValid' missing." + } else { + $ResultMapEmailAddressIsValid = $JsonParameters.PSobject.Properties["resultMapEmailAddressIsValid"].value + } + + $PSO = [PSCustomObject]@{ + "validEmailAddresses" = ${ValidEmailAddresses} + "invalidEmailAddresses" = ${InvalidEmailAddresses} + "resultMapEmailAddressIsValid" = ${ResultMapEmailAddressIsValid} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ValidationDto.ps1 b/src/maislurp-client-powershell/Model/ValidationDto.ps1 new file mode 100644 index 00000000..13c7ba7d --- /dev/null +++ b/src/maislurp-client-powershell/Model/ValidationDto.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Response object for email validation operation + +.PARAMETER EmailId +ID of the email validated +.PARAMETER Html +No description available. +.OUTPUTS + +ValidationDto +#> + +function Initialize-ValidationDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Html} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ValidationDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailId -eq $null) { + throw "invalid value for 'EmailId', 'EmailId' cannot be null." + } + + if ($Html -eq $null) { + throw "invalid value for 'Html', 'Html' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "emailId" = ${EmailId} + "html" = ${Html} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ValidationDto + +.DESCRIPTION + +Convert from JSON to ValidationDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +ValidationDto +#> +function ConvertFrom-JsonToValidationDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ValidationDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ValidationDto + $AllProperties = ("emailId", "html") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailId' missing." + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "html"))) { + throw "Error! JSON cannot be serialized due to the required property 'html' missing." + } else { + $Html = $JsonParameters.PSobject.Properties["html"].value + } + + $PSO = [PSCustomObject]@{ + "emailId" = ${EmailId} + "html" = ${Html} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/ValidationMessage.ps1 b/src/maislurp-client-powershell/Model/ValidationMessage.ps1 new file mode 100644 index 00000000..e1fa5a68 --- /dev/null +++ b/src/maislurp-client-powershell/Model/ValidationMessage.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Optional warnings resulting from HTML validation + +.PARAMETER LineNumber +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +ValidationMessage +#> + +function Initialize-ValidationMessage { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Int32] + ${LineNumber}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => ValidationMessage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($LineNumber -eq $null) { + throw "invalid value for 'LineNumber', 'LineNumber' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "lineNumber" = ${LineNumber} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to ValidationMessage + +.DESCRIPTION + +Convert from JSON to ValidationMessage + +.PARAMETER Json + +Json object + +.OUTPUTS + +ValidationMessage +#> +function ConvertFrom-JsonToValidationMessage { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => ValidationMessage' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in ValidationMessage + $AllProperties = ("lineNumber", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'lineNumber' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lineNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'lineNumber' missing." + } else { + $LineNumber = $JsonParameters.PSobject.Properties["lineNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "lineNumber" = ${LineNumber} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/VerifyEmailAddressOptions.ps1 b/src/maislurp-client-powershell/Model/VerifyEmailAddressOptions.ps1 new file mode 100644 index 00000000..041b9da5 --- /dev/null +++ b/src/maislurp-client-powershell/Model/VerifyEmailAddressOptions.ps1 @@ -0,0 +1,145 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Options for verifying that an email address exists at a remote mail server. + +.PARAMETER MailServerDomain +No description available. +.PARAMETER EmailAddress +No description available. +.PARAMETER SenderEmailAddress +No description available. +.PARAMETER Port +No description available. +.OUTPUTS + +VerifyEmailAddressOptions +#> + +function Initialize-VerifyEmailAddressOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MailServerDomain}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailAddress}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${SenderEmailAddress}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Port} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => VerifyEmailAddressOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($EmailAddress -eq $null) { + throw "invalid value for 'EmailAddress', 'EmailAddress' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "mailServerDomain" = ${MailServerDomain} + "emailAddress" = ${EmailAddress} + "senderEmailAddress" = ${SenderEmailAddress} + "port" = ${Port} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to VerifyEmailAddressOptions + +.DESCRIPTION + +Convert from JSON to VerifyEmailAddressOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +VerifyEmailAddressOptions +#> +function ConvertFrom-JsonToVerifyEmailAddressOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => VerifyEmailAddressOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in VerifyEmailAddressOptions + $AllProperties = ("mailServerDomain", "emailAddress", "senderEmailAddress", "port") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'emailAddress' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddress"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddress' missing." + } else { + $EmailAddress = $JsonParameters.PSobject.Properties["emailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "mailServerDomain"))) { #optional property not found + $MailServerDomain = $null + } else { + $MailServerDomain = $JsonParameters.PSobject.Properties["mailServerDomain"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "senderEmailAddress"))) { #optional property not found + $SenderEmailAddress = $null + } else { + $SenderEmailAddress = $JsonParameters.PSobject.Properties["senderEmailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "port"))) { #optional property not found + $Port = $null + } else { + $Port = $JsonParameters.PSobject.Properties["port"].value + } + + $PSO = [PSCustomObject]@{ + "mailServerDomain" = ${MailServerDomain} + "emailAddress" = ${EmailAddress} + "senderEmailAddress" = ${SenderEmailAddress} + "port" = ${Port} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/VerifyWebhookSignatureOptions.ps1 b/src/maislurp-client-powershell/Model/VerifyWebhookSignatureOptions.ps1 new file mode 100644 index 00000000..516453da --- /dev/null +++ b/src/maislurp-client-powershell/Model/VerifyWebhookSignatureOptions.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER MessageId +No description available. +.PARAMETER Signature +No description available. +.OUTPUTS + +VerifyWebhookSignatureOptions +#> + +function Initialize-VerifyWebhookSignatureOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Signature} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => VerifyWebhookSignatureOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($Signature -eq $null) { + throw "invalid value for 'Signature', 'Signature' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "signature" = ${Signature} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to VerifyWebhookSignatureOptions + +.DESCRIPTION + +Convert from JSON to VerifyWebhookSignatureOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +VerifyWebhookSignatureOptions +#> +function ConvertFrom-JsonToVerifyWebhookSignatureOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => VerifyWebhookSignatureOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in VerifyWebhookSignatureOptions + $AllProperties = ("messageId", "signature") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "signature"))) { + throw "Error! JSON cannot be serialized due to the required property 'signature' missing." + } else { + $Signature = $JsonParameters.PSobject.Properties["signature"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "signature" = ${Signature} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/VerifyWebhookSignatureResults.ps1 b/src/maislurp-client-powershell/Model/VerifyWebhookSignatureResults.ps1 new file mode 100644 index 00000000..6a60c3c7 --- /dev/null +++ b/src/maislurp-client-powershell/Model/VerifyWebhookSignatureResults.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER IsValid +No description available. +.OUTPUTS + +VerifyWebhookSignatureResults +#> + +function Initialize-VerifyWebhookSignatureResults { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${IsValid} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => VerifyWebhookSignatureResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($IsValid -eq $null) { + throw "invalid value for 'IsValid', 'IsValid' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "isValid" = ${IsValid} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to VerifyWebhookSignatureResults + +.DESCRIPTION + +Convert from JSON to VerifyWebhookSignatureResults + +.PARAMETER Json + +Json object + +.OUTPUTS + +VerifyWebhookSignatureResults +#> +function ConvertFrom-JsonToVerifyWebhookSignatureResults { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => VerifyWebhookSignatureResults' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in VerifyWebhookSignatureResults + $AllProperties = ("isValid") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'isValid' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "isValid"))) { + throw "Error! JSON cannot be serialized due to the required property 'isValid' missing." + } else { + $IsValid = $JsonParameters.PSobject.Properties["isValid"].value + } + + $PSO = [PSCustomObject]@{ + "isValid" = ${IsValid} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WaitForConditions.ps1 b/src/maislurp-client-powershell/Model/WaitForConditions.ps1 new file mode 100644 index 00000000..347f3c8e --- /dev/null +++ b/src/maislurp-client-powershell/Model/WaitForConditions.ps1 @@ -0,0 +1,229 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Conditions to apply to emails that you are waiting for + +.PARAMETER InboxId +ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count. +.PARAMETER Count +Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation. +.PARAMETER DelayTimeout +Max time in milliseconds to wait between retries if a `timeout` is specified. +.PARAMETER Timeout +Max time in milliseconds to retry the `waitFor` operation until conditions are met. +.PARAMETER UnreadOnly +Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard. +.PARAMETER CountType +How result size should be compared with the expected size. Exactly or at-least matching result? +.PARAMETER VarMatches +Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for. +.PARAMETER SortDirection +Direction to sort matching emails by created time +.PARAMETER Since +ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date +.PARAMETER Before +ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date +.OUTPUTS + +WaitForConditions +#> + +function Initialize-WaitForConditions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Count}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${DelayTimeout}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Timeout}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EXACTLY", "ATLEAST")] + [String] + ${CountType}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${VarMatches}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ASC", "DESC")] + [String] + ${SortDirection}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Before} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WaitForConditions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($Timeout -eq $null) { + throw "invalid value for 'Timeout', 'Timeout' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "count" = ${Count} + "delayTimeout" = ${DelayTimeout} + "timeout" = ${Timeout} + "unreadOnly" = ${UnreadOnly} + "countType" = ${CountType} + "matches" = ${VarMatches} + "sortDirection" = ${SortDirection} + "since" = ${Since} + "before" = ${Before} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WaitForConditions + +.DESCRIPTION + +Convert from JSON to WaitForConditions + +.PARAMETER Json + +Json object + +.OUTPUTS + +WaitForConditions +#> +function ConvertFrom-JsonToWaitForConditions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WaitForConditions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WaitForConditions + $AllProperties = ("inboxId", "count", "delayTimeout", "timeout", "unreadOnly", "countType", "matches", "sortDirection", "since", "before") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'inboxId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "timeout"))) { + throw "Error! JSON cannot be serialized due to the required property 'timeout' missing." + } else { + $Timeout = $JsonParameters.PSobject.Properties["timeout"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "count"))) { #optional property not found + $Count = $null + } else { + $Count = $JsonParameters.PSobject.Properties["count"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "delayTimeout"))) { #optional property not found + $DelayTimeout = $null + } else { + $DelayTimeout = $JsonParameters.PSobject.Properties["delayTimeout"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unreadOnly"))) { #optional property not found + $UnreadOnly = $null + } else { + $UnreadOnly = $JsonParameters.PSobject.Properties["unreadOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "countType"))) { #optional property not found + $CountType = $null + } else { + $CountType = $JsonParameters.PSobject.Properties["countType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "matches"))) { #optional property not found + $VarMatches = $null + } else { + $VarMatches = $JsonParameters.PSobject.Properties["matches"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sortDirection"))) { #optional property not found + $SortDirection = $null + } else { + $SortDirection = $JsonParameters.PSobject.Properties["sortDirection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found + $Since = $null + } else { + $Since = $JsonParameters.PSobject.Properties["since"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "before"))) { #optional property not found + $Before = $null + } else { + $Before = $JsonParameters.PSobject.Properties["before"].value + } + + $PSO = [PSCustomObject]@{ + "inboxId" = ${InboxId} + "count" = ${Count} + "delayTimeout" = ${DelayTimeout} + "timeout" = ${Timeout} + "unreadOnly" = ${UnreadOnly} + "countType" = ${CountType} + "matches" = ${VarMatches} + "sortDirection" = ${SortDirection} + "since" = ${Since} + "before" = ${Before} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WaitForSingleSmsOptions.ps1 b/src/maislurp-client-powershell/Model/WaitForSingleSmsOptions.ps1 new file mode 100644 index 00000000..102d6a45 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WaitForSingleSmsOptions.ps1 @@ -0,0 +1,189 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +No description available. + +.PARAMETER PhoneNumberId +No description available. +.PARAMETER Timeout +No description available. +.PARAMETER UnreadOnly +No description available. +.PARAMETER Before +No description available. +.PARAMETER Since +No description available. +.PARAMETER SortDirection +No description available. +.PARAMETER Delay +No description available. +.OUTPUTS + +WaitForSingleSmsOptions +#> + +function Initialize-WaitForSingleSmsOptions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumberId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Timeout}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Before}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ASC", "DESC")] + [String] + ${SortDirection}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${Delay} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WaitForSingleSmsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($PhoneNumberId -eq $null) { + throw "invalid value for 'PhoneNumberId', 'PhoneNumberId' cannot be null." + } + + if ($Timeout -eq $null) { + throw "invalid value for 'Timeout', 'Timeout' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "phoneNumberId" = ${PhoneNumberId} + "timeout" = ${Timeout} + "unreadOnly" = ${UnreadOnly} + "before" = ${Before} + "since" = ${Since} + "sortDirection" = ${SortDirection} + "delay" = ${Delay} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WaitForSingleSmsOptions + +.DESCRIPTION + +Convert from JSON to WaitForSingleSmsOptions + +.PARAMETER Json + +Json object + +.OUTPUTS + +WaitForSingleSmsOptions +#> +function ConvertFrom-JsonToWaitForSingleSmsOptions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WaitForSingleSmsOptions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WaitForSingleSmsOptions + $AllProperties = ("phoneNumberId", "timeout", "unreadOnly", "before", "since", "sortDirection", "delay") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'phoneNumberId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumberId"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumberId' missing." + } else { + $PhoneNumberId = $JsonParameters.PSobject.Properties["phoneNumberId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "timeout"))) { + throw "Error! JSON cannot be serialized due to the required property 'timeout' missing." + } else { + $Timeout = $JsonParameters.PSobject.Properties["timeout"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unreadOnly"))) { #optional property not found + $UnreadOnly = $null + } else { + $UnreadOnly = $JsonParameters.PSobject.Properties["unreadOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "before"))) { #optional property not found + $Before = $null + } else { + $Before = $JsonParameters.PSobject.Properties["before"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found + $Since = $null + } else { + $Since = $JsonParameters.PSobject.Properties["since"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sortDirection"))) { #optional property not found + $SortDirection = $null + } else { + $SortDirection = $JsonParameters.PSobject.Properties["sortDirection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "delay"))) { #optional property not found + $Delay = $null + } else { + $Delay = $JsonParameters.PSobject.Properties["delay"].value + } + + $PSO = [PSCustomObject]@{ + "phoneNumberId" = ${PhoneNumberId} + "timeout" = ${Timeout} + "unreadOnly" = ${UnreadOnly} + "before" = ${Before} + "since" = ${Since} + "sortDirection" = ${SortDirection} + "delay" = ${Delay} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WaitForSmsConditions.ps1 b/src/maislurp-client-powershell/Model/WaitForSmsConditions.ps1 new file mode 100644 index 00000000..575dca99 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WaitForSmsConditions.ps1 @@ -0,0 +1,246 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Conditions to apply to emails that you are waiting for + +.PARAMETER PhoneNumberId +ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count. +.PARAMETER Limit +Limit results +.PARAMETER Count +Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation. +.PARAMETER DelayTimeout +Max time in milliseconds to wait between retries if a `timeout` is specified. +.PARAMETER Timeout +Max time in milliseconds to retry the `waitFor` operation until conditions are met. +.PARAMETER UnreadOnly +Apply conditions only to **unread** SMS. All SMS messages begin with `read=false`. An SMS is marked `read=true` when an `SMS` has been returned to the user at least once. For example you have called `getSms` or `waitForSms` etc., or you have viewed the SMS in the dashboard. +.PARAMETER CountType +How result size should be compared with the expected size. Exactly or at-least matching result? +.PARAMETER VarMatches +Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for. +.PARAMETER SortDirection +Direction to sort matching SMSs by created time +.PARAMETER Since +ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date +.PARAMETER Before +ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date +.OUTPUTS + +WaitForSmsConditions +#> + +function Initialize-WaitForSmsConditions { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumberId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${Limit}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Count}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${DelayTimeout}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${Timeout}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UnreadOnly}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EXACTLY", "ATLEAST")] + [String] + ${CountType}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${VarMatches}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("ASC", "DESC")] + [String] + ${SortDirection}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Since}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Before} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WaitForSmsConditions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($PhoneNumberId -eq $null) { + throw "invalid value for 'PhoneNumberId', 'PhoneNumberId' cannot be null." + } + + if ($Count -eq $null) { + throw "invalid value for 'Count', 'Count' cannot be null." + } + + if ($Timeout -eq $null) { + throw "invalid value for 'Timeout', 'Timeout' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "phoneNumberId" = ${PhoneNumberId} + "limit" = ${Limit} + "count" = ${Count} + "delayTimeout" = ${DelayTimeout} + "timeout" = ${Timeout} + "unreadOnly" = ${UnreadOnly} + "countType" = ${CountType} + "matches" = ${VarMatches} + "sortDirection" = ${SortDirection} + "since" = ${Since} + "before" = ${Before} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WaitForSmsConditions + +.DESCRIPTION + +Convert from JSON to WaitForSmsConditions + +.PARAMETER Json + +Json object + +.OUTPUTS + +WaitForSmsConditions +#> +function ConvertFrom-JsonToWaitForSmsConditions { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WaitForSmsConditions' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WaitForSmsConditions + $AllProperties = ("phoneNumberId", "limit", "count", "delayTimeout", "timeout", "unreadOnly", "countType", "matches", "sortDirection", "since", "before") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'phoneNumberId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumberId"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumberId' missing." + } else { + $PhoneNumberId = $JsonParameters.PSobject.Properties["phoneNumberId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "count"))) { + throw "Error! JSON cannot be serialized due to the required property 'count' missing." + } else { + $Count = $JsonParameters.PSobject.Properties["count"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "timeout"))) { + throw "Error! JSON cannot be serialized due to the required property 'timeout' missing." + } else { + $Timeout = $JsonParameters.PSobject.Properties["timeout"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "limit"))) { #optional property not found + $Limit = $null + } else { + $Limit = $JsonParameters.PSobject.Properties["limit"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "delayTimeout"))) { #optional property not found + $DelayTimeout = $null + } else { + $DelayTimeout = $JsonParameters.PSobject.Properties["delayTimeout"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "unreadOnly"))) { #optional property not found + $UnreadOnly = $null + } else { + $UnreadOnly = $JsonParameters.PSobject.Properties["unreadOnly"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "countType"))) { #optional property not found + $CountType = $null + } else { + $CountType = $JsonParameters.PSobject.Properties["countType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "matches"))) { #optional property not found + $VarMatches = $null + } else { + $VarMatches = $JsonParameters.PSobject.Properties["matches"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sortDirection"))) { #optional property not found + $SortDirection = $null + } else { + $SortDirection = $JsonParameters.PSobject.Properties["sortDirection"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found + $Since = $null + } else { + $Since = $JsonParameters.PSobject.Properties["since"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "before"))) { #optional property not found + $Before = $null + } else { + $Before = $JsonParameters.PSobject.Properties["before"].value + } + + $PSO = [PSCustomObject]@{ + "phoneNumberId" = ${PhoneNumberId} + "limit" = ${Limit} + "count" = ${Count} + "delayTimeout" = ${DelayTimeout} + "timeout" = ${Timeout} + "unreadOnly" = ${UnreadOnly} + "countType" = ${CountType} + "matches" = ${VarMatches} + "sortDirection" = ${SortDirection} + "since" = ${Since} + "before" = ${Before} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookBouncePayload.ps1 b/src/maislurp-client-powershell/Model/WebhookBouncePayload.ps1 new file mode 100644 index 00000000..8a937ee8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookBouncePayload.ps1 @@ -0,0 +1,214 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER BounceId +ID of the bounce email record. Use the ID with the bounce controller to view more information +.PARAMETER SentToRecipients +Email sent to recipients +.PARAMETER VarSender +Sender causing bounce +.PARAMETER BounceRecipients +Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation. +.OUTPUTS + +WebhookBouncePayload +#> + +function Initialize-WebhookBouncePayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${BounceId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${SentToRecipients}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarSender}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${BounceRecipients} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookBouncePayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($BounceId -eq $null) { + throw "invalid value for 'BounceId', 'BounceId' cannot be null." + } + + if ($VarSender -eq $null) { + throw "invalid value for 'VarSender', 'VarSender' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "bounceId" = ${BounceId} + "sentToRecipients" = ${SentToRecipients} + "sender" = ${VarSender} + "bounceRecipients" = ${BounceRecipients} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookBouncePayload + +.DESCRIPTION + +Convert from JSON to WebhookBouncePayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookBouncePayload +#> +function ConvertFrom-JsonToWebhookBouncePayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookBouncePayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookBouncePayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "bounceId", "sentToRecipients", "sender", "bounceRecipients") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceId"))) { + throw "Error! JSON cannot be serialized due to the required property 'bounceId' missing." + } else { + $BounceId = $JsonParameters.PSobject.Properties["bounceId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sender"))) { + throw "Error! JSON cannot be serialized due to the required property 'sender' missing." + } else { + $VarSender = $JsonParameters.PSobject.Properties["sender"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentToRecipients"))) { #optional property not found + $SentToRecipients = $null + } else { + $SentToRecipients = $JsonParameters.PSobject.Properties["sentToRecipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bounceRecipients"))) { #optional property not found + $BounceRecipients = $null + } else { + $BounceRecipients = $JsonParameters.PSobject.Properties["bounceRecipients"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "bounceId" = ${BounceId} + "sentToRecipients" = ${SentToRecipients} + "sender" = ${VarSender} + "bounceRecipients" = ${BounceRecipients} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookBounceRecipientPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookBounceRecipientPayload.ps1 new file mode 100644 index 00000000..7ad78c6f --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookBounceRecipientPayload.ps1 @@ -0,0 +1,171 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +BOUNCE_RECIPIENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email caused a bounce to occur for a recipient. Save the recipient to a ban list of your server and avoid email them again. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER Recipient +Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation. +.OUTPUTS + +WebhookBounceRecipientPayload +#> + +function Initialize-WebhookBounceRecipientPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookBounceRecipientPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($Recipient -eq $null) { + throw "invalid value for 'Recipient', 'Recipient' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "recipient" = ${Recipient} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookBounceRecipientPayload + +.DESCRIPTION + +Convert from JSON to WebhookBounceRecipientPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookBounceRecipientPayload +#> +function ConvertFrom-JsonToWebhookBounceRecipientPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookBounceRecipientPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookBounceRecipientPayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "recipient") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { + throw "Error! JSON cannot be serialized due to the required property 'recipient' missing." + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "recipient" = ${Recipient} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookDeliveryStatusPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookDeliveryStatusPayload.ps1 new file mode 100644 index 00000000..22791eed --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookDeliveryStatusPayload.ps1 @@ -0,0 +1,318 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER Id +ID of delivery status +.PARAMETER UserId +User ID of event +.PARAMETER SentId +ID of sent email +.PARAMETER RemoteMtaIp +IP address of the remote Mail Transfer Agent +.PARAMETER InboxId +Id of the inbox +.PARAMETER ReportingMta +Mail Transfer Agent reporting delivery status +.PARAMETER Recipients +Recipients for delivery +.PARAMETER SmtpResponse +SMTP server response message +.PARAMETER SmtpStatusCode +SMTP server status +.PARAMETER ProcessingTimeMillis +Time in milliseconds for delivery processing +.PARAMETER Received +Time event was received +.PARAMETER Subject +Email subject +.OUTPUTS + +WebhookDeliveryStatusPayload +#> + +function Initialize-WebhookDeliveryStatusPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentId}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${RemoteMtaIp}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${ReportingMta}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Recipients}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmtpResponse}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${SmtpStatusCode}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int64]] + ${ProcessingTimeMillis}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${Received}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookDeliveryStatusPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "id" = ${Id} + "userId" = ${UserId} + "sentId" = ${SentId} + "remoteMtaIp" = ${RemoteMtaIp} + "inboxId" = ${InboxId} + "reportingMta" = ${ReportingMta} + "recipients" = ${Recipients} + "smtpResponse" = ${SmtpResponse} + "smtpStatusCode" = ${SmtpStatusCode} + "processingTimeMillis" = ${ProcessingTimeMillis} + "received" = ${Received} + "subject" = ${Subject} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookDeliveryStatusPayload + +.DESCRIPTION + +Convert from JSON to WebhookDeliveryStatusPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookDeliveryStatusPayload +#> +function ConvertFrom-JsonToWebhookDeliveryStatusPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookDeliveryStatusPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookDeliveryStatusPayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "id", "userId", "sentId", "remoteMtaIp", "inboxId", "reportingMta", "recipients", "smtpResponse", "smtpStatusCode", "processingTimeMillis", "received", "subject") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentId"))) { #optional property not found + $SentId = $null + } else { + $SentId = $JsonParameters.PSobject.Properties["sentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "remoteMtaIp"))) { #optional property not found + $RemoteMtaIp = $null + } else { + $RemoteMtaIp = $JsonParameters.PSobject.Properties["remoteMtaIp"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "reportingMta"))) { #optional property not found + $ReportingMta = $null + } else { + $ReportingMta = $JsonParameters.PSobject.Properties["reportingMta"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipients"))) { #optional property not found + $Recipients = $null + } else { + $Recipients = $JsonParameters.PSobject.Properties["recipients"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpResponse"))) { #optional property not found + $SmtpResponse = $null + } else { + $SmtpResponse = $JsonParameters.PSobject.Properties["smtpResponse"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smtpStatusCode"))) { #optional property not found + $SmtpStatusCode = $null + } else { + $SmtpStatusCode = $JsonParameters.PSobject.Properties["smtpStatusCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "processingTimeMillis"))) { #optional property not found + $ProcessingTimeMillis = $null + } else { + $ProcessingTimeMillis = $JsonParameters.PSobject.Properties["processingTimeMillis"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "received"))) { #optional property not found + $Received = $null + } else { + $Received = $JsonParameters.PSobject.Properties["received"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "id" = ${Id} + "userId" = ${UserId} + "sentId" = ${SentId} + "remoteMtaIp" = ${RemoteMtaIp} + "inboxId" = ${InboxId} + "reportingMta" = ${ReportingMta} + "recipients" = ${Recipients} + "smtpResponse" = ${SmtpResponse} + "smtpStatusCode" = ${SmtpStatusCode} + "processingTimeMillis" = ${ProcessingTimeMillis} + "received" = ${Received} + "subject" = ${Subject} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookDto.ps1 b/src/maislurp-client-powershell/Model/WebhookDto.ps1 new file mode 100644 index 00000000..702b55bc --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookDto.ps1 @@ -0,0 +1,327 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://api.mailslurp.com/schemas/webhook-payload for the payload schema. + +.PARAMETER Id +ID of the Webhook +.PARAMETER UserId +User ID of the Webhook +.PARAMETER BasicAuth +Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. +.PARAMETER Name +Name of the webhook +.PARAMETER PhoneId +The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set +.PARAMETER InboxId +The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set +.PARAMETER RequestBodyTemplate +Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. +.PARAMETER Url +URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. +.PARAMETER Method +HTTP method that your server endpoint must listen for +.PARAMETER PayloadJsonSchema +Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method +.PARAMETER CreatedAt +When the webhook was created +.PARAMETER UpdatedAt +No description available. +.PARAMETER EventName +Webhook trigger event name +.PARAMETER RequestHeaders +No description available. +.PARAMETER IgnoreInsecureSslCertificates +Should notifier ignore insecure SSL certificates +.PARAMETER UseStaticIpRange +Should notifier use static IP range when sending webhook payload +.OUTPUTS + +WebhookDto +#> + +function Initialize-WebhookDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${BasicAuth}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${RequestBodyTemplate}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE")] + [String] + ${Method}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${PayloadJsonSchema}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[System.DateTime]] + ${CreatedAt}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${RequestHeaders}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${IgnoreInsecureSslCertificates}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Boolean]] + ${UseStaticIpRange} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($BasicAuth -eq $null) { + throw "invalid value for 'BasicAuth', 'BasicAuth' cannot be null." + } + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($Method -eq $null) { + throw "invalid value for 'Method', 'Method' cannot be null." + } + + if ($PayloadJsonSchema -eq $null) { + throw "invalid value for 'PayloadJsonSchema', 'PayloadJsonSchema' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "basicAuth" = ${BasicAuth} + "name" = ${Name} + "phoneId" = ${PhoneId} + "inboxId" = ${InboxId} + "requestBodyTemplate" = ${RequestBodyTemplate} + "url" = ${Url} + "method" = ${Method} + "payloadJsonSchema" = ${PayloadJsonSchema} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "eventName" = ${EventName} + "requestHeaders" = ${RequestHeaders} + "ignoreInsecureSslCertificates" = ${IgnoreInsecureSslCertificates} + "useStaticIpRange" = ${UseStaticIpRange} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookDto + +.DESCRIPTION + +Convert from JSON to WebhookDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookDto +#> +function ConvertFrom-JsonToWebhookDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookDto + $AllProperties = ("id", "userId", "basicAuth", "name", "phoneId", "inboxId", "requestBodyTemplate", "url", "method", "payloadJsonSchema", "createdAt", "updatedAt", "eventName", "requestHeaders", "ignoreInsecureSslCertificates", "useStaticIpRange") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'id' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "basicAuth"))) { + throw "Error! JSON cannot be serialized due to the required property 'basicAuth' missing." + } else { + $BasicAuth = $JsonParameters.PSobject.Properties["basicAuth"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "method"))) { + throw "Error! JSON cannot be serialized due to the required property 'method' missing." + } else { + $Method = $JsonParameters.PSobject.Properties["method"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "payloadJsonSchema"))) { + throw "Error! JSON cannot be serialized due to the required property 'payloadJsonSchema' missing." + } else { + $PayloadJsonSchema = $JsonParameters.PSobject.Properties["payloadJsonSchema"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneId"))) { #optional property not found + $PhoneId = $null + } else { + $PhoneId = $JsonParameters.PSobject.Properties["phoneId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "requestBodyTemplate"))) { #optional property not found + $RequestBodyTemplate = $null + } else { + $RequestBodyTemplate = $JsonParameters.PSobject.Properties["requestBodyTemplate"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { #optional property not found + $EventName = $null + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "requestHeaders"))) { #optional property not found + $RequestHeaders = $null + } else { + $RequestHeaders = $JsonParameters.PSobject.Properties["requestHeaders"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "ignoreInsecureSslCertificates"))) { #optional property not found + $IgnoreInsecureSslCertificates = $null + } else { + $IgnoreInsecureSslCertificates = $JsonParameters.PSobject.Properties["ignoreInsecureSslCertificates"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "useStaticIpRange"))) { #optional property not found + $UseStaticIpRange = $null + } else { + $UseStaticIpRange = $JsonParameters.PSobject.Properties["useStaticIpRange"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "basicAuth" = ${BasicAuth} + "name" = ${Name} + "phoneId" = ${PhoneId} + "inboxId" = ${InboxId} + "requestBodyTemplate" = ${RequestBodyTemplate} + "url" = ${Url} + "method" = ${Method} + "payloadJsonSchema" = ${PayloadJsonSchema} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "eventName" = ${EventName} + "requestHeaders" = ${RequestHeaders} + "ignoreInsecureSslCertificates" = ${IgnoreInsecureSslCertificates} + "useStaticIpRange" = ${UseStaticIpRange} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookEmailOpenedPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookEmailOpenedPayload.ps1 new file mode 100644 index 00000000..4bf5d3a8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookEmailOpenedPayload.ps1 @@ -0,0 +1,239 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER InboxId +Id of the inbox +.PARAMETER PixelId +ID of the tracking pixel +.PARAMETER SentEmailId +ID of sent email +.PARAMETER Recipient +Email address for the recipient of the tracking pixel +.PARAMETER CreatedAt +Date time of event creation +.OUTPUTS + +WebhookEmailOpenedPayload +#> + +function Initialize-WebhookEmailOpenedPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${PixelId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${SentEmailId}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Recipient}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookEmailOpenedPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($PixelId -eq $null) { + throw "invalid value for 'PixelId', 'PixelId' cannot be null." + } + + if ($SentEmailId -eq $null) { + throw "invalid value for 'SentEmailId', 'SentEmailId' cannot be null." + } + + if ($Recipient -eq $null) { + throw "invalid value for 'Recipient', 'Recipient' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "inboxId" = ${InboxId} + "pixelId" = ${PixelId} + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookEmailOpenedPayload + +.DESCRIPTION + +Convert from JSON to WebhookEmailOpenedPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookEmailOpenedPayload +#> +function ConvertFrom-JsonToWebhookEmailOpenedPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookEmailOpenedPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookEmailOpenedPayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "inboxId", "pixelId", "sentEmailId", "recipient", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "pixelId"))) { + throw "Error! JSON cannot be serialized due to the required property 'pixelId' missing." + } else { + $PixelId = $JsonParameters.PSobject.Properties["pixelId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "sentEmailId"))) { + throw "Error! JSON cannot be serialized due to the required property 'sentEmailId' missing." + } else { + $SentEmailId = $JsonParameters.PSobject.Properties["sentEmailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "recipient"))) { + throw "Error! JSON cannot be serialized due to the required property 'recipient' missing." + } else { + $Recipient = $JsonParameters.PSobject.Properties["recipient"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "inboxId" = ${InboxId} + "pixelId" = ${PixelId} + "sentEmailId" = ${SentEmailId} + "recipient" = ${Recipient} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookEmailReadPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookEmailReadPayload.ps1 new file mode 100644 index 00000000..c707b9a8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookEmailReadPayload.ps1 @@ -0,0 +1,222 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER EmailId +ID of the email that was received. Use this ID for fetching the email with the `EmailController`. +.PARAMETER InboxId +Id of the inbox +.PARAMETER EmailIsRead +Is the email read +.PARAMETER CreatedAt +Date time of event creation +.OUTPUTS + +WebhookEmailReadPayload +#> + +function Initialize-WebhookEmailReadPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${EmailIsRead}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookEmailReadPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($EmailId -eq $null) { + throw "invalid value for 'EmailId', 'EmailId' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($EmailIsRead -eq $null) { + throw "invalid value for 'EmailIsRead', 'EmailIsRead' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "emailId" = ${EmailId} + "inboxId" = ${InboxId} + "emailIsRead" = ${EmailIsRead} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookEmailReadPayload + +.DESCRIPTION + +Convert from JSON to WebhookEmailReadPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookEmailReadPayload +#> +function ConvertFrom-JsonToWebhookEmailReadPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookEmailReadPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookEmailReadPayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "emailId", "inboxId", "emailIsRead", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailId' missing." + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailIsRead"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailIsRead' missing." + } else { + $EmailIsRead = $JsonParameters.PSobject.Properties["emailIsRead"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "emailId" = ${EmailId} + "inboxId" = ${InboxId} + "emailIsRead" = ${EmailIsRead} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookHeaderNameValue.ps1 b/src/maislurp-client-powershell/Model/WebhookHeaderNameValue.ps1 new file mode 100644 index 00000000..61d2ba6e --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookHeaderNameValue.ps1 @@ -0,0 +1,123 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Name value pair for webhook header + +.PARAMETER Name +Name of header +.PARAMETER Value +Value of header +.OUTPUTS + +WebhookHeaderNameValue +#> + +function Initialize-WebhookHeaderNameValue { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Value} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookHeaderNameValue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($Value -eq $null) { + throw "invalid value for 'Value', 'Value' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "value" = ${Value} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookHeaderNameValue + +.DESCRIPTION + +Convert from JSON to WebhookHeaderNameValue + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookHeaderNameValue +#> +function ConvertFrom-JsonToWebhookHeaderNameValue { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookHeaderNameValue' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookHeaderNameValue + $AllProperties = ("name", "value") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "value"))) { + throw "Error! JSON cannot be serialized due to the required property 'value' missing." + } else { + $Value = $JsonParameters.PSobject.Properties["value"].value + } + + $PSO = [PSCustomObject]@{ + "name" = ${Name} + "value" = ${Value} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookHeaders.ps1 b/src/maislurp-client-powershell/Model/WebhookHeaders.ps1 new file mode 100644 index 00000000..fbacb7b8 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookHeaders.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Webhook HTTP headers to include with each request from MailSlurp to your server + +.PARAMETER Headers +List of header name value pairs to include with webhook requests +.OUTPUTS + +WebhookHeaders +#> + +function Initialize-WebhookHeaders { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${Headers} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookHeaders' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Headers -eq $null) { + throw "invalid value for 'Headers', 'Headers' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "headers" = ${Headers} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookHeaders + +.DESCRIPTION + +Convert from JSON to WebhookHeaders + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookHeaders +#> +function ConvertFrom-JsonToWebhookHeaders { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookHeaders' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookHeaders + $AllProperties = ("headers") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'headers' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "headers"))) { + throw "Error! JSON cannot be serialized due to the required property 'headers' missing." + } else { + $Headers = $JsonParameters.PSobject.Properties["headers"].value + } + + $PSO = [PSCustomObject]@{ + "headers" = ${Headers} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookNewAttachmentPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookNewAttachmentPayload.ps1 new file mode 100644 index 00000000..448a43a3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookNewAttachmentPayload.ps1 @@ -0,0 +1,222 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains an attachment. You can use the attachmentId to download the attachment. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER AttachmentId +ID of attachment. Use the `AttachmentController` to +.PARAMETER Name +Filename of the attachment if present +.PARAMETER ContentType +Content type of attachment such as 'image/png' or 'application/pdf +.PARAMETER ContentLength +Size of attachment in bytes +.OUTPUTS + +WebhookNewAttachmentPayload +#> + +function Initialize-WebhookNewAttachmentPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${AttachmentId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContentType}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${ContentLength} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookNewAttachmentPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($AttachmentId -eq $null) { + throw "invalid value for 'AttachmentId', 'AttachmentId' cannot be null." + } + + if ($Name -eq $null) { + throw "invalid value for 'Name', 'Name' cannot be null." + } + + if ($ContentType -eq $null) { + throw "invalid value for 'ContentType', 'ContentType' cannot be null." + } + + if ($ContentLength -eq $null) { + throw "invalid value for 'ContentLength', 'ContentLength' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "webhookName" = ${WebhookName} + "eventName" = ${EventName} + "attachmentId" = ${AttachmentId} + "name" = ${Name} + "contentType" = ${ContentType} + "contentLength" = ${ContentLength} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookNewAttachmentPayload + +.DESCRIPTION + +Convert from JSON to WebhookNewAttachmentPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookNewAttachmentPayload +#> +function ConvertFrom-JsonToWebhookNewAttachmentPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookNewAttachmentPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookNewAttachmentPayload + $AllProperties = ("messageId", "webhookId", "webhookName", "eventName", "attachmentId", "name", "contentType", "contentLength") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachmentId"))) { + throw "Error! JSON cannot be serialized due to the required property 'attachmentId' missing." + } else { + $AttachmentId = $JsonParameters.PSobject.Properties["attachmentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { + throw "Error! JSON cannot be serialized due to the required property 'name' missing." + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentType"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentType' missing." + } else { + $ContentType = $JsonParameters.PSobject.Properties["contentType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contentLength"))) { + throw "Error! JSON cannot be serialized due to the required property 'contentLength' missing." + } else { + $ContentLength = $JsonParameters.PSobject.Properties["contentLength"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "webhookName" = ${WebhookName} + "eventName" = ${EventName} + "attachmentId" = ${AttachmentId} + "name" = ${Name} + "contentType" = ${ContentType} + "contentLength" = ${ContentLength} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookNewContactPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookNewContactPayload.ps1 new file mode 100644 index 00000000..2700c79e --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookNewContactPayload.ps1 @@ -0,0 +1,317 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER ContactId +Contact ID +.PARAMETER GroupId +Contact group ID +.PARAMETER FirstName +Contact first name +.PARAMETER LastName +Contact last name +.PARAMETER Company +Contact company name +.PARAMETER PrimaryEmailAddress +Primary email address for contact +.PARAMETER EmailAddresses +Email addresses for contact +.PARAMETER Tags +Tags for contact +.PARAMETER MetaData +No description available. +.PARAMETER OptOut +Has contact opted out of emails +.PARAMETER CreatedAt +Date time of event creation +.OUTPUTS + +WebhookNewContactPayload +#> + +function Initialize-WebhookNewContactPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${ContactId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${GroupId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${FirstName}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${LastName}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${Company}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${PrimaryEmailAddress}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${EmailAddresses}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Tags}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${MetaData}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${OptOut}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookNewContactPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($ContactId -eq $null) { + throw "invalid value for 'ContactId', 'ContactId' cannot be null." + } + + if ($EmailAddresses -eq $null) { + throw "invalid value for 'EmailAddresses', 'EmailAddresses' cannot be null." + } + + if ($Tags -eq $null) { + throw "invalid value for 'Tags', 'Tags' cannot be null." + } + + if ($OptOut -eq $null) { + throw "invalid value for 'OptOut', 'OptOut' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "webhookName" = ${WebhookName} + "eventName" = ${EventName} + "contactId" = ${ContactId} + "groupId" = ${GroupId} + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "primaryEmailAddress" = ${PrimaryEmailAddress} + "emailAddresses" = ${EmailAddresses} + "tags" = ${Tags} + "metaData" = ${MetaData} + "optOut" = ${OptOut} + "createdAt" = ${CreatedAt} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookNewContactPayload + +.DESCRIPTION + +Convert from JSON to WebhookNewContactPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookNewContactPayload +#> +function ConvertFrom-JsonToWebhookNewContactPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookNewContactPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookNewContactPayload + $AllProperties = ("messageId", "webhookId", "webhookName", "eventName", "contactId", "groupId", "firstName", "lastName", "company", "primaryEmailAddress", "emailAddresses", "tags", "metaData", "optOut", "createdAt") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "contactId"))) { + throw "Error! JSON cannot be serialized due to the required property 'contactId' missing." + } else { + $ContactId = $JsonParameters.PSobject.Properties["contactId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailAddresses"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailAddresses' missing." + } else { + $EmailAddresses = $JsonParameters.PSobject.Properties["emailAddresses"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "tags"))) { + throw "Error! JSON cannot be serialized due to the required property 'tags' missing." + } else { + $Tags = $JsonParameters.PSobject.Properties["tags"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "optOut"))) { + throw "Error! JSON cannot be serialized due to the required property 'optOut' missing." + } else { + $OptOut = $JsonParameters.PSobject.Properties["optOut"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "groupId"))) { #optional property not found + $GroupId = $null + } else { + $GroupId = $JsonParameters.PSobject.Properties["groupId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "firstName"))) { #optional property not found + $FirstName = $null + } else { + $FirstName = $JsonParameters.PSobject.Properties["firstName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "lastName"))) { #optional property not found + $LastName = $null + } else { + $LastName = $JsonParameters.PSobject.Properties["lastName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "company"))) { #optional property not found + $Company = $null + } else { + $Company = $JsonParameters.PSobject.Properties["company"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "primaryEmailAddress"))) { #optional property not found + $PrimaryEmailAddress = $null + } else { + $PrimaryEmailAddress = $JsonParameters.PSobject.Properties["primaryEmailAddress"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "metaData"))) { #optional property not found + $MetaData = $null + } else { + $MetaData = $JsonParameters.PSobject.Properties["metaData"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "webhookName" = ${WebhookName} + "eventName" = ${EventName} + "contactId" = ${ContactId} + "groupId" = ${GroupId} + "firstName" = ${FirstName} + "lastName" = ${LastName} + "company" = ${Company} + "primaryEmailAddress" = ${PrimaryEmailAddress} + "emailAddresses" = ${EmailAddresses} + "tags" = ${Tags} + "metaData" = ${MetaData} + "optOut" = ${OptOut} + "createdAt" = ${CreatedAt} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookNewEmailPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookNewEmailPayload.ps1 new file mode 100644 index 00000000..d7751c4a --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookNewEmailPayload.ps1 @@ -0,0 +1,316 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER InboxId +Id of the inbox +.PARAMETER DomainId +Id of the domain that received an email +.PARAMETER EmailId +ID of the email that was received. Use this ID for fetching the email with the `EmailController`. +.PARAMETER CreatedAt +Date time of event creation +.PARAMETER To +List of `To` recipient email addresses that the email was addressed to. See recipients object for names. +.PARAMETER VarFrom +Who the email was sent from. An email address - see fromName for the sender name. +.PARAMETER Cc +List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. +.PARAMETER Bcc +List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. +.PARAMETER Subject +The subject line of the email message as specified by SMTP subject header +.PARAMETER AttachmentMetaDatas +List of attachment meta data objects if attachments present +.OUTPUTS + +WebhookNewEmailPayload +#> + +function Initialize-WebhookNewEmailPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${DomainId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${To}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${VarFrom}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Cc}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [String[]] + ${Bcc}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [String] + ${Subject}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject[]] + ${AttachmentMetaDatas} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookNewEmailPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($InboxId -eq $null) { + throw "invalid value for 'InboxId', 'InboxId' cannot be null." + } + + if ($EmailId -eq $null) { + throw "invalid value for 'EmailId', 'EmailId' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($To -eq $null) { + throw "invalid value for 'To', 'To' cannot be null." + } + + if ($VarFrom -eq $null) { + throw "invalid value for 'VarFrom', 'VarFrom' cannot be null." + } + + if ($Cc -eq $null) { + throw "invalid value for 'Cc', 'Cc' cannot be null." + } + + if ($Bcc -eq $null) { + throw "invalid value for 'Bcc', 'Bcc' cannot be null." + } + + if ($AttachmentMetaDatas -eq $null) { + throw "invalid value for 'AttachmentMetaDatas', 'AttachmentMetaDatas' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "inboxId" = ${InboxId} + "domainId" = ${DomainId} + "emailId" = ${EmailId} + "createdAt" = ${CreatedAt} + "to" = ${To} + "from" = ${VarFrom} + "cc" = ${Cc} + "bcc" = ${Bcc} + "subject" = ${Subject} + "attachmentMetaDatas" = ${AttachmentMetaDatas} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookNewEmailPayload + +.DESCRIPTION + +Convert from JSON to WebhookNewEmailPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookNewEmailPayload +#> +function ConvertFrom-JsonToWebhookNewEmailPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookNewEmailPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookNewEmailPayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "inboxId", "domainId", "emailId", "createdAt", "to", "from", "cc", "bcc", "subject", "attachmentMetaDatas") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { + throw "Error! JSON cannot be serialized due to the required property 'inboxId' missing." + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { + throw "Error! JSON cannot be serialized due to the required property 'emailId' missing." + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "to"))) { + throw "Error! JSON cannot be serialized due to the required property 'to' missing." + } else { + $To = $JsonParameters.PSobject.Properties["to"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "from"))) { + throw "Error! JSON cannot be serialized due to the required property 'from' missing." + } else { + $VarFrom = $JsonParameters.PSobject.Properties["from"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "cc"))) { + throw "Error! JSON cannot be serialized due to the required property 'cc' missing." + } else { + $Cc = $JsonParameters.PSobject.Properties["cc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "bcc"))) { + throw "Error! JSON cannot be serialized due to the required property 'bcc' missing." + } else { + $Bcc = $JsonParameters.PSobject.Properties["bcc"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachmentMetaDatas"))) { + throw "Error! JSON cannot be serialized due to the required property 'attachmentMetaDatas' missing." + } else { + $AttachmentMetaDatas = $JsonParameters.PSobject.Properties["attachmentMetaDatas"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "domainId"))) { #optional property not found + $DomainId = $null + } else { + $DomainId = $JsonParameters.PSobject.Properties["domainId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "subject"))) { #optional property not found + $Subject = $null + } else { + $Subject = $JsonParameters.PSobject.Properties["subject"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "inboxId" = ${InboxId} + "domainId" = ${DomainId} + "emailId" = ${EmailId} + "createdAt" = ${CreatedAt} + "to" = ${To} + "from" = ${VarFrom} + "cc" = ${Cc} + "bcc" = ${Bcc} + "subject" = ${Subject} + "attachmentMetaDatas" = ${AttachmentMetaDatas} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookNewSmsPayload.ps1 b/src/maislurp-client-powershell/Model/WebhookNewSmsPayload.ps1 new file mode 100644 index 00000000..78775146 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookNewSmsPayload.ps1 @@ -0,0 +1,273 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +NEW_SMS webhook payload. Sent to your webhook url endpoint via HTTP POST when an sms is received by the phone number that your webhook is attached to. Use the SMS ID to fetch the full SMS details. + +.PARAMETER MessageId +Idempotent message ID. Store this ID locally or in a database to prevent message duplication. +.PARAMETER WebhookId +ID of webhook entity being triggered +.PARAMETER EventName +Name of the event type webhook is being triggered for. +.PARAMETER WebhookName +Name of the webhook being triggered +.PARAMETER SmsId +ID of SMS message +.PARAMETER UserId +User ID of event +.PARAMETER PhoneNumber +ID of phone number receiving SMS +.PARAMETER ToNumber +Recipient phone number +.PARAMETER FromNumber +Sender phone number +.PARAMETER Body +SMS message body +.PARAMETER Read +SMS has been read +.OUTPUTS + +WebhookNewSmsPayload +#> + +function Initialize-WebhookNewSmsPayload { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookName}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmsId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumber}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${ToNumber}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [String] + ${FromNumber}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [String] + ${Body}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Read} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookNewSmsPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($EventName -eq $null) { + throw "invalid value for 'EventName', 'EventName' cannot be null." + } + + if ($SmsId -eq $null) { + throw "invalid value for 'SmsId', 'SmsId' cannot be null." + } + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($PhoneNumber -eq $null) { + throw "invalid value for 'PhoneNumber', 'PhoneNumber' cannot be null." + } + + if ($ToNumber -eq $null) { + throw "invalid value for 'ToNumber', 'ToNumber' cannot be null." + } + + if ($FromNumber -eq $null) { + throw "invalid value for 'FromNumber', 'FromNumber' cannot be null." + } + + if ($Body -eq $null) { + throw "invalid value for 'Body', 'Body' cannot be null." + } + + if ($Read -eq $null) { + throw "invalid value for 'Read', 'Read' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "smsId" = ${SmsId} + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "toNumber" = ${ToNumber} + "fromNumber" = ${FromNumber} + "body" = ${Body} + "read" = ${Read} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookNewSmsPayload + +.DESCRIPTION + +Convert from JSON to WebhookNewSmsPayload + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookNewSmsPayload +#> +function ConvertFrom-JsonToWebhookNewSmsPayload { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookNewSmsPayload' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookNewSmsPayload + $AllProperties = ("messageId", "webhookId", "eventName", "webhookName", "smsId", "userId", "phoneNumber", "toNumber", "fromNumber", "body", "read") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'messageId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { + throw "Error! JSON cannot be serialized due to the required property 'eventName' missing." + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smsId"))) { + throw "Error! JSON cannot be serialized due to the required property 'smsId' missing." + } else { + $SmsId = $JsonParameters.PSobject.Properties["smsId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'phoneNumber' missing." + } else { + $PhoneNumber = $JsonParameters.PSobject.Properties["phoneNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "toNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'toNumber' missing." + } else { + $ToNumber = $JsonParameters.PSobject.Properties["toNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "fromNumber"))) { + throw "Error! JSON cannot be serialized due to the required property 'fromNumber' missing." + } else { + $FromNumber = $JsonParameters.PSobject.Properties["fromNumber"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "body"))) { + throw "Error! JSON cannot be serialized due to the required property 'body' missing." + } else { + $Body = $JsonParameters.PSobject.Properties["body"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "read"))) { + throw "Error! JSON cannot be serialized due to the required property 'read' missing." + } else { + $Read = $JsonParameters.PSobject.Properties["read"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookName"))) { #optional property not found + $WebhookName = $null + } else { + $WebhookName = $JsonParameters.PSobject.Properties["webhookName"].value + } + + $PSO = [PSCustomObject]@{ + "messageId" = ${MessageId} + "webhookId" = ${WebhookId} + "eventName" = ${EventName} + "webhookName" = ${WebhookName} + "smsId" = ${SmsId} + "userId" = ${UserId} + "phoneNumber" = ${PhoneNumber} + "toNumber" = ${ToNumber} + "fromNumber" = ${FromNumber} + "body" = ${Body} + "read" = ${Read} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookProjection.ps1 b/src/maislurp-client-powershell/Model/WebhookProjection.ps1 new file mode 100644 index 00000000..c25e9c48 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookProjection.ps1 @@ -0,0 +1,210 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Representation of a webhook + +.PARAMETER Url +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER EventName +No description available. +.PARAMETER PhoneNumberId +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.PARAMETER Name +No description available. +.PARAMETER Id +No description available. +.OUTPUTS + +WebhookProjection +#> + +function Initialize-WebhookProjection { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${EventName}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneNumberId}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [String] + ${Name}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($Id -eq $null) { + throw "invalid value for 'Id', 'Id' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "inboxId" = ${InboxId} + "eventName" = ${EventName} + "phoneNumberId" = ${PhoneNumberId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "id" = ${Id} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookProjection + +.DESCRIPTION + +Convert from JSON to WebhookProjection + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookProjection +#> +function ConvertFrom-JsonToWebhookProjection { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookProjection' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookProjection + $AllProperties = ("url", "inboxId", "eventName", "phoneNumberId", "createdAt", "updatedAt", "name", "id") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'url' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { + throw "Error! JSON cannot be serialized due to the required property 'id' missing." + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "eventName"))) { #optional property not found + $EventName = $null + } else { + $EventName = $JsonParameters.PSobject.Properties["eventName"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneNumberId"))) { #optional property not found + $PhoneNumberId = $null + } else { + $PhoneNumberId = $JsonParameters.PSobject.Properties["phoneNumberId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { #optional property not found + $Name = $null + } else { + $Name = $JsonParameters.PSobject.Properties["name"].value + } + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "inboxId" = ${InboxId} + "eventName" = ${EventName} + "phoneNumberId" = ${PhoneNumberId} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "name" = ${Name} + "id" = ${Id} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookRedriveAllResult.ps1 b/src/maislurp-client-powershell/Model/WebhookRedriveAllResult.ps1 new file mode 100644 index 00000000..6408c3e2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookRedriveAllResult.ps1 @@ -0,0 +1,119 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of retrying all failed webhook + +.PARAMETER Success +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +WebhookRedriveAllResult +#> + +function Initialize-WebhookRedriveAllResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Success}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookRedriveAllResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Success -eq $null) { + throw "invalid value for 'Success', 'Success' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "success" = ${Success} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookRedriveAllResult + +.DESCRIPTION + +Convert from JSON to WebhookRedriveAllResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookRedriveAllResult +#> +function ConvertFrom-JsonToWebhookRedriveAllResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookRedriveAllResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookRedriveAllResult + $AllProperties = ("success", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'success' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "success"))) { + throw "Error! JSON cannot be serialized due to the required property 'success' missing." + } else { + $Success = $JsonParameters.PSobject.Properties["success"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "success" = ${Success} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookRedriveResult.ps1 b/src/maislurp-client-powershell/Model/WebhookRedriveResult.ps1 new file mode 100644 index 00000000..9e0c0ae2 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookRedriveResult.ps1 @@ -0,0 +1,136 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of retrying webhook + +.PARAMETER WebhookResultId +No description available. +.PARAMETER Success +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +WebhookRedriveResult +#> + +function Initialize-WebhookRedriveResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookResultId}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Success}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookRedriveResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($WebhookResultId -eq $null) { + throw "invalid value for 'WebhookResultId', 'WebhookResultId' cannot be null." + } + + if ($Success -eq $null) { + throw "invalid value for 'Success', 'Success' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "webhookResultId" = ${WebhookResultId} + "success" = ${Success} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookRedriveResult + +.DESCRIPTION + +Convert from JSON to WebhookRedriveResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookRedriveResult +#> +function ConvertFrom-JsonToWebhookRedriveResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookRedriveResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookRedriveResult + $AllProperties = ("webhookResultId", "success", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'webhookResultId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookResultId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookResultId' missing." + } else { + $WebhookResultId = $JsonParameters.PSobject.Properties["webhookResultId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "success"))) { + throw "Error! JSON cannot be serialized due to the required property 'success' missing." + } else { + $Success = $JsonParameters.PSobject.Properties["success"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "webhookResultId" = ${WebhookResultId} + "success" = ${Success} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookResultDto.ps1 b/src/maislurp-client-powershell/Model/WebhookResultDto.ps1 new file mode 100644 index 00000000..ec5286c4 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookResultDto.ps1 @@ -0,0 +1,392 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of a webhook notification + +.PARAMETER Id +No description available. +.PARAMETER UserId +No description available. +.PARAMETER WebhookId +No description available. +.PARAMETER WebhookUrl +No description available. +.PARAMETER MessageId +No description available. +.PARAMETER RedriveId +No description available. +.PARAMETER HttpMethod +No description available. +.PARAMETER WebhookEvent +No description available. +.PARAMETER ResponseStatus +No description available. +.PARAMETER ResponseTimeMillis +No description available. +.PARAMETER ResponseBodyExtract +No description available. +.PARAMETER ResultType +No description available. +.PARAMETER CreatedAt +No description available. +.PARAMETER UpdatedAt +No description available. +.PARAMETER Seen +No description available. +.PARAMETER InboxId +No description available. +.PARAMETER EmailId +No description available. +.PARAMETER AttachmentId +No description available. +.PARAMETER PhoneId +No description available. +.PARAMETER SmsId +No description available. +.OUTPUTS + +WebhookResultDto +#> + +function Initialize-WebhookResultDto { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Id}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${UserId}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookId}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${WebhookUrl}, + [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true)] + [String] + ${MessageId}, + [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true)] + [String] + ${RedriveId}, + [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE")] + [String] + ${HttpMethod}, + [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS")] + [String] + ${WebhookEvent}, + [Parameter(Position = 8, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${ResponseStatus}, + [Parameter(Position = 9, ValueFromPipelineByPropertyName = $true)] + [Int64] + ${ResponseTimeMillis}, + [Parameter(Position = 10, ValueFromPipelineByPropertyName = $true)] + [String] + ${ResponseBodyExtract}, + [Parameter(Position = 11, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("BAD_RESPONSE", "EXCEPTION", "SUCCESS", "REDRIVEN")] + [String] + ${ResultType}, + [Parameter(Position = 12, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${CreatedAt}, + [Parameter(Position = 13, ValueFromPipelineByPropertyName = $true)] + [System.DateTime] + ${UpdatedAt}, + [Parameter(Position = 14, ValueFromPipelineByPropertyName = $true)] + [Boolean] + ${Seen}, + [Parameter(Position = 15, ValueFromPipelineByPropertyName = $true)] + [String] + ${InboxId}, + [Parameter(Position = 16, ValueFromPipelineByPropertyName = $true)] + [String] + ${EmailId}, + [Parameter(Position = 17, ValueFromPipelineByPropertyName = $true)] + [String] + ${AttachmentId}, + [Parameter(Position = 18, ValueFromPipelineByPropertyName = $true)] + [String] + ${PhoneId}, + [Parameter(Position = 19, ValueFromPipelineByPropertyName = $true)] + [String] + ${SmsId} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookResultDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($UserId -eq $null) { + throw "invalid value for 'UserId', 'UserId' cannot be null." + } + + if ($WebhookId -eq $null) { + throw "invalid value for 'WebhookId', 'WebhookId' cannot be null." + } + + if ($WebhookUrl -eq $null) { + throw "invalid value for 'WebhookUrl', 'WebhookUrl' cannot be null." + } + + if ($MessageId -eq $null) { + throw "invalid value for 'MessageId', 'MessageId' cannot be null." + } + + if ($HttpMethod -eq $null) { + throw "invalid value for 'HttpMethod', 'HttpMethod' cannot be null." + } + + if ($WebhookEvent -eq $null) { + throw "invalid value for 'WebhookEvent', 'WebhookEvent' cannot be null." + } + + if ($ResponseTimeMillis -eq $null) { + throw "invalid value for 'ResponseTimeMillis', 'ResponseTimeMillis' cannot be null." + } + + if ($CreatedAt -eq $null) { + throw "invalid value for 'CreatedAt', 'CreatedAt' cannot be null." + } + + if ($UpdatedAt -eq $null) { + throw "invalid value for 'UpdatedAt', 'UpdatedAt' cannot be null." + } + + if ($Seen -eq $null) { + throw "invalid value for 'Seen', 'Seen' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "webhookId" = ${WebhookId} + "webhookUrl" = ${WebhookUrl} + "messageId" = ${MessageId} + "redriveId" = ${RedriveId} + "httpMethod" = ${HttpMethod} + "webhookEvent" = ${WebhookEvent} + "responseStatus" = ${ResponseStatus} + "responseTimeMillis" = ${ResponseTimeMillis} + "responseBodyExtract" = ${ResponseBodyExtract} + "resultType" = ${ResultType} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "seen" = ${Seen} + "inboxId" = ${InboxId} + "emailId" = ${EmailId} + "attachmentId" = ${AttachmentId} + "phoneId" = ${PhoneId} + "smsId" = ${SmsId} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookResultDto + +.DESCRIPTION + +Convert from JSON to WebhookResultDto + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookResultDto +#> +function ConvertFrom-JsonToWebhookResultDto { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookResultDto' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookResultDto + $AllProperties = ("id", "userId", "webhookId", "webhookUrl", "messageId", "redriveId", "httpMethod", "webhookEvent", "responseStatus", "responseTimeMillis", "responseBodyExtract", "resultType", "createdAt", "updatedAt", "seen", "inboxId", "emailId", "attachmentId", "phoneId", "smsId") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'userId' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "userId"))) { + throw "Error! JSON cannot be serialized due to the required property 'userId' missing." + } else { + $UserId = $JsonParameters.PSobject.Properties["userId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookId"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookId' missing." + } else { + $WebhookId = $JsonParameters.PSobject.Properties["webhookId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookUrl"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookUrl' missing." + } else { + $WebhookUrl = $JsonParameters.PSobject.Properties["webhookUrl"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "messageId"))) { + throw "Error! JSON cannot be serialized due to the required property 'messageId' missing." + } else { + $MessageId = $JsonParameters.PSobject.Properties["messageId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "httpMethod"))) { + throw "Error! JSON cannot be serialized due to the required property 'httpMethod' missing." + } else { + $HttpMethod = $JsonParameters.PSobject.Properties["httpMethod"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "webhookEvent"))) { + throw "Error! JSON cannot be serialized due to the required property 'webhookEvent' missing." + } else { + $WebhookEvent = $JsonParameters.PSobject.Properties["webhookEvent"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "responseTimeMillis"))) { + throw "Error! JSON cannot be serialized due to the required property 'responseTimeMillis' missing." + } else { + $ResponseTimeMillis = $JsonParameters.PSobject.Properties["responseTimeMillis"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "createdAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'createdAt' missing." + } else { + $CreatedAt = $JsonParameters.PSobject.Properties["createdAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "updatedAt"))) { + throw "Error! JSON cannot be serialized due to the required property 'updatedAt' missing." + } else { + $UpdatedAt = $JsonParameters.PSobject.Properties["updatedAt"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "seen"))) { + throw "Error! JSON cannot be serialized due to the required property 'seen' missing." + } else { + $Seen = $JsonParameters.PSobject.Properties["seen"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found + $Id = $null + } else { + $Id = $JsonParameters.PSobject.Properties["id"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "redriveId"))) { #optional property not found + $RedriveId = $null + } else { + $RedriveId = $JsonParameters.PSobject.Properties["redriveId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "responseStatus"))) { #optional property not found + $ResponseStatus = $null + } else { + $ResponseStatus = $JsonParameters.PSobject.Properties["responseStatus"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "responseBodyExtract"))) { #optional property not found + $ResponseBodyExtract = $null + } else { + $ResponseBodyExtract = $JsonParameters.PSobject.Properties["responseBodyExtract"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "resultType"))) { #optional property not found + $ResultType = $null + } else { + $ResultType = $JsonParameters.PSobject.Properties["resultType"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "inboxId"))) { #optional property not found + $InboxId = $null + } else { + $InboxId = $JsonParameters.PSobject.Properties["inboxId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "emailId"))) { #optional property not found + $EmailId = $null + } else { + $EmailId = $JsonParameters.PSobject.Properties["emailId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "attachmentId"))) { #optional property not found + $AttachmentId = $null + } else { + $AttachmentId = $JsonParameters.PSobject.Properties["attachmentId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "phoneId"))) { #optional property not found + $PhoneId = $null + } else { + $PhoneId = $JsonParameters.PSobject.Properties["phoneId"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "smsId"))) { #optional property not found + $SmsId = $null + } else { + $SmsId = $JsonParameters.PSobject.Properties["smsId"].value + } + + $PSO = [PSCustomObject]@{ + "id" = ${Id} + "userId" = ${UserId} + "webhookId" = ${WebhookId} + "webhookUrl" = ${WebhookUrl} + "messageId" = ${MessageId} + "redriveId" = ${RedriveId} + "httpMethod" = ${HttpMethod} + "webhookEvent" = ${WebhookEvent} + "responseStatus" = ${ResponseStatus} + "responseTimeMillis" = ${ResponseTimeMillis} + "responseBodyExtract" = ${ResponseBodyExtract} + "resultType" = ${ResultType} + "createdAt" = ${CreatedAt} + "updatedAt" = ${UpdatedAt} + "seen" = ${Seen} + "inboxId" = ${InboxId} + "emailId" = ${EmailId} + "attachmentId" = ${AttachmentId} + "phoneId" = ${PhoneId} + "smsId" = ${SmsId} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookTestRequest.ps1 b/src/maislurp-client-powershell/Model/WebhookTestRequest.ps1 new file mode 100644 index 00000000..c06bacf3 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookTestRequest.ps1 @@ -0,0 +1,154 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Result of webhook test request + +.PARAMETER Url +No description available. +.PARAMETER Method +No description available. +.PARAMETER Headers +No description available. +.PARAMETER Payload +No description available. +.OUTPUTS + +WebhookTestRequest +#> + +function Initialize-WebhookTestRequest { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Url}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [ValidateSet("POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE")] + [String] + ${Method}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [System.Collections.Hashtable] + ${Headers}, + [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true)] + [String] + ${Payload} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookTestRequest' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Url -eq $null) { + throw "invalid value for 'Url', 'Url' cannot be null." + } + + if ($Method -eq $null) { + throw "invalid value for 'Method', 'Method' cannot be null." + } + + if ($Headers -eq $null) { + throw "invalid value for 'Headers', 'Headers' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "method" = ${Method} + "headers" = ${Headers} + "payload" = ${Payload} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookTestRequest + +.DESCRIPTION + +Convert from JSON to WebhookTestRequest + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookTestRequest +#> +function ConvertFrom-JsonToWebhookTestRequest { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookTestRequest' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookTestRequest + $AllProperties = ("url", "method", "headers", "payload") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'url' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "url"))) { + throw "Error! JSON cannot be serialized due to the required property 'url' missing." + } else { + $Url = $JsonParameters.PSobject.Properties["url"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "method"))) { + throw "Error! JSON cannot be serialized due to the required property 'method' missing." + } else { + $Method = $JsonParameters.PSobject.Properties["method"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "headers"))) { + throw "Error! JSON cannot be serialized due to the required property 'headers' missing." + } else { + $Headers = $JsonParameters.PSobject.Properties["headers"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "payload"))) { #optional property not found + $Payload = $null + } else { + $Payload = $JsonParameters.PSobject.Properties["payload"].value + } + + $PSO = [PSCustomObject]@{ + "url" = ${Url} + "method" = ${Method} + "headers" = ${Headers} + "payload" = ${Payload} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookTestResponse.ps1 b/src/maislurp-client-powershell/Model/WebhookTestResponse.ps1 new file mode 100644 index 00000000..bad09ac1 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookTestResponse.ps1 @@ -0,0 +1,111 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Response from webhook test request + +.PARAMETER StatusCode +No description available. +.PARAMETER Message +No description available. +.OUTPUTS + +WebhookTestResponse +#> + +function Initialize-WebhookTestResponse { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [System.Nullable[Int32]] + ${StatusCode}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookTestResponse' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + + $PSO = [PSCustomObject]@{ + "statusCode" = ${StatusCode} + "message" = ${Message} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookTestResponse + +.DESCRIPTION + +Convert from JSON to WebhookTestResponse + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookTestResponse +#> +function ConvertFrom-JsonToWebhookTestResponse { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookTestResponse' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookTestResponse + $AllProperties = ("statusCode", "message") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "statusCode"))) { #optional property not found + $StatusCode = $null + } else { + $StatusCode = $JsonParameters.PSobject.Properties["statusCode"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "statusCode" = ${StatusCode} + "message" = ${Message} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Model/WebhookTestResult.ps1 b/src/maislurp-client-powershell/Model/WebhookTestResult.ps1 new file mode 100644 index 00000000..95a1e193 --- /dev/null +++ b/src/maislurp-client-powershell/Model/WebhookTestResult.ps1 @@ -0,0 +1,136 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + +No summary available. + +.DESCRIPTION + +Results of testing a webhook + +.PARAMETER Message +No description available. +.PARAMETER Response +No description available. +.PARAMETER Request +No description available. +.OUTPUTS + +WebhookTestResult +#> + +function Initialize-WebhookTestResult { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipelineByPropertyName = $true)] + [String] + ${Message}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Response}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)] + [PSCustomObject] + ${Request} + ) + + Process { + 'Creating PSCustomObject: maislurp-client-powershell => WebhookTestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + if ($Response -eq $null) { + throw "invalid value for 'Response', 'Response' cannot be null." + } + + if ($Request -eq $null) { + throw "invalid value for 'Request', 'Request' cannot be null." + } + + + $PSO = [PSCustomObject]@{ + "message" = ${Message} + "response" = ${Response} + "request" = ${Request} + } + + + return $PSO + } +} + +<# +.SYNOPSIS + +Convert from JSON to WebhookTestResult + +.DESCRIPTION + +Convert from JSON to WebhookTestResult + +.PARAMETER Json + +Json object + +.OUTPUTS + +WebhookTestResult +#> +function ConvertFrom-JsonToWebhookTestResult { + Param( + [AllowEmptyString()] + [string]$Json + ) + + Process { + 'Converting JSON to PSCustomObject: maislurp-client-powershell => WebhookTestResult' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $JsonParameters = ConvertFrom-Json -InputObject $Json + + # check if Json contains properties not defined in WebhookTestResult + $AllProperties = ("message", "response", "request") + foreach ($name in $JsonParameters.PsObject.Properties.Name) { + if (!($AllProperties.Contains($name))) { + throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" + } + } + + If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json + throw "Error! Empty JSON cannot be serialized due to the required property 'response' missing." + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "response"))) { + throw "Error! JSON cannot be serialized due to the required property 'response' missing." + } else { + $Response = $JsonParameters.PSobject.Properties["response"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "request"))) { + throw "Error! JSON cannot be serialized due to the required property 'request' missing." + } else { + $Request = $JsonParameters.PSobject.Properties["request"].value + } + + if (!([bool]($JsonParameters.PSobject.Properties.name -match "message"))) { #optional property not found + $Message = $null + } else { + $Message = $JsonParameters.PSobject.Properties["message"].value + } + + $PSO = [PSCustomObject]@{ + "message" = ${Message} + "response" = ${Response} + "request" = ${Request} + } + + return $PSO + } + +} + diff --git a/src/maislurp-client-powershell/Private/ApiClient.ps1 b/src/maislurp-client-powershell/Private/ApiClient.ps1 new file mode 100644 index 00000000..40f8aa52 --- /dev/null +++ b/src/maislurp-client-powershell/Private/ApiClient.ps1 @@ -0,0 +1,226 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +function Invoke-ApiClient { + [OutputType('System.Collections.Hashtable')] + [CmdletBinding()] + Param( + [Parameter(Mandatory)] + [string]$Uri, + [Parameter(Mandatory)] + [AllowEmptyCollection()] + [string[]]$Accepts, + [Parameter(Mandatory)] + [AllowEmptyCollection()] + [string[]]$ContentTypes, + [Parameter(Mandatory)] + [hashtable]$HeaderParameters, + [Parameter(Mandatory)] + [hashtable]$FormParameters, + [Parameter(Mandatory)] + [hashtable]$QueryParameters, + [Parameter(Mandatory)] + [hashtable]$CookieParameters, + [Parameter(Mandatory)] + [AllowEmptyString()] + [string]$Body, + [Parameter(Mandatory)] + [string]$Method, + [Parameter(Mandatory)] + [AllowEmptyString()] + [string]$ReturnType, + [Parameter(Mandatory)] + [bool]$IsBodyNullable + ) + + 'Calling method: Invoke-ApiClient' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $Configuration = Get-Configuration + $RequestUri = $Configuration["BaseUrl"] + $Uri + $SkipCertificateCheck = $Configuration["SkipCertificateCheck"] + + # cookie parameters + foreach ($Parameter in $CookieParameters.GetEnumerator()) { + if ($Parameter.Name -eq "cookieAuth") { + $HeaderParameters["Cookie"] = $Parameter.Value + } else { + $HeaderParameters[$Parameter.Name] = $Parameter.Value + } + } + if ($CookieParameters -and $CookieParameters.Count -gt 1) { + Write-Warning "Multipe cookie parameters found. Curently only the first one is supported/used" + } + + # accept, content-type headers + $Accept = SelectHeaders -Headers $Accepts + if ($Accept) { + $HeaderParameters['Accept'] = $Accept + } + + $ContentType= SelectHeaders -Headers $ContentTypes + if ($ContentType) { + $HeaderParameters['Content-Type'] = $ContentType + } + + # add default headers if any + foreach ($header in $Configuration["DefaultHeaders"].GetEnumerator()) { + $HeaderParameters[$header.Name] = $header.Value + } + + + # constrcut URL query string + $HttpValues = [System.Web.HttpUtility]::ParseQueryString([String]::Empty) + foreach ($Parameter in $QueryParameters.GetEnumerator()) { + if ($Parameter.Value.Count -gt 1) { // array + foreach ($Value in $Parameter.Value) { + $HttpValues.Add($Parameter.Key + '[]', $Value) + } + } else { + $HttpValues.Add($Parameter.Key,$Parameter.Value) + } + } + # Build the request and load it with the query string. + $UriBuilder = [System.UriBuilder]($RequestUri) + $UriBuilder.Query = $HttpValues.ToString() + + # include form parameters in the request body + if ($FormParameters -and $FormParameters.Count -gt 0) { + $RequestBody = $FormParameters + } + + if ($Body -or $IsBodyNullable) { + $RequestBody = $Body + if ([string]::IsNullOrEmpty($RequestBody) -and $IsBodyNullable -eq $true) { + $RequestBody = "null" + } + } + + if ($SkipCertificateCheck -eq $true) { + if ($Configuration["Proxy"] -eq $null) { + # skip certification check, no proxy + $Response = Invoke-WebRequest -Uri $UriBuilder.Uri ` + -Method $Method ` + -Headers $HeaderParameters ` + -Body $RequestBody ` + -ErrorAction Stop ` + -UseBasicParsing ` + -SkipCertificateCheck + } else { + # skip certification check, use proxy + $Response = Invoke-WebRequest -Uri $UriBuilder.Uri ` + -Method $Method ` + -Headers $HeaderParameters ` + -Body $RequestBody ` + -ErrorAction Stop ` + -UseBasicParsing ` + -SkipCertificateCheck ` + -Proxy $Configuration["Proxy"].GetProxy($UriBuilder.Uri) ` + -ProxyUseDefaultCredentials + } + } else { + if ($Configuration["Proxy"] -eq $null) { + # perform certification check, no proxy + $Response = Invoke-WebRequest -Uri $UriBuilder.Uri ` + -Method $Method ` + -Headers $HeaderParameters ` + -Body $RequestBody ` + -ErrorAction Stop ` + -UseBasicParsing + } else { + # perform certification check, use proxy + $Response = Invoke-WebRequest -Uri $UriBuilder.Uri ` + -Method $Method ` + -Headers $HeaderParameters ` + -Body $RequestBody ` + -ErrorAction Stop ` + -UseBasicParsing ` + -Proxy $Configuration["Proxy"].GetProxy($UriBuilder.Uri) ` + -ProxyUseDefaultCredentials + } + } + + return @{ + Response = DeserializeResponse -Response $Response -ReturnType $ReturnType -ContentTypes $Response.Headers["Content-Type"] + StatusCode = $Response.StatusCode + Headers = $Response.Headers + } +} + +# Select JSON MIME if present, otherwise choose the first one if available +function SelectHeaders { + Param( + [Parameter(Mandatory)] + [AllowEmptyCollection()] + [String[]]$Headers + ) + + foreach ($Header in $Headers) { + if (IsJsonMIME -MIME $Header) { + return $Header + } + } + + if (!($Headers) -or $Headers.Count -eq 0) { + return $null + } else { + return $Headers[0] # return the first one + } +} + +function IsJsonMIME { + Param( + [Parameter(Mandatory)] + [string]$MIME + ) + + if ($MIME -match "(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$") { + return $true + } else { + return $false + } +} + +function DeserializeResponse { + Param( + [Parameter(Mandatory)] + [AllowEmptyString()] + [string]$ReturnType, + [Parameter(Mandatory)] + [AllowEmptyString()] + [string]$Response, + [Parameter(Mandatory)] + [AllowEmptyCollection()] + [string[]]$ContentTypes + ) + + If ([string]::IsNullOrEmpty($ReturnType) -and $ContentTypes.Count -eq 0) { # void response + return $Response + } Elseif ($ReturnType -match '\[\]$') { # array + return ConvertFrom-Json $Response + } Elseif (@("String", "Boolean", "System.DateTime") -contains $ReturnType) { # string, boolean ,datetime + return $Response + } Else { # others (e.g. model, file) + if ($ContentTypes) { + $ContentType = $null + if ($ContentTypes.Count -gt 1) { + $ContentType = SelectHeaders -Headers $ContentTypes + } else { + $ContentType = $ContentTypes[0] + } + + if (IsJsonMIME -MIME $ContentType) { # JSON + return ConvertFrom-Json $Response + } else { # XML, file, etc + return $Response + } + } else { # no content type in response header, returning raw response + return $Response + } + } +} diff --git a/src/maislurp-client-powershell/Private/Get-CommonParameters.ps1 b/src/maislurp-client-powershell/Private/Get-CommonParameters.ps1 new file mode 100644 index 00000000..d64afd71 --- /dev/null +++ b/src/maislurp-client-powershell/Private/Get-CommonParameters.ps1 @@ -0,0 +1,22 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.Synopsis + Helper function to get common parameters (Verbose, Debug, etc.) +.Example + Get-CommonParameters +#> +function Get-CommonParameters { + function tmp { + [CmdletBinding()] + Param () + } + + (Get-Command -Name tmp -CommandType Function).Parameters.Keys +} diff --git a/src/maislurp-client-powershell/Private/HttpSignatureAuth.ps1 b/src/maislurp-client-powershell/Private/HttpSignatureAuth.ps1 new file mode 100644 index 00000000..0ef0eb80 --- /dev/null +++ b/src/maislurp-client-powershell/Private/HttpSignatureAuth.ps1 @@ -0,0 +1,437 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.SYNOPSIS + Gets the headers for HTTP signature. +.DESCRIPTION + Gets the headers for the http sigature. +.PARAMETER Method + HTTP method +.PARAMETER UriBuilder + UriBuilder for url and query parameter +.PARAMETER Body + Request body +.OUTPUTS + Hashtable +#> +function Get-HttpSignedHeader { + param( + [string]$Method, + [System.UriBuilder]$UriBuilder, + [string]$Body, + [hashtable]$RequestHeader + ) + + $HEADER_REQUEST_TARGET = '(request-target)' + # The time when the HTTP signature was generated. + $HEADER_CREATED = '(created)' + # The time when the HTTP signature expires. The API server should reject HTTP requests + # that have expired. + $HEADER_EXPIRES = '(expires)' + # The 'Host' header. + $HEADER_HOST = 'Host' + # The 'Date' header. + $HEADER_DATE = 'Date' + # When the 'Digest' header is included in the HTTP signature, the client automatically + # computes the digest of the HTTP request body, per RFC 3230. + $HEADER_DIGEST = 'Digest' + # The 'Authorization' header is automatically generated by the client. It includes + # the list of signed headers and a base64-encoded signature. + $HEADER_AUTHORIZATION = 'Authorization' + + #Hash table to store singed headers + $HttpSignedRequestHeader = @{ } + $HttpSignatureHeader = @{ } + $TargetHost = $UriBuilder.Host + $httpSigningConfiguration = Get-ConfigurationHttpSigning + $Digest = $null + + #get the body digest + $bodyHash = Get-StringHash -String $Body -HashName $httpSigningConfiguration.HashAlgorithm + if ($httpSigningConfiguration.HashAlgorithm -eq "SHA256") { + $Digest = [String]::Format("SHA-256={0}", [Convert]::ToBase64String($bodyHash)) + } elseif ($httpSigningConfiguration.HashAlgorithm -eq "SHA512") { + $Digest = [String]::Format("SHA-512={0}", [Convert]::ToBase64String($bodyHash)) + } + + $dateTime = Get-Date + #get the date in UTC + $currentDate = $dateTime.ToUniversalTime().ToString("r") + + foreach ($headerItem in $httpSigningConfiguration.HttpSigningHeader) { + + if ($headerItem -eq $HEADER_REQUEST_TARGET) { + $requestTargetPath = [string]::Format("{0} {1}{2}", $Method.ToLower(), $UriBuilder.Path, $UriBuilder.Query) + $HttpSignatureHeader.Add($HEADER_REQUEST_TARGET, $requestTargetPath) + } elseif ($headerItem -eq $HEADER_CREATED) { + $created = Get-UnixTime -Date $dateTime -TotalTime TotalSeconds + $HttpSignatureHeader.Add($HEADER_CREATED, $created) + } elseif ($headerItem -eq $HEADER_EXPIRES) { + $expire = $dateTime.AddSeconds($httpSigningConfiguration.SignatureValidityPeriod) + $expireEpocTime = Get-UnixTime -Date $expire -TotalTime TotalSeconds + $HttpSignatureHeader.Add($HEADER_EXPIRES, $expireEpocTime) + } elseif ($headerItem -eq $HEADER_HOST) { + $HttpSignedRequestHeader[$HEADER_HOST] = $TargetHost + $HttpSignatureHeader.Add($HEADER_HOST.ToLower(), $TargetHost) + } elseif ($headerItem -eq $HEADER_DATE) { + $HttpSignedRequestHeader[$HEADER_DATE] = $currentDate + $HttpSignatureHeader.Add($HEADER_DATE.ToLower(), $currentDate) + } elseif ($headerItem -eq $HEADER_DIGEST) { + $HttpSignedRequestHeader[$HEADER_DIGEST] = $Digest + $HttpSignatureHeader.Add($HEADER_DIGEST.ToLower(), $Digest) + } elseif($RequestHeader.ContainsKey($headerItem)) { + $HttpSignatureHeader.Add($headerItem.ToLower(), $RequestHeader[$headerItem]) + } else { + throw "Cannot sign HTTP request. Request does not contain the $headerItem header." + } + } + + # header's name separated by space + $headersKeysString = $HttpSignatureHeader.Keys -join " " + $headerValuesList = @() + foreach ($item in $HttpSignatureHeader.GetEnumerator()) { + $headerValuesList += [string]::Format("{0}: {1}", $item.Name, $item.Value) + } + #Concatinate headers value separated by new line + $headerValuesString = $headerValuesList -join "`n" + + #Gets the hash of the headers value + $signatureHashString = Get-StringHash -String $headerValuesString -HashName $httpSigningConfiguration.HashAlgorithm + + #Gets the Key type to select the correct signing alogorithm + $KeyType = Get-KeyTypeFromFile -KeyFilePath $httpSigningConfiguration.KeyFilePath + + if ($keyType -eq "RSA") { + $headerSignatureStr = Get-RSASignature -PrivateKeyFilePath $httpSigningConfiguration.KeyFilePath ` + -DataToSign $signatureHashString ` + -HashAlgorithmName $httpSigningConfiguration.HashAlgorithm ` + -KeyPassPhrase $httpSigningConfiguration.KeyPassPhrase ` + -SigningAlgorithm $httpSigningConfiguration.SigningAlgorithm + } elseif ($KeyType -eq "EC") { + $headerSignatureStr = Get-ECDSASignature -ECKeyFilePath $httpSigningConfiguration.KeyFilePath ` + -DataToSign $signatureHashString ` + -HashAlgorithmName $httpSigningConfiguration.HashAlgorithm ` + -KeyPassPhrase $httpSigningConfiguration.KeyPassPhrase + } + #Depricated + <#$cryptographicScheme = Get-CryptographicScheme -SigningAlgorithm $httpSigningConfiguration.SigningAlgorithm ` + -HashAlgorithm $httpSigningConfiguration.HashAlgorithm + #> + $cryptographicScheme = "hs2019" + $authorizationHeaderValue = [string]::Format("Signature keyId=""{0}"",algorithm=""{1}""", + $httpSigningConfiguration.KeyId, $cryptographicScheme) + + if ($HttpSignatureHeader.ContainsKey($HEADER_CREATED)) { + $authorizationHeaderValue += [string]::Format(",created={0}", $HttpSignatureHeader[$HEADER_CREATED]) + } + + if ($HttpSignatureHeader.ContainsKey($HEADER_EXPIRES)) { + $authorizationHeaderValue += [string]::Format(",expires={0}", $HttpSignatureHeader[$HEADER_EXPIRES]) + } + + $authorizationHeaderValue += [string]::Format(",headers=""{0}"",signature=""{1}""", + $headersKeysString , $headerSignatureStr) + + $HttpSignedRequestHeader[$HEADER_AUTHORIZATION] = $authorizationHeaderValue + return $HttpSignedRequestHeader +} + +<# +.SYNOPSIS + Gets the RSA signature + +.DESCRIPTION + Gets the RSA signature for the http signing +.PARAMETER PrivateKeyFilePath + Specify the API key file path +.PARAMETER DataToSign + Specify the data to sign +.PARAMETER HashAlgorithmName + HashAlgorithm to calculate the hash +.PARAMETER KeyPassPhrase + KeyPassPhrase for the encrypted key +.OUTPUTS + Base64String +#> +function Get-RSASignature { + Param( + [string]$PrivateKeyFilePath, + [byte[]]$DataToSign, + [string]$HashAlgorithmName, + [string]$SigningAlgorithm, + [securestring]$KeyPassPhrase + ) + try { + + if ($hashAlgorithmName -eq "sha256") { + $hashAlgo = [System.Security.Cryptography.HashAlgorithmName]::SHA256 + } elseif ($hashAlgorithmName -eq "sha512") { + $hashAlgo = [System.Security.Cryptography.HashAlgorithmName]::SHA512 + } + + if ($PSVersionTable.PSVersion.Major -ge 7) { + $ecKeyHeader = "-----BEGIN RSA PRIVATE KEY-----" + $ecKeyFooter = "-----END RSA PRIVATE KEY-----" + $keyStr = Get-Content -Path $PrivateKeyFilePath -Raw + $ecKeyBase64String = $keyStr.Replace($ecKeyHeader, "").Replace($ecKeyFooter, "").Trim() + $keyBytes = [System.Convert]::FromBase64String($ecKeyBase64String) + $rsa = [System.Security.Cryptography.RSA]::Create() + [int]$bytCount = 0 + $rsa.ImportRSAPrivateKey($keyBytes, [ref] $bytCount) + + if ($SigningAlgorithm -eq "RSASSA-PSS") { + $signedBytes = $rsa.SignHash($DataToSign, $hashAlgo, [System.Security.Cryptography.RSASignaturePadding]::Pss) + } else { + $signedBytes = $rsa.SignHash($DataToSign, $hashAlgo, [System.Security.Cryptography.RSASignaturePadding]::Pkcs1) + } + } else { + $rsa_provider_path = Join-Path -Path $PSScriptRoot -ChildPath "RSAEncryptionProvider.cs" + $rsa_provider_sourceCode = Get-Content -Path $rsa_provider_path -Raw + Add-Type -TypeDefinition $rsa_provider_sourceCode + + [System.Security.Cryptography.RSA]$rsa = [RSAEncryption.RSAEncryptionProvider]::GetRSAProviderFromPemFile($PrivateKeyFilePath, $KeyPassPhrase) + + if ($SigningAlgorithm -eq "RSASSA-PSS") { + throw "$SigningAlgorithm is not supported on $($PSVersionTable.PSVersion)" + } else { + $signedBytes = $rsa.SignHash($DataToSign, $hashAlgo, [System.Security.Cryptography.RSASignaturePadding]::Pkcs1) + } + } + + $signedString = [Convert]::ToBase64String($signedBytes) + return $signedString + } catch { + throw $_ + } +} + +<# +.SYNOPSIS + Gets the ECDSA signature + +.DESCRIPTION + Gets the ECDSA signature for the http signing +.PARAMETER PrivateKeyFilePath + Specify the API key file path +.PARAMETER DataToSign + Specify the data to sign +.PARAMETER HashAlgorithmName + HashAlgorithm to calculate the hash +.PARAMETER KeyPassPhrase + KeyPassPhrase for the encrypted key +.OUTPUTS + Base64String +#> +function Get-ECDSASignature { + param( + [Parameter(Mandatory = $true)] + [string]$ECKeyFilePath, + [Parameter(Mandatory = $true)] + [byte[]]$DataToSign, + [Parameter(Mandatory = $false)] + [String]$HashAlgorithmName, + [Parameter(Mandatory = $false)] + [securestring]$KeyPassPhrase + ) + if (!(Test-Path -Path $ECKeyFilePath)) { + throw "key file path does not exist." + } + + if ($PSVersionTable.PSVersion.Major -lt 7) { + throw "ECDSA key is not supported on PowerShell version $($PSVersionTable.PSVersion), Use PowerShell v7.0 and above" + } + + $ecKeyHeader = "-----BEGIN EC PRIVATE KEY-----" + $ecKeyFooter = "-----END EC PRIVATE KEY-----" + $keyStr = Get-Content -Path $ECKeyFilePath -Raw + $ecKeyBase64String = $keyStr.Replace($ecKeyHeader, "").Replace($ecKeyFooter, "").Trim() + $keyBytes = [System.Convert]::FromBase64String($ecKeyBase64String) + $ecdsa = [System.Security.Cryptography.ECDsa]::Create() + + [int]$bytCount =0 + if (![string]::IsNullOrEmpty($KeyPassPhrase)) { + $ecdsa.ImportEncryptedPkcs8PrivateKey($KeyPassPhrase,$keyBytes,[ref]$bytCount) + } else { + $ecdsa.ImportPkcs8PrivateKey($keyBytes,[ref]$bytCount) + } + + $signedBytes = $ecdsa.SignHash($DataToSign) + $derBytes = ConvertTo-ECDSAANS1Format -RawBytes $signedBytes + $signedString = [System.Convert]::ToBase64String($derBytes) + return $signedString +} + +<# +.Synopsis + Gets the hash of string. +.Description + Gets the hash of string +.Parameter String + Specifies the string to calculate the hash +.Parameter HashName + Specifies the hash name to calculate the hash, Accepted values are "SHA1", "SHA256" and "SHA512" + It is recommneded not to use "SHA1" to calculate the Hash +.Outputs + String +#> +Function Get-StringHash { + param( + [Parameter(Mandatory = $true)] + [AllowEmptyString()] + [string]$String, + [Parameter(Mandatory = $true)] + [ValidateSet("SHA1", "SHA256", "SHA512")] + $HashName + ) + $hashAlogrithm = [System.Security.Cryptography.HashAlgorithm]::Create($HashName) + $hashAlogrithm.ComputeHash([System.Text.Encoding]::UTF8.GetBytes($String)) +} + +<# +.Synopsis + Gets the Unix time. +.Description + Gets the Unix time +.Parameter Date + Specifies the date to calculate the unix time +.Parameter ToTalTime + Specifies the total time , Accepted values are "TotalDays", "TotalHours", "TotalMinutes", "TotalSeconds" and "TotalMilliseconds" +.Outputs +Integer +#> +function Get-UnixTime { + param( + [Parameter(Mandatory = $true)] + [DateTime]$Date, + [Parameter(Mandatory = $false)] + [ValidateSet("TotalDays", "TotalHours", "TotalMinutes", "TotalSeconds", "TotalMilliseconds")] + [string]$TotalTime = "TotalSeconds" + ) + $date1 = Get-Date -Date "01/01/1970" + $timespan = New-TimeSpan -Start $date1 -End $Date + switch ($TotalTime) { + "TotalDays" { [int]$timespan.TotalDays } + "TotalHours" { [int]$timespan.TotalHours } + "TotalMinutes" { [int]$timespan.TotalMinutes } + "TotalSeconds" { [int]$timespan.TotalSeconds } + "TotalMilliseconds" { [int]$timespan.TotalMilliseconds } + } +} + +function Get-CryptographicScheme { + param( + [Parameter(Mandatory = $true)] + [string]$SigningAlgorithm, + [Parameter(Mandatory = $true)] + [string]$HashAlgorithm + ) + $rsaSigntureType = @("RSASSA-PKCS1-v1_5", "RSASSA-PSS") + $SigningAlgorithm = $null + if ($rsaSigntureType -contains $SigningAlgorithm) { + switch ($HashAlgorithm) { + "sha256" { $SigningAlgorithm = "rsa-sha256" } + "sha512" { $SigningAlgorithm = "rsa-sha512" } + } + } + return $SigningAlgorithm +} + +<# +.Synopsis + Gets the key type from the pem file. +.Description + Gets the key type from the pem file. +.Parameter KeyFilePath + Specifies the key file path (pem file) +.Outputs +String +#> +function Get-KeyTypeFromFile { + param( + [Parameter(Mandatory = $true)] + [string]$KeyFilePath + ) + + if (-not(Test-Path -Path $KeyFilePath)) { + throw "Key file path does not exist." + } + $ecPrivateKeyHeader = "BEGIN EC PRIVATE KEY" + $ecPrivateKeyFooter = "END EC PRIVATE KEY" + $rsaPrivateKeyHeader = "BEGIN RSA PRIVATE KEY" + $rsaPrivateFooter = "END RSA PRIVATE KEY" + $pkcs8Header = "BEGIN PRIVATE KEY" + $pkcs8Footer = "END PRIVATE KEY" + $keyType = $null + $key = Get-Content -Path $KeyFilePath + + if ($key[0] -match $rsaPrivateKeyHeader -and $key[$key.Length - 1] -match $rsaPrivateFooter) { + $KeyType = "RSA" + } elseif ($key[0] -match $ecPrivateKeyHeader -and $key[$key.Length - 1] -match $ecPrivateKeyFooter) { + $keyType = "EC" + } elseif ($key[0] -match $ecPrivateKeyHeader -and $key[$key.Length - 1] -match $ecPrivateKeyFooter) { + <#this type of key can hold many type different types of private key, but here due lack of pem header + Considering this as EC key + #> + #TODO :- update the key based on oid + $keyType = "EC" + } else { + throw "Either the key is invalid or key is not supported" + } + return $keyType +} + + +<# +.Synopsis + Converts sequence of R and S bytes to ANS1 format for ECDSASIgnature. +.Description + Converts sequence of R and S bytes to ANS1 format for ECDSASIgnature. +.Parameter RawBytes[] + Specifies the R and S bytes of ECDSA signature. +.Outputs + Byte[] +#> +function ConvertTo-ECDSAANS1Format{ + Param( + [Parameter(Mandatory = $true)] + [byte[]]$RawBytes + ) + + $derLength = 68 #default lenght for ECDSA code signinged bit 0x44 + $rbytesLength = 32 #R length 0x20 + $sbytesLength = 32 #S length 0x20 + [byte[]]$rBytes = $signedBytes[0..31] + [byte[]]$sBytes = $signedBytes[32..63] + + if($rBytes[0] -gt 0x7F){ + $derLength++ + $rbytesLength++ + $rBytes = [byte[]]@(0x00) + $rBytes + } + + if($sBytes[0] -gt 0x7F){ + $derLength++ + $sbytesLength++ + $sBytes = [byte[]]@(0x00) + $sBytes + } + + [byte[]]$derBytes = @() + + $derBytes += 48 # start of the sequence 0x30 + $derBytes += $derLength # total length r lenth, type and r bytes + + $derBytes += 2 # tag for integer + $derBytes += $rbytesLength # length of r + $derBytes += $rBytes + + $derBytes += 2 #tag for integer + $derBytes += $sbytesLength #length of s + $derBytes += $sBytes + return $derBytes +} \ No newline at end of file diff --git a/src/maislurp-client-powershell/Private/Out-DebugParameter.ps1 b/src/maislurp-client-powershell/Private/Out-DebugParameter.ps1 new file mode 100644 index 00000000..22c94dbd --- /dev/null +++ b/src/maislurp-client-powershell/Private/Out-DebugParameter.ps1 @@ -0,0 +1,45 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +<# +.Synopsis + Helper function to format debug parameter output. +.Example + $PSBoundParameters | Out-DebugParameter | Write-Debug +#> +function Out-DebugParameter { + [CmdletBinding()] + Param ( + [Parameter(ValueFromPipeline = $true, Mandatory = $true)] + [AllowEmptyCollection()] + $InputObject + ) + + Begin { + $CommonParameters = Get-CommonParameters + } + + Process { + $InputObject.GetEnumerator() | Where-Object { + $CommonParameters -notcontains $_.Key + } | Format-Table -AutoSize -Property ( + @{ + Name = 'Parameter' + Expression = {$_.Key} + }, + @{ + Name = 'Value' + Expression = {$_.Value} + } + ) | Out-String -Stream | ForEach-Object { + if ($_.Trim()) { + $_ + } + } + } +} diff --git a/src/maislurp-client-powershell/Private/RSAEncryptionProvider.cs b/src/maislurp-client-powershell/Private/RSAEncryptionProvider.cs new file mode 100644 index 00000000..451221fd --- /dev/null +++ b/src/maislurp-client-powershell/Private/RSAEncryptionProvider.cs @@ -0,0 +1,279 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Net; +using System.Runtime.InteropServices; +using System.Security; +using System.Security.Cryptography; +using System.Text; + +namespace RSAEncryption +{ + public class RSAEncryptionProvider + { + public static RSACryptoServiceProvider GetRSAProviderFromPemFile(String pemfile,SecureString keyPassPharse = null) + { + const String pempubheader = "-----BEGIN PUBLIC KEY-----"; + const String pempubfooter = "-----END PUBLIC KEY-----"; + bool isPrivateKeyFile = true; + byte[] pemkey = null; + + if (!File.Exists(pemfile)) + { + throw new Exception("private key file does not exist."); + } + string pemstr = File.ReadAllText(pemfile).Trim(); + + if (pemstr.StartsWith(pempubheader) && pemstr.EndsWith(pempubfooter)) + { + isPrivateKeyFile = false; + } + + if (isPrivateKeyFile) + { + pemkey = ConvertPrivateKeyToBytes(pemstr,keyPassPharse); + if (pemkey == null) + { + return null; + } + return DecodeRSAPrivateKey(pemkey); + } + return null ; + } + + static byte[] ConvertPrivateKeyToBytes(String instr, SecureString keyPassPharse = null) + { + const String pemprivheader = "-----BEGIN RSA PRIVATE KEY-----"; + const String pemprivfooter = "-----END RSA PRIVATE KEY-----"; + String pemstr = instr.Trim(); + byte[] binkey; + + if (!pemstr.StartsWith(pemprivheader) || !pemstr.EndsWith(pemprivfooter)) + { + return null; + } + + StringBuilder sb = new StringBuilder(pemstr); + sb.Replace(pemprivheader, ""); + sb.Replace(pemprivfooter, ""); + String pvkstr = sb.ToString().Trim(); + + try + { // if there are no PEM encryption info lines, this is an UNencrypted PEM private key + binkey = Convert.FromBase64String(pvkstr); + return binkey; + } + catch (System.FormatException) + { + StringReader str = new StringReader(pvkstr); + + //-------- read PEM encryption info. lines and extract salt ----- + if (!str.ReadLine().StartsWith("Proc-Type: 4,ENCRYPTED")) + return null; + String saltline = str.ReadLine(); + if (!saltline.StartsWith("DEK-Info: DES-EDE3-CBC,")) + return null; + String saltstr = saltline.Substring(saltline.IndexOf(",") + 1).Trim(); + byte[] salt = new byte[saltstr.Length / 2]; + for (int i = 0; i < salt.Length; i++) + salt[i] = Convert.ToByte(saltstr.Substring(i * 2, 2), 16); + if (!(str.ReadLine() == "")) + return null; + + //------ remaining b64 data is encrypted RSA key ---- + String encryptedstr = str.ReadToEnd(); + + try + { //should have b64 encrypted RSA key now + binkey = Convert.FromBase64String(encryptedstr); + } + catch (System.FormatException) + { //data is not in base64 fromat + return null; + } + + byte[] deskey = GetEncryptedKey(salt, keyPassPharse, 1, 2); // count=1 (for OpenSSL implementation); 2 iterations to get at least 24 bytes + if (deskey == null) + return null; + + //------ Decrypt the encrypted 3des-encrypted RSA private key ------ + byte[] rsakey = DecryptKey(binkey, deskey, salt); //OpenSSL uses salt value in PEM header also as 3DES IV + return rsakey; + } + } + + public static RSACryptoServiceProvider DecodeRSAPrivateKey(byte[] privkey) + { + byte[] MODULUS, E, D, P, Q, DP, DQ, IQ; + + // --------- Set up stream to decode the asn.1 encoded RSA private key ------ + MemoryStream mem = new MemoryStream(privkey); + BinaryReader binr = new BinaryReader(mem); //wrap Memory Stream with BinaryReader for easy reading + byte bt = 0; + ushort twobytes = 0; + int elems = 0; + try + { + twobytes = binr.ReadUInt16(); + if (twobytes == 0x8130) //data read as little endian order (actual data order for Sequence is 30 81) + binr.ReadByte(); //advance 1 byte + else if (twobytes == 0x8230) + binr.ReadInt16(); //advance 2 bytes + else + return null; + + twobytes = binr.ReadUInt16(); + if (twobytes != 0x0102) //version number + return null; + bt = binr.ReadByte(); + if (bt != 0x00) + return null; + + //------ all private key components are Integer sequences ---- + elems = GetIntegerSize(binr); + MODULUS = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + E = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + D = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + P = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + Q = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + DP = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + DQ = binr.ReadBytes(elems); + + elems = GetIntegerSize(binr); + IQ = binr.ReadBytes(elems); + + // ------- create RSACryptoServiceProvider instance and initialize with public key ----- + RSACryptoServiceProvider RSA = new RSACryptoServiceProvider(); + RSAParameters RSAparams = new RSAParameters(); + RSAparams.Modulus = MODULUS; + RSAparams.Exponent = E; + RSAparams.D = D; + RSAparams.P = P; + RSAparams.Q = Q; + RSAparams.DP = DP; + RSAparams.DQ = DQ; + RSAparams.InverseQ = IQ; + RSA.ImportParameters(RSAparams); + return RSA; + } + catch (Exception) + { + return null; + } + finally { binr.Close(); } + } + + private static int GetIntegerSize(BinaryReader binr) + { + byte bt = 0; + byte lowbyte = 0x00; + byte highbyte = 0x00; + int count = 0; + bt = binr.ReadByte(); + if (bt != 0x02) //expect integer + return 0; + bt = binr.ReadByte(); + + if (bt == 0x81) + count = binr.ReadByte(); // data size in next byte + else + if (bt == 0x82) + { + highbyte = binr.ReadByte(); // data size in next 2 bytes + lowbyte = binr.ReadByte(); + byte[] modint = { lowbyte, highbyte, 0x00, 0x00 }; + count = BitConverter.ToInt32(modint, 0); + } + else + { + count = bt; // we already have the data size + } + while (binr.ReadByte() == 0x00) + { //remove high order zeros in data + count -= 1; + } + binr.BaseStream.Seek(-1, SeekOrigin.Current); + //last ReadByte wasn't a removed zero, so back up a byte + return count; + } + + static byte[] GetEncryptedKey(byte[] salt, SecureString secpswd, int count, int miter) + { + IntPtr unmanagedPswd = IntPtr.Zero; + int HASHLENGTH = 16; //MD5 bytes + byte[] keymaterial = new byte[HASHLENGTH * miter]; //to store contatenated Mi hashed results + + byte[] psbytes = new byte[secpswd.Length]; + unmanagedPswd = Marshal.SecureStringToGlobalAllocAnsi(secpswd); + Marshal.Copy(unmanagedPswd, psbytes, 0, psbytes.Length); + Marshal.ZeroFreeGlobalAllocAnsi(unmanagedPswd); + + // --- contatenate salt and pswd bytes into fixed data array --- + byte[] data00 = new byte[psbytes.Length + salt.Length]; + Array.Copy(psbytes, data00, psbytes.Length); //copy the pswd bytes + Array.Copy(salt, 0, data00, psbytes.Length, salt.Length); //concatenate the salt bytes + + // ---- do multi-hashing and contatenate results D1, D2 ... into keymaterial bytes ---- + MD5 md5 = new MD5CryptoServiceProvider(); + byte[] result = null; + byte[] hashtarget = new byte[HASHLENGTH + data00.Length]; //fixed length initial hashtarget + + for (int j = 0; j < miter; j++) + { + // ---- Now hash consecutively for count times ------ + if (j == 0) + result = data00; //initialize + else + { + Array.Copy(result, hashtarget, result.Length); + Array.Copy(data00, 0, hashtarget, result.Length, data00.Length); + result = hashtarget; + } + + for (int i = 0; i < count; i++) + result = md5.ComputeHash(result); + Array.Copy(result, 0, keymaterial, j * HASHLENGTH, result.Length); //contatenate to keymaterial + } + byte[] deskey = new byte[24]; + Array.Copy(keymaterial, deskey, deskey.Length); + + Array.Clear(psbytes, 0, psbytes.Length); + Array.Clear(data00, 0, data00.Length); + Array.Clear(result, 0, result.Length); + Array.Clear(hashtarget, 0, hashtarget.Length); + Array.Clear(keymaterial, 0, keymaterial.Length); + return deskey; + } + + static byte[] DecryptKey(byte[] cipherData, byte[] desKey, byte[] IV) + { + MemoryStream memst = new MemoryStream(); + TripleDES alg = TripleDES.Create(); + alg.Key = desKey; + alg.IV = IV; + try + { + CryptoStream cs = new CryptoStream(memst, alg.CreateDecryptor(), CryptoStreamMode.Write); + cs.Write(cipherData, 0, cipherData.Length); + cs.Close(); + } + catch (Exception){ + return null; + } + byte[] decryptedData = memst.ToArray(); + return decryptedData; + } + } +} diff --git a/src/maislurp-client-powershell/en-US/about_maislurp-client-powershell.help.txt b/src/maislurp-client-powershell/en-US/about_maislurp-client-powershell.help.txt new file mode 100644 index 00000000..7435b3d0 --- /dev/null +++ b/src/maislurp-client-powershell/en-US/about_maislurp-client-powershell.help.txt @@ -0,0 +1,20 @@ +PSTOPIC + about_maislurp-client-powershell + +SHORT DESCRIPTION + maislurp-client-powershell - the PowerShell module for the MailSlurp API + +LONG DESCRIPTION + MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository + + This PowerShell module is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + + - API version: 6.5.2 + - SDK version: 15.19.14 + - Build package: org.openapitools.codegen.languages.PowerShellClientCodegen + For more information, please visit [https://www.mailslurp.com/contact/](https://www.mailslurp.com/contact/) + + Frameworks supported: + + * PowerShell 6.2 or later + * .NET 4.0 or later diff --git a/src/maislurp-client-powershell/maislurp-client-powershell.psm1 b/src/maislurp-client-powershell/maislurp-client-powershell.psm1 new file mode 100644 index 00000000..bd9921d4 --- /dev/null +++ b/src/maislurp-client-powershell/maislurp-client-powershell.psm1 @@ -0,0 +1,38 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +#region Import functions + +# define the following classes in PowerShell +try { + Add-Type -AssemblyName System.Web -ErrorAction Ignore | Out-Null + Add-Type -AssemblyName System.Net -ErrorAction Ignore | Out-Null +} catch { + Write-Verbose $_ +} + +# set $ErrorActionPreference to 'Stop' globally +$ErrorActionPreference = 'Stop' + +# store the API client's configuration +$Script:Configuration = [System.Collections.HashTable]@{} + +$Script:CmdletBindingParameters = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + +'Api', 'Model', 'Client', 'Private' | Get-ChildItem -Path { + Join-Path $PSScriptRoot $_ +} -Filter '*.ps1' | ForEach-Object { + Write-Debug "Importing file: $($_.BaseName)" + try { + . $_.FullName + } catch { + Write-Error -Message "Failed to import function $($_.Fullname): $_" + } +} + +#endregion diff --git a/tests/Api/AliasControllerApi.Tests.ps1 b/tests/Api/AliasControllerApi.Tests.ps1 new file mode 100644 index 00000000..e4c31371 --- /dev/null +++ b/tests/Api/AliasControllerApi.Tests.ps1 @@ -0,0 +1,98 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AliasControllerApi' { + Context 'New-Alias' { + It 'Test New-Alias' { + #$TestResult = New-Alias -CreateAliasOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAlias' { + It 'Test Invoke-DeleteAlias' { + #$TestResult = Invoke-DeleteAlias -AliasId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Alias' { + It 'Test Get-Alias' { + #$TestResult = Get-Alias -AliasId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AliasEmails' { + It 'Test Get-AliasEmails' { + #$TestResult = Get-AliasEmails -AliasId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AliasThreads' { + It 'Test Get-AliasThreads' { + #$TestResult = Get-AliasThreads -AliasId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Aliases' { + It 'Test Get-Aliases' { + #$TestResult = Get-Aliases -Search "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Thread' { + It 'Test Get-Thread' { + #$TestResult = Get-Thread -ThreadId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ThreadsPaginated' { + It 'Test Get-ThreadsPaginated' { + #$TestResult = Get-ThreadsPaginated -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ReplyToAliasEmail' { + It 'Test Invoke-ReplyToAliasEmail' { + #$TestResult = Invoke-ReplyToAliasEmail -AliasId "TEST_VALUE" -EmailId "TEST_VALUE" -ReplyToAliasEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-AliasEmail' { + It 'Test Send-AliasEmail' { + #$TestResult = Send-AliasEmail -AliasId "TEST_VALUE" -SendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-Alias' { + It 'Test Update-Alias' { + #$TestResult = Update-Alias -AliasId "TEST_VALUE" -UpdateAliasOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/AttachmentControllerApi.Tests.ps1 b/tests/Api/AttachmentControllerApi.Tests.ps1 new file mode 100644 index 00000000..c62c58c1 --- /dev/null +++ b/tests/Api/AttachmentControllerApi.Tests.ps1 @@ -0,0 +1,90 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AttachmentControllerApi' { + Context 'Invoke-DeleteAllAttachments' { + It 'Test Invoke-DeleteAllAttachments' { + #$TestResult = Invoke-DeleteAllAttachments + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAttachment' { + It 'Test Invoke-DeleteAttachment' { + #$TestResult = Invoke-DeleteAttachment -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DownloadAttachmentAsBase64Encoded' { + It 'Test Invoke-DownloadAttachmentAsBase64Encoded' { + #$TestResult = Invoke-DownloadAttachmentAsBase64Encoded -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DownloadAttachmentAsBytes' { + It 'Test Invoke-DownloadAttachmentAsBytes' { + #$TestResult = Invoke-DownloadAttachmentAsBytes -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Attachment' { + It 'Test Get-Attachment' { + #$TestResult = Get-Attachment -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AttachmentInfo' { + It 'Test Get-AttachmentInfo' { + #$TestResult = Get-AttachmentInfo -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Attachments' { + It 'Test Get-Attachments' { + #$TestResult = Get-Attachments -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -FileNameFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-UploadAttachment' { + It 'Test Invoke-UploadAttachment' { + #$TestResult = Invoke-UploadAttachment -UploadAttachmentOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-UploadAttachmentBytes' { + It 'Test Invoke-UploadAttachmentBytes' { + #$TestResult = Invoke-UploadAttachmentBytes -ContentType "TEST_VALUE" -ContentType2 "TEST_VALUE" -ContentId "TEST_VALUE" -Filename "TEST_VALUE" -Filename2 "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-UploadMultipartForm' { + It 'Test Invoke-UploadMultipartForm' { + #$TestResult = Invoke-UploadMultipartForm -ContentId "TEST_VALUE" -ContentType "TEST_VALUE" -Filename "TEST_VALUE" -XFilename "TEST_VALUE" -InlineObject "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/BounceControllerApi.Tests.ps1 b/tests/Api/BounceControllerApi.Tests.ps1 new file mode 100644 index 00000000..f073453c --- /dev/null +++ b/tests/Api/BounceControllerApi.Tests.ps1 @@ -0,0 +1,82 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BounceControllerApi' { + Context 'Invoke-FilterBouncedRecipient' { + It 'Test Invoke-FilterBouncedRecipient' { + #$TestResult = Invoke-FilterBouncedRecipient -FilterBouncedRecipientsOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AccountBounceBlockStatus' { + It 'Test Get-AccountBounceBlockStatus' { + #$TestResult = Get-AccountBounceBlockStatus + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-BouncedEmail' { + It 'Test Get-BouncedEmail' { + #$TestResult = Get-BouncedEmail -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-BouncedEmails' { + It 'Test Get-BouncedEmails' { + #$TestResult = Get-BouncedEmails -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-BouncedRecipient' { + It 'Test Get-BouncedRecipient' { + #$TestResult = Get-BouncedRecipient -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-BouncedRecipients' { + It 'Test Get-BouncedRecipients' { + #$TestResult = Get-BouncedRecipients -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Complaint' { + It 'Test Get-Complaint' { + #$TestResult = Get-Complaint -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Complaints' { + It 'Test Get-Complaints' { + #$TestResult = Get-Complaints -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ListUnsubscribeRecipients' { + It 'Test Get-ListUnsubscribeRecipients' { + #$TestResult = Get-ListUnsubscribeRecipients -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -DomainId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/BulkActionsControllerApi.Tests.ps1 b/tests/Api/BulkActionsControllerApi.Tests.ps1 new file mode 100644 index 00000000..12fe3c97 --- /dev/null +++ b/tests/Api/BulkActionsControllerApi.Tests.ps1 @@ -0,0 +1,34 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BulkActionsControllerApi' { + Context 'Invoke-BulkCreateInboxes' { + It 'Test Invoke-BulkCreateInboxes' { + #$TestResult = Invoke-BulkCreateInboxes -Count "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-BulkDeleteInboxes' { + It 'Test Invoke-BulkDeleteInboxes' { + #$TestResult = Invoke-BulkDeleteInboxes -RequestBody "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-BulkSendEmails' { + It 'Test Invoke-BulkSendEmails' { + #$TestResult = Invoke-BulkSendEmails -BulkSendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/CommonActionsControllerApi.Tests.ps1 b/tests/Api/CommonActionsControllerApi.Tests.ps1 new file mode 100644 index 00000000..48d487be --- /dev/null +++ b/tests/Api/CommonActionsControllerApi.Tests.ps1 @@ -0,0 +1,58 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CommonActionsControllerApi' { + Context 'New-NewEmailAddress' { + It 'Test New-NewEmailAddress' { + #$TestResult = New-NewEmailAddress -AllowTeamAccess "TEST_VALUE" -UseDomainPool "TEST_VALUE" -ExpiresAt "TEST_VALUE" -ExpiresIn "TEST_VALUE" -EmailAddress "TEST_VALUE" -InboxType "TEST_VALUE" -Description "TEST_VALUE" -Name "TEST_VALUE" -Tags "TEST_VALUE" -Favourite "TEST_VALUE" -VirtualInbox "TEST_VALUE" -UseShortAddress "TEST_VALUE" -DomainName "TEST_VALUE" -DomainId "TEST_VALUE" -Prefix "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-RandomInbox' { + It 'Test New-RandomInbox' { + #$TestResult = New-RandomInbox -AllowTeamAccess "TEST_VALUE" -UseDomainPool "TEST_VALUE" -ExpiresAt "TEST_VALUE" -ExpiresIn "TEST_VALUE" -EmailAddress "TEST_VALUE" -InboxType "TEST_VALUE" -Description "TEST_VALUE" -Name "TEST_VALUE" -Tags "TEST_VALUE" -Favourite "TEST_VALUE" -VirtualInbox "TEST_VALUE" -UseShortAddress "TEST_VALUE" -DomainName "TEST_VALUE" -DomainId "TEST_VALUE" -Prefix "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteEmailAddress' { + It 'Test Invoke-DeleteEmailAddress' { + #$TestResult = Invoke-DeleteEmailAddress -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-EmptyInbox' { + It 'Test Invoke-EmptyInbox' { + #$TestResult = Invoke-EmptyInbox -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-EmailQuery' { + It 'Test Send-EmailQuery' { + #$TestResult = Send-EmailQuery -To "TEST_VALUE" -SenderId "TEST_VALUE" -Body "TEST_VALUE" -Subject "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-EmailSimple' { + It 'Test Send-EmailSimple' { + #$TestResult = Send-EmailSimple -SimpleSendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/ConnectorControllerApi.Tests.ps1 b/tests/Api/ConnectorControllerApi.Tests.ps1 new file mode 100644 index 00000000..ba7df553 --- /dev/null +++ b/tests/Api/ConnectorControllerApi.Tests.ps1 @@ -0,0 +1,122 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorControllerApi' { + Context 'New-Connector' { + It 'Test New-Connector' { + #$TestResult = New-Connector -CreateConnectorOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-ConnectorImapConnection' { + It 'Test New-ConnectorImapConnection' { + #$TestResult = New-ConnectorImapConnection -Id "TEST_VALUE" -CreateConnectorImapConnectionOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-ConnectorSmtpConnection' { + It 'Test New-ConnectorSmtpConnection' { + #$TestResult = New-ConnectorSmtpConnection -Id "TEST_VALUE" -CreateConnectorSmtpConnectionOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllConnector' { + It 'Test Invoke-DeleteAllConnector' { + #$TestResult = Invoke-DeleteAllConnector + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteConnector' { + It 'Test Invoke-DeleteConnector' { + #$TestResult = Invoke-DeleteConnector -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteConnectorImapConnection' { + It 'Test Invoke-DeleteConnectorImapConnection' { + #$TestResult = Invoke-DeleteConnectorImapConnection -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteConnectorSmtpConnection' { + It 'Test Invoke-DeleteConnectorSmtpConnection' { + #$TestResult = Invoke-DeleteConnectorSmtpConnection -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllConnectorSyncEvents' { + It 'Test Get-AllConnectorSyncEvents' { + #$TestResult = Get-AllConnectorSyncEvents -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Connector' { + It 'Test Get-Connector' { + #$TestResult = Get-Connector -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ConnectorSyncEvent' { + It 'Test Get-ConnectorSyncEvent' { + #$TestResult = Get-ConnectorSyncEvent -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ConnectorSyncEvents' { + It 'Test Get-ConnectorSyncEvents' { + #$TestResult = Get-ConnectorSyncEvents -Id "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Connectors' { + It 'Test Get-Connectors' { + #$TestResult = Get-Connectors -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Sync-Connector' { + It 'Test Sync-Connector' { + #$TestResult = Sync-Connector -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-Connector' { + It 'Test Update-Connector' { + #$TestResult = Update-Connector -Id "TEST_VALUE" -CreateConnectorOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/ContactControllerApi.Tests.ps1 b/tests/Api/ContactControllerApi.Tests.ps1 new file mode 100644 index 00000000..f57ff419 --- /dev/null +++ b/tests/Api/ContactControllerApi.Tests.ps1 @@ -0,0 +1,58 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ContactControllerApi' { + Context 'New-Contact' { + It 'Test New-Contact' { + #$TestResult = New-Contact -CreateContactOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteContact' { + It 'Test Invoke-DeleteContact' { + #$TestResult = Invoke-DeleteContact -ContactId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllContacts' { + It 'Test Get-AllContacts' { + #$TestResult = Get-AllContacts -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -Search "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Contact' { + It 'Test Get-Contact' { + #$TestResult = Get-Contact -ContactId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ContactVCard' { + It 'Test Get-ContactVCard' { + #$TestResult = Get-ContactVCard -ContactId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Contacts' { + It 'Test Get-Contacts' { + #$TestResult = Get-Contacts + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/DomainControllerApi.Tests.ps1 b/tests/Api/DomainControllerApi.Tests.ps1 new file mode 100644 index 00000000..e487c274 --- /dev/null +++ b/tests/Api/DomainControllerApi.Tests.ps1 @@ -0,0 +1,90 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainControllerApi' { + Context 'Add-DomainWildcardCatchAll' { + It 'Test Add-DomainWildcardCatchAll' { + #$TestResult = Add-DomainWildcardCatchAll -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-Domain' { + It 'Test New-Domain' { + #$TestResult = New-Domain -CreateDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteDomain' { + It 'Test Invoke-DeleteDomain' { + #$TestResult = Invoke-DeleteDomain -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AvailableDomains' { + It 'Test Get-AvailableDomains' { + #$TestResult = Get-AvailableDomains -InboxType "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Domain' { + It 'Test Get-Domain' { + #$TestResult = Get-Domain -Id "TEST_VALUE" -CheckForErrors "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-DomainIssues' { + It 'Test Get-DomainIssues' { + #$TestResult = Get-DomainIssues + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-DomainWildcardCatchAllInbox' { + It 'Test Get-DomainWildcardCatchAllInbox' { + #$TestResult = Get-DomainWildcardCatchAllInbox -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Domains' { + It 'Test Get-Domains' { + #$TestResult = Get-Domains + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-MailSlurpDomains' { + It 'Test Get-MailSlurpDomains' { + #$TestResult = Get-MailSlurpDomains -InboxType "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-Domain' { + It 'Test Update-Domain' { + #$TestResult = Update-Domain -Id "TEST_VALUE" -UpdateDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/EmailControllerApi.Tests.ps1 b/tests/Api/EmailControllerApi.Tests.ps1 new file mode 100644 index 00000000..18e4b4fb --- /dev/null +++ b/tests/Api/EmailControllerApi.Tests.ps1 @@ -0,0 +1,338 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailControllerApi' { + Context 'Invoke-ApplyImapFlagOperation' { + It 'Test Invoke-ApplyImapFlagOperation' { + #$TestResult = Invoke-ApplyImapFlagOperation -EmailId "TEST_VALUE" -ImapFlagOperationOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-CanSend' { + It 'Test Invoke-CanSend' { + #$TestResult = Invoke-CanSend -InboxId "TEST_VALUE" -SendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-CheckEmailBody' { + It 'Test Invoke-CheckEmailBody' { + #$TestResult = Invoke-CheckEmailBody -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-CheckEmailBodyFeatureSupport' { + It 'Test Invoke-CheckEmailBodyFeatureSupport' { + #$TestResult = Invoke-CheckEmailBodyFeatureSupport -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-CheckEmailClientSupport' { + It 'Test Invoke-CheckEmailClientSupport' { + #$TestResult = Invoke-CheckEmailClientSupport -CheckEmailClientSupportOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllEmails' { + It 'Test Invoke-DeleteAllEmails' { + #$TestResult = Invoke-DeleteAllEmails + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteEmail' { + It 'Test Invoke-DeleteEmail' { + #$TestResult = Invoke-DeleteEmail -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DownloadAttachment' { + It 'Test Invoke-DownloadAttachment' { + #$TestResult = Invoke-DownloadAttachment -EmailId "TEST_VALUE" -AttachmentId "TEST_VALUE" -ApiKey "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DownloadAttachmentBase64' { + It 'Test Invoke-DownloadAttachmentBase64' { + #$TestResult = Invoke-DownloadAttachmentBase64 -EmailId "TEST_VALUE" -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DownloadBody' { + It 'Test Invoke-DownloadBody' { + #$TestResult = Invoke-DownloadBody -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DownloadBodyBytes' { + It 'Test Invoke-DownloadBodyBytes' { + #$TestResult = Invoke-DownloadBodyBytes -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ForwardEmail' { + It 'Test Invoke-ForwardEmail' { + #$TestResult = Invoke-ForwardEmail -EmailId "TEST_VALUE" -ForwardEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AttachmentMetaData' { + It 'Test Get-AttachmentMetaData' { + #$TestResult = Get-AttachmentMetaData -EmailId "TEST_VALUE" -AttachmentId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Email' { + It 'Test Get-Email' { + #$TestResult = Get-Email -EmailId "TEST_VALUE" -Decode "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailAttachments' { + It 'Test Get-EmailAttachments' { + #$TestResult = Get-EmailAttachments -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailContentMatch' { + It 'Test Get-EmailContentMatch' { + #$TestResult = Get-EmailContentMatch -EmailId "TEST_VALUE" -ContentMatchOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailContentPart' { + It 'Test Get-EmailContentPart' { + #$TestResult = Get-EmailContentPart -EmailId "TEST_VALUE" -ContentType "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailCount' { + It 'Test Get-EmailCount' { + #$TestResult = Get-EmailCount -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailHTML' { + It 'Test Get-EmailHTML' { + #$TestResult = Get-EmailHTML -EmailId "TEST_VALUE" -Decode "TEST_VALUE" -ReplaceCidImages "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailHTMLJson' { + It 'Test Get-EmailHTMLJson' { + #$TestResult = Get-EmailHTMLJson -EmailId "TEST_VALUE" -Decode "TEST_VALUE" -ReplaceCidImages "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailHTMLQuery' { + It 'Test Get-EmailHTMLQuery' { + #$TestResult = Get-EmailHTMLQuery -EmailId "TEST_VALUE" -HtmlSelector "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailLinks' { + It 'Test Get-EmailLinks' { + #$TestResult = Get-EmailLinks -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailPreviewURLs' { + It 'Test Get-EmailPreviewURLs' { + #$TestResult = Get-EmailPreviewURLs -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailScreenshotAsBase64' { + It 'Test Get-EmailScreenshotAsBase64' { + #$TestResult = Get-EmailScreenshotAsBase64 -EmailId "TEST_VALUE" -GetEmailScreenshotOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailScreenshotAsBinary' { + It 'Test Get-EmailScreenshotAsBinary' { + #$TestResult = Get-EmailScreenshotAsBinary -EmailId "TEST_VALUE" -GetEmailScreenshotOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailTextLines' { + It 'Test Get-EmailTextLines' { + #$TestResult = Get-EmailTextLines -EmailId "TEST_VALUE" -DecodeHtmlEntities "TEST_VALUE" -LineSeparator "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailsOffsetPaginated' { + It 'Test Get-EmailsOffsetPaginated' { + #$TestResult = Get-EmailsOffsetPaginated -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -UnreadOnly "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmailsPaginated' { + It 'Test Get-EmailsPaginated' { + #$TestResult = Get-EmailsPaginated -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -UnreadOnly "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-GravatarUrlForEmailAddress' { + It 'Test Get-GravatarUrlForEmailAddress' { + #$TestResult = Get-GravatarUrlForEmailAddress -EmailAddress "TEST_VALUE" -Size "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-LatestEmail' { + It 'Test Get-LatestEmail' { + #$TestResult = Get-LatestEmail -InboxIds "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-LatestEmailInInbox1' { + It 'Test Get-LatestEmailInInbox1' { + #$TestResult = Get-LatestEmailInInbox1 -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-OrganizationEmailsPaginated' { + It 'Test Get-OrganizationEmailsPaginated' { + #$TestResult = Get-OrganizationEmailsPaginated -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -UnreadOnly "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-RawEmailContents' { + It 'Test Get-RawEmailContents' { + #$TestResult = Get-RawEmailContents -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-RawEmailJson' { + It 'Test Get-RawEmailJson' { + #$TestResult = Get-RawEmailJson -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-UnreadEmailCount' { + It 'Test Get-UnreadEmailCount' { + #$TestResult = Get-UnreadEmailCount -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-MarkAllAsRead' { + It 'Test Invoke-MarkAllAsRead' { + #$TestResult = Invoke-MarkAllAsRead -Read "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-MarkAsRead' { + It 'Test Invoke-MarkAsRead' { + #$TestResult = Invoke-MarkAsRead -EmailId "TEST_VALUE" -Read "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ReplyToEmail' { + It 'Test Invoke-ReplyToEmail' { + #$TestResult = Invoke-ReplyToEmail -EmailId "TEST_VALUE" -ReplyToEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Search-Emails' { + It 'Test Search-Emails' { + #$TestResult = Search-Emails -SearchEmailsOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-EmailSourceOptional' { + It 'Test Send-EmailSourceOptional' { + #$TestResult = Send-EmailSourceOptional -SendEmailOptions "TEST_VALUE" -InboxId "TEST_VALUE" -UseDomainPool "TEST_VALUE" -VirtualSend "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Confirm-Email' { + It 'Test Confirm-Email' { + #$TestResult = Confirm-Email -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/EmailVerificationControllerApi.Tests.ps1 b/tests/Api/EmailVerificationControllerApi.Tests.ps1 new file mode 100644 index 00000000..8078e1d5 --- /dev/null +++ b/tests/Api/EmailVerificationControllerApi.Tests.ps1 @@ -0,0 +1,42 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailVerificationControllerApi' { + Context 'Invoke-DeleteAllValidationRequests' { + It 'Test Invoke-DeleteAllValidationRequests' { + #$TestResult = Invoke-DeleteAllValidationRequests + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteValidationRequest' { + It 'Test Invoke-DeleteValidationRequest' { + #$TestResult = Invoke-DeleteValidationRequest -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ValidationRequests' { + It 'Test Get-ValidationRequests' { + #$TestResult = Get-ValidationRequests -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -IsValid "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Confirm-EmailAddressList' { + It 'Test Confirm-EmailAddressList' { + #$TestResult = Confirm-EmailAddressList -ValidateEmailAddressListOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/ExpiredControllerApi.Tests.ps1 b/tests/Api/ExpiredControllerApi.Tests.ps1 new file mode 100644 index 00000000..0935a7af --- /dev/null +++ b/tests/Api/ExpiredControllerApi.Tests.ps1 @@ -0,0 +1,42 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExpiredControllerApi' { + Context 'Get-ExpirationDefaults' { + It 'Test Get-ExpirationDefaults' { + #$TestResult = Get-ExpirationDefaults + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ExpiredInboxByInboxId' { + It 'Test Get-ExpiredInboxByInboxId' { + #$TestResult = Get-ExpiredInboxByInboxId -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ExpiredInboxRecord' { + It 'Test Get-ExpiredInboxRecord' { + #$TestResult = Get-ExpiredInboxRecord -ExpiredId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ExpiredInboxes' { + It 'Test Get-ExpiredInboxes' { + #$TestResult = Get-ExpiredInboxes -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/ExportControllerApi.Tests.ps1 b/tests/Api/ExportControllerApi.Tests.ps1 new file mode 100644 index 00000000..05a61e74 --- /dev/null +++ b/tests/Api/ExportControllerApi.Tests.ps1 @@ -0,0 +1,26 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExportControllerApi' { + Context 'Export-Entities' { + It 'Test Export-Entities' { + #$TestResult = Export-Entities -ExportType "TEST_VALUE" -ApiKey "TEST_VALUE" -OutputFormat "TEST_VALUE" -Filter "TEST_VALUE" -ListSeparatorToken "TEST_VALUE" -ExcludePreviouslyExported "TEST_VALUE" -CreatedEarliestTime "TEST_VALUE" -CreatedOldestTime "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ExportLink' { + It 'Test Get-ExportLink' { + #$TestResult = Get-ExportLink -ExportType "TEST_VALUE" -ExportOptions "TEST_VALUE" -ApiKey "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/FormControllerApi.Tests.ps1 b/tests/Api/FormControllerApi.Tests.ps1 new file mode 100644 index 00000000..623a2f6f --- /dev/null +++ b/tests/Api/FormControllerApi.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FormControllerApi' { + Context 'Submit-Form' { + It 'Test Submit-Form' { + #$TestResult = Submit-Form -To "TEST_VALUE" -Subject "TEST_VALUE" -RedirectTo "TEST_VALUE" -EmailAddress "TEST_VALUE" -SuccessMessage "TEST_VALUE" -SpamCheck "TEST_VALUE" -OtherParameters "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/GroupControllerApi.Tests.ps1 b/tests/Api/GroupControllerApi.Tests.ps1 new file mode 100644 index 00000000..2c32f433 --- /dev/null +++ b/tests/Api/GroupControllerApi.Tests.ps1 @@ -0,0 +1,82 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GroupControllerApi' { + Context 'Add-ContactsToGroup' { + It 'Test Add-ContactsToGroup' { + #$TestResult = Add-ContactsToGroup -GroupId "TEST_VALUE" -UpdateGroupContacts "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-Group' { + It 'Test New-Group' { + #$TestResult = New-Group -CreateGroupOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteGroup' { + It 'Test Invoke-DeleteGroup' { + #$TestResult = Invoke-DeleteGroup -GroupId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllGroups' { + It 'Test Get-AllGroups' { + #$TestResult = Get-AllGroups -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Group' { + It 'Test Get-Group' { + #$TestResult = Get-Group -GroupId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-GroupWithContacts' { + It 'Test Get-GroupWithContacts' { + #$TestResult = Get-GroupWithContacts -GroupId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-GroupWithContactsPaginated' { + It 'Test Get-GroupWithContactsPaginated' { + #$TestResult = Get-GroupWithContactsPaginated -GroupId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Groups' { + It 'Test Get-Groups' { + #$TestResult = Get-Groups + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Remove-ContactsFromGroup' { + It 'Test Remove-ContactsFromGroup' { + #$TestResult = Remove-ContactsFromGroup -GroupId "TEST_VALUE" -UpdateGroupContacts "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/ImapControllerApi.Tests.ps1 b/tests/Api/ImapControllerApi.Tests.ps1 new file mode 100644 index 00000000..24388b33 --- /dev/null +++ b/tests/Api/ImapControllerApi.Tests.ps1 @@ -0,0 +1,58 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapControllerApi' { + Context 'Invoke-ImapServerFetch' { + It 'Test Invoke-ImapServerFetch' { + #$TestResult = Invoke-ImapServerFetch -SeqNum "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ImapServerGet' { + It 'Test Invoke-ImapServerGet' { + #$TestResult = Invoke-ImapServerGet -EmailId "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ImapServerList' { + It 'Test Invoke-ImapServerList' { + #$TestResult = Invoke-ImapServerList -ImapServerListOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ImapServerSearch' { + It 'Test Invoke-ImapServerSearch' { + #$TestResult = Invoke-ImapServerSearch -ImapServerSearchOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ImapServerStatus' { + It 'Test Invoke-ImapServerStatus' { + #$TestResult = Invoke-ImapServerStatus -ImapServerStatusOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ImapServerUpdateFlags' { + It 'Test Invoke-ImapServerUpdateFlags' { + #$TestResult = Invoke-ImapServerUpdateFlags -ImapUpdateFlagsOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/InboxControllerApi.Tests.ps1 b/tests/Api/InboxControllerApi.Tests.ps1 new file mode 100644 index 00000000..070464e0 --- /dev/null +++ b/tests/Api/InboxControllerApi.Tests.ps1 @@ -0,0 +1,410 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxControllerApi' { + Context 'Stop-ScheduledJob' { + It 'Test Stop-ScheduledJob' { + #$TestResult = Stop-ScheduledJob -JobId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-Inbox' { + It 'Test New-Inbox' { + #$TestResult = New-Inbox -EmailAddress "TEST_VALUE" -Tags "TEST_VALUE" -Name "TEST_VALUE" -Description "TEST_VALUE" -UseDomainPool "TEST_VALUE" -Favourite "TEST_VALUE" -ExpiresAt "TEST_VALUE" -ExpiresIn "TEST_VALUE" -AllowTeamAccess "TEST_VALUE" -InboxType "TEST_VALUE" -VirtualInbox "TEST_VALUE" -UseShortAddress "TEST_VALUE" -DomainId "TEST_VALUE" -DomainName "TEST_VALUE" -Prefix "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-InboxRuleset' { + It 'Test New-InboxRuleset' { + #$TestResult = New-InboxRuleset -InboxId "TEST_VALUE" -CreateInboxRulesetOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-InboxWithDefaults' { + It 'Test New-InboxWithDefaults' { + #$TestResult = New-InboxWithDefaults + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-InboxWithOptions' { + It 'Test New-InboxWithOptions' { + #$TestResult = New-InboxWithOptions -CreateInboxDto "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllInboxEmails' { + It 'Test Invoke-DeleteAllInboxEmails' { + #$TestResult = Invoke-DeleteAllInboxEmails -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllInboxes' { + It 'Test Invoke-DeleteAllInboxes' { + #$TestResult = Invoke-DeleteAllInboxes + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllInboxesByDescription' { + It 'Test Invoke-DeleteAllInboxesByDescription' { + #$TestResult = Invoke-DeleteAllInboxesByDescription -Description "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllInboxesByName' { + It 'Test Invoke-DeleteAllInboxesByName' { + #$TestResult = Invoke-DeleteAllInboxesByName -Name "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllInboxesByTag' { + It 'Test Invoke-DeleteAllInboxesByTag' { + #$TestResult = Invoke-DeleteAllInboxesByTag -Tag "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInbox' { + It 'Test Invoke-DeleteInbox' { + #$TestResult = Invoke-DeleteInbox -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DoesInboxExist' { + It 'Test Invoke-DoesInboxExist' { + #$TestResult = Invoke-DoesInboxExist -EmailAddress "TEST_VALUE" -AllowCatchAll "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Clear-Expired' { + It 'Test Clear-Expired' { + #$TestResult = Clear-Expired -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllInboxes' { + It 'Test Get-AllInboxes' { + #$TestResult = Get-AllInboxes -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Favourite "TEST_VALUE" -Search "TEST_VALUE" -Tag "TEST_VALUE" -TeamAccess "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -InboxType "TEST_VALUE" -InboxFunction "TEST_VALUE" -DomainId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllInboxesOffsetPaginated' { + It 'Test Get-AllInboxesOffsetPaginated' { + #$TestResult = Get-AllInboxesOffsetPaginated -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Favourite "TEST_VALUE" -Search "TEST_VALUE" -Tag "TEST_VALUE" -TeamAccess "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -InboxType "TEST_VALUE" -InboxFunction "TEST_VALUE" -DomainId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllScheduledJobs' { + It 'Test Get-AllScheduledJobs' { + #$TestResult = Get-AllScheduledJobs -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-DeliveryStatusesByInboxId' { + It 'Test Get-DeliveryStatusesByInboxId' { + #$TestResult = Get-DeliveryStatusesByInboxId -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Emails' { + It 'Test Get-Emails' { + #$TestResult = Get-Emails -InboxId "TEST_VALUE" -Size "TEST_VALUE" -Limit "TEST_VALUE" -Sort "TEST_VALUE" -RetryTimeout "TEST_VALUE" -DelayTimeout "TEST_VALUE" -MinCount "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Before "TEST_VALUE" -Since "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ImapAccess' { + It 'Test Get-ImapAccess' { + #$TestResult = Get-ImapAccess -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ImapSmtpAccess' { + It 'Test Get-ImapSmtpAccess' { + #$TestResult = Get-ImapSmtpAccess -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ImapSmtpAccessEnv' { + It 'Test Get-ImapSmtpAccessEnv' { + #$TestResult = Get-ImapSmtpAccessEnv -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ImapSmtpAccessServers' { + It 'Test Get-ImapSmtpAccessServers' { + #$TestResult = Get-ImapSmtpAccessServers + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Inbox' { + It 'Test Get-Inbox' { + #$TestResult = Get-Inbox -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxByEmailAddress' { + It 'Test Get-InboxByEmailAddress' { + #$TestResult = Get-InboxByEmailAddress -EmailAddress "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxByName' { + It 'Test Get-InboxByName' { + #$TestResult = Get-InboxByName -Name "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxCount' { + It 'Test Get-InboxCount' { + #$TestResult = Get-InboxCount + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxEmailCount' { + It 'Test Get-InboxEmailCount' { + #$TestResult = Get-InboxEmailCount -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxEmailsPaginated' { + It 'Test Get-InboxEmailsPaginated' { + #$TestResult = Get-InboxEmailsPaginated -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxIds' { + It 'Test Get-InboxIds' { + #$TestResult = Get-InboxIds + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxSentEmails' { + It 'Test Get-InboxSentEmails' { + #$TestResult = Get-InboxSentEmails -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxTags' { + It 'Test Get-InboxTags' { + #$TestResult = Get-InboxTags + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Inboxes' { + It 'Test Get-Inboxes' { + #$TestResult = Get-Inboxes -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -ExcludeCatchAllInboxes "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-LatestEmailInInbox' { + It 'Test Get-LatestEmailInInbox' { + #$TestResult = Get-LatestEmailInInbox -InboxId "TEST_VALUE" -TimeoutMillis "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-OrganizationInboxes' { + It 'Test Get-OrganizationInboxes' { + #$TestResult = Get-OrganizationInboxes -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ScheduledJob' { + It 'Test Get-ScheduledJob' { + #$TestResult = Get-ScheduledJob -JobId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ScheduledJobsByInboxId' { + It 'Test Get-ScheduledJobsByInboxId' { + #$TestResult = Get-ScheduledJobsByInboxId -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SmtpAccess' { + It 'Test Get-SmtpAccess' { + #$TestResult = Get-SmtpAccess -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ListInboxRulesets' { + It 'Test Invoke-ListInboxRulesets' { + #$TestResult = Invoke-ListInboxRulesets -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ListInboxTrackingPixels' { + It 'Test Invoke-ListInboxTrackingPixels' { + #$TestResult = Invoke-ListInboxTrackingPixels -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Search-Inboxes' { + It 'Test Search-Inboxes' { + #$TestResult = Search-Inboxes -SearchInboxesOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-Email' { + It 'Test Send-Email' { + #$TestResult = Send-Email -InboxId "TEST_VALUE" -SendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-EmailAndConfirm' { + It 'Test Send-EmailAndConfirm' { + #$TestResult = Send-EmailAndConfirm -InboxId "TEST_VALUE" -SendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-EmailWithQueue' { + It 'Test Send-EmailWithQueue' { + #$TestResult = Send-EmailWithQueue -InboxId "TEST_VALUE" -ValidateBeforeEnqueue "TEST_VALUE" -SendEmailOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-SmtpEnvelope' { + It 'Test Send-SmtpEnvelope' { + #$TestResult = Send-SmtpEnvelope -InboxId "TEST_VALUE" -SendSMTPEnvelopeOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-TestEmail' { + It 'Test Send-TestEmail' { + #$TestResult = Send-TestEmail -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-WithSchedule' { + It 'Test Send-WithSchedule' { + #$TestResult = Send-WithSchedule -InboxId "TEST_VALUE" -SendEmailOptions "TEST_VALUE" -SendAtTimestamp "TEST_VALUE" -SendAtNowPlusSeconds "TEST_VALUE" -ValidateBeforeEnqueue "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Set-InboxFavourited' { + It 'Test Set-InboxFavourited' { + #$TestResult = Set-InboxFavourited -InboxId "TEST_VALUE" -SetInboxFavouritedOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-ImapAccess' { + It 'Test Update-ImapAccess' { + #$TestResult = Update-ImapAccess -UpdateImapAccessOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-Inbox' { + It 'Test Update-Inbox' { + #$TestResult = Update-Inbox -InboxId "TEST_VALUE" -UpdateInboxOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-SmtpAccess' { + It 'Test Update-SmtpAccess' { + #$TestResult = Update-SmtpAccess -UpdateSmtpAccessOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/InboxForwarderControllerApi.Tests.ps1 b/tests/Api/InboxForwarderControllerApi.Tests.ps1 new file mode 100644 index 00000000..a2fdcdbe --- /dev/null +++ b/tests/Api/InboxForwarderControllerApi.Tests.ps1 @@ -0,0 +1,114 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxForwarderControllerApi' { + Context 'New-NewInboxForwarder' { + It 'Test New-NewInboxForwarder' { + #$TestResult = New-NewInboxForwarder -InboxId "TEST_VALUE" -CreateInboxForwarderOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInboxForwarder' { + It 'Test Invoke-DeleteInboxForwarder' { + #$TestResult = Invoke-DeleteInboxForwarder -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInboxForwarders' { + It 'Test Invoke-DeleteInboxForwarders' { + #$TestResult = Invoke-DeleteInboxForwarders -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllInboxForwarderEvents' { + It 'Test Get-AllInboxForwarderEvents' { + #$TestResult = Get-AllInboxForwarderEvents -Page "TEST_VALUE" -Size "TEST_VALUE" -InboxId "TEST_VALUE" -Sort "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ForwarderEvent' { + It 'Test Get-ForwarderEvent' { + #$TestResult = Get-ForwarderEvent -EventId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxForwarder' { + It 'Test Get-InboxForwarder' { + #$TestResult = Get-InboxForwarder -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxForwarderEvent' { + It 'Test Get-InboxForwarderEvent' { + #$TestResult = Get-InboxForwarderEvent -Id "TEST_VALUE" -EventId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxForwarderEvents' { + It 'Test Get-InboxForwarderEvents' { + #$TestResult = Get-InboxForwarderEvents -Id "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxForwarders' { + It 'Test Get-InboxForwarders' { + #$TestResult = Get-InboxForwarders -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-InboxForwarder' { + It 'Test Test-InboxForwarder' { + #$TestResult = Test-InboxForwarder -Id "TEST_VALUE" -InboxForwarderTestOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-InboxForwardersForInbox' { + It 'Test Test-InboxForwardersForInbox' { + #$TestResult = Test-InboxForwardersForInbox -InboxId "TEST_VALUE" -InboxForwarderTestOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-NewInboxForwarder' { + It 'Test Test-NewInboxForwarder' { + #$TestResult = Test-NewInboxForwarder -TestNewInboxForwarderOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-InboxForwarder' { + It 'Test Update-InboxForwarder' { + #$TestResult = Update-InboxForwarder -Id "TEST_VALUE" -CreateInboxForwarderOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/InboxReplierControllerApi.Tests.ps1 b/tests/Api/InboxReplierControllerApi.Tests.ps1 new file mode 100644 index 00000000..7247aff5 --- /dev/null +++ b/tests/Api/InboxReplierControllerApi.Tests.ps1 @@ -0,0 +1,66 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxReplierControllerApi' { + Context 'New-NewInboxReplier' { + It 'Test New-NewInboxReplier' { + #$TestResult = New-NewInboxReplier -CreateInboxReplierOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInboxReplier' { + It 'Test Invoke-DeleteInboxReplier' { + #$TestResult = Invoke-DeleteInboxReplier -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInboxRepliers' { + It 'Test Invoke-DeleteInboxRepliers' { + #$TestResult = Invoke-DeleteInboxRepliers -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxReplier' { + It 'Test Get-InboxReplier' { + #$TestResult = Get-InboxReplier -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxReplierEvents' { + It 'Test Get-InboxReplierEvents' { + #$TestResult = Get-InboxReplierEvents -Id "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxRepliers' { + It 'Test Get-InboxRepliers' { + #$TestResult = Get-InboxRepliers -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-InboxReplier' { + It 'Test Update-InboxReplier' { + #$TestResult = Update-InboxReplier -Id "TEST_VALUE" -UpdateInboxReplierOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/InboxRulesetControllerApi.Tests.ps1 b/tests/Api/InboxRulesetControllerApi.Tests.ps1 new file mode 100644 index 00000000..ade01e2e --- /dev/null +++ b/tests/Api/InboxRulesetControllerApi.Tests.ps1 @@ -0,0 +1,90 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxRulesetControllerApi' { + Context 'New-NewInboxRuleset' { + It 'Test New-NewInboxRuleset' { + #$TestResult = New-NewInboxRuleset -CreateInboxRulesetOptions "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInboxRuleset' { + It 'Test Invoke-DeleteInboxRuleset' { + #$TestResult = Invoke-DeleteInboxRuleset -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteInboxRulesets' { + It 'Test Invoke-DeleteInboxRulesets' { + #$TestResult = Invoke-DeleteInboxRulesets -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxRuleset' { + It 'Test Get-InboxRuleset' { + #$TestResult = Get-InboxRuleset -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxRulesets' { + It 'Test Get-InboxRulesets' { + #$TestResult = Get-InboxRulesets -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-InboxRuleset' { + It 'Test Test-InboxRuleset' { + #$TestResult = Test-InboxRuleset -Id "TEST_VALUE" -InboxRulesetTestOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-InboxRulesetReceiving' { + It 'Test Test-InboxRulesetReceiving' { + #$TestResult = Test-InboxRulesetReceiving -TestInboxRulesetReceivingOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-InboxRulesetSending' { + It 'Test Test-InboxRulesetSending' { + #$TestResult = Test-InboxRulesetSending -TestInboxRulesetSendingOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-InboxRulesetsForInbox' { + It 'Test Test-InboxRulesetsForInbox' { + #$TestResult = Test-InboxRulesetsForInbox -InboxId "TEST_VALUE" -InboxRulesetTestOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-NewInboxRuleset' { + It 'Test Test-NewInboxRuleset' { + #$TestResult = Test-NewInboxRuleset -TestNewInboxRulesetOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/MailServerControllerApi.Tests.ps1 b/tests/Api/MailServerControllerApi.Tests.ps1 new file mode 100644 index 00000000..d136d1d4 --- /dev/null +++ b/tests/Api/MailServerControllerApi.Tests.ps1 @@ -0,0 +1,50 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'MailServerControllerApi' { + Context 'Invoke-DescribeMailServerDomain' { + It 'Test Invoke-DescribeMailServerDomain' { + #$TestResult = Invoke-DescribeMailServerDomain -DescribeDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-DnsLookup' { + It 'Test Get-DnsLookup' { + #$TestResult = Get-DnsLookup -DNSLookupOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-DnsLookups' { + It 'Test Get-DnsLookups' { + #$TestResult = Get-DnsLookups -DNSLookupsOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-IpAddress' { + It 'Test Get-IpAddress' { + #$TestResult = Get-IpAddress -Name "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-EmailAddress' { + It 'Test Test-EmailAddress' { + #$TestResult = Test-EmailAddress -VerifyEmailAddressOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/MissedEmailControllerApi.Tests.ps1 b/tests/Api/MissedEmailControllerApi.Tests.ps1 new file mode 100644 index 00000000..0ce20650 --- /dev/null +++ b/tests/Api/MissedEmailControllerApi.Tests.ps1 @@ -0,0 +1,50 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'MissedEmailControllerApi' { + Context 'Get-AllMissedEmails' { + It 'Test Get-AllMissedEmails' { + #$TestResult = Get-AllMissedEmails -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllUnknownMissedEmails' { + It 'Test Get-AllUnknownMissedEmails' { + #$TestResult = Get-AllUnknownMissedEmails -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-MissedEmail' { + It 'Test Get-MissedEmail' { + #$TestResult = Get-MissedEmail -MissedEmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Restore-MissedEmails' { + It 'Test Restore-MissedEmails' { + #$TestResult = Restore-MissedEmails + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForNthMissedEmail' { + It 'Test Wait-ForNthMissedEmail' { + #$TestResult = Wait-ForNthMissedEmail -Index "TEST_VALUE" -InboxId "TEST_VALUE" -Timeout "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/PhoneControllerApi.Tests.ps1 b/tests/Api/PhoneControllerApi.Tests.ps1 new file mode 100644 index 00000000..42dd30d0 --- /dev/null +++ b/tests/Api/PhoneControllerApi.Tests.ps1 @@ -0,0 +1,82 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PhoneControllerApi' { + Context 'New-EmergencyAddress' { + It 'Test New-EmergencyAddress' { + #$TestResult = New-EmergencyAddress -CreateEmergencyAddressOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteEmergencyAddress' { + It 'Test Invoke-DeleteEmergencyAddress' { + #$TestResult = Invoke-DeleteEmergencyAddress -AddressId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeletePhoneNumber' { + It 'Test Invoke-DeletePhoneNumber' { + #$TestResult = Invoke-DeletePhoneNumber -PhoneNumberId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmergencyAddress' { + It 'Test Get-EmergencyAddress' { + #$TestResult = Get-EmergencyAddress -AddressId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-EmergencyAddresses' { + It 'Test Get-EmergencyAddresses' { + #$TestResult = Get-EmergencyAddresses + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-PhoneNumber' { + It 'Test Get-PhoneNumber' { + #$TestResult = Get-PhoneNumber -PhoneNumberId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-PhoneNumbers' { + It 'Test Get-PhoneNumbers' { + #$TestResult = Get-PhoneNumbers -PhoneCountry "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-PhonePlans' { + It 'Test Get-PhonePlans' { + #$TestResult = Get-PhonePlans + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-PhoneNumberSendSms' { + It 'Test Test-PhoneNumberSendSms' { + #$TestResult = Test-PhoneNumberSendSms -PhoneNumberId "TEST_VALUE" -TestPhoneNumberOptions "TEST_VALUE" -XTestId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/SentEmailsControllerApi.Tests.ps1 b/tests/Api/SentEmailsControllerApi.Tests.ps1 new file mode 100644 index 00000000..82039eb2 --- /dev/null +++ b/tests/Api/SentEmailsControllerApi.Tests.ps1 @@ -0,0 +1,138 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SentEmailsControllerApi' { + Context 'Invoke-DeleteAllSentEmails' { + It 'Test Invoke-DeleteAllSentEmails' { + #$TestResult = Invoke-DeleteAllSentEmails + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteSentEmail' { + It 'Test Invoke-DeleteSentEmail' { + #$TestResult = Invoke-DeleteSentEmail -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllSentTrackingPixels' { + It 'Test Get-AllSentTrackingPixels' { + #$TestResult = Get-AllSentTrackingPixels -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-RawSentEmailContents' { + It 'Test Get-RawSentEmailContents' { + #$TestResult = Get-RawSentEmailContents -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-RawSentEmailJson' { + It 'Test Get-RawSentEmailJson' { + #$TestResult = Get-RawSentEmailJson -EmailId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentDeliveryStatus' { + It 'Test Get-SentDeliveryStatus' { + #$TestResult = Get-SentDeliveryStatus -DeliveryId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentDeliveryStatuses' { + It 'Test Get-SentDeliveryStatuses' { + #$TestResult = Get-SentDeliveryStatuses -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentDeliveryStatusesBySentId' { + It 'Test Get-SentDeliveryStatusesBySentId' { + #$TestResult = Get-SentDeliveryStatusesBySentId -SentId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentEmail' { + It 'Test Get-SentEmail' { + #$TestResult = Get-SentEmail -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentEmailHTMLContent' { + It 'Test Get-SentEmailHTMLContent' { + #$TestResult = Get-SentEmailHTMLContent -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentEmailPreviewURLs' { + It 'Test Get-SentEmailPreviewURLs' { + #$TestResult = Get-SentEmailPreviewURLs -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentEmailTrackingPixels' { + It 'Test Get-SentEmailTrackingPixels' { + #$TestResult = Get-SentEmailTrackingPixels -Id "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentEmails' { + It 'Test Get-SentEmails' { + #$TestResult = Get-SentEmails -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentEmailsWithQueueResults' { + It 'Test Get-SentEmailsWithQueueResults' { + #$TestResult = Get-SentEmailsWithQueueResults -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SentOrganizationEmails' { + It 'Test Get-SentOrganizationEmails' { + #$TestResult = Get-SentOrganizationEmails -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForDeliveryStatuses' { + It 'Test Wait-ForDeliveryStatuses' { + #$TestResult = Wait-ForDeliveryStatuses -SentId "TEST_VALUE" -InboxId "TEST_VALUE" -Timeout "TEST_VALUE" -Index "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/SmsControllerApi.Tests.ps1 b/tests/Api/SmsControllerApi.Tests.ps1 new file mode 100644 index 00000000..ff39c7b5 --- /dev/null +++ b/tests/Api/SmsControllerApi.Tests.ps1 @@ -0,0 +1,74 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmsControllerApi' { + Context 'Invoke-DeleteSmsMessage' { + It 'Test Invoke-DeleteSmsMessage' { + #$TestResult = Invoke-DeleteSmsMessage -SmsId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteSmsMessages' { + It 'Test Invoke-DeleteSmsMessages' { + #$TestResult = Invoke-DeleteSmsMessages -PhoneNumberId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-ReplyForSmsMessage' { + It 'Test Get-ReplyForSmsMessage' { + #$TestResult = Get-ReplyForSmsMessage -SmsId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SmsCount' { + It 'Test Get-SmsCount' { + #$TestResult = Get-SmsCount + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SmsMessage' { + It 'Test Get-SmsMessage' { + #$TestResult = Get-SmsMessage -SmsId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-SmsMessagesPaginated' { + It 'Test Get-SmsMessagesPaginated' { + #$TestResult = Get-SmsMessagesPaginated -PhoneNumber "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-UnreadSmsCount' { + It 'Test Get-UnreadSmsCount' { + #$TestResult = Get-UnreadSmsCount + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-ReplyToSmsMessage' { + It 'Test Invoke-ReplyToSmsMessage' { + #$TestResult = Invoke-ReplyToSmsMessage -SmsId "TEST_VALUE" -SmsReplyOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/TemplateControllerApi.Tests.ps1 b/tests/Api/TemplateControllerApi.Tests.ps1 new file mode 100644 index 00000000..79653d14 --- /dev/null +++ b/tests/Api/TemplateControllerApi.Tests.ps1 @@ -0,0 +1,74 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TemplateControllerApi' { + Context 'New-Template' { + It 'Test New-Template' { + #$TestResult = New-Template -CreateTemplateOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteTemplate' { + It 'Test Invoke-DeleteTemplate' { + #$TestResult = Invoke-DeleteTemplate -TemplateId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllTemplates' { + It 'Test Get-AllTemplates' { + #$TestResult = Get-AllTemplates -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Template' { + It 'Test Get-Template' { + #$TestResult = Get-Template -TemplateId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TemplatePreviewHtml' { + It 'Test Get-TemplatePreviewHtml' { + #$TestResult = Get-TemplatePreviewHtml -TemplateId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TemplatePreviewJson' { + It 'Test Get-TemplatePreviewJson' { + #$TestResult = Get-TemplatePreviewJson -TemplateId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Templates' { + It 'Test Get-Templates' { + #$TestResult = Get-Templates + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-Template' { + It 'Test Update-Template' { + #$TestResult = Update-Template -TemplateId "TEST_VALUE" -CreateTemplateOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/ToolsControllerApi.Tests.ps1 b/tests/Api/ToolsControllerApi.Tests.ps1 new file mode 100644 index 00000000..d39092de --- /dev/null +++ b/tests/Api/ToolsControllerApi.Tests.ps1 @@ -0,0 +1,106 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ToolsControllerApi' { + Context 'Invoke-CheckEmailFeaturesClientSupport' { + It 'Test Invoke-CheckEmailFeaturesClientSupport' { + #$TestResult = Invoke-CheckEmailFeaturesClientSupport -CheckEmailFeaturesClientSupportOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-NewFakeEmailAddress' { + It 'Test New-NewFakeEmailAddress' { + #$TestResult = New-NewFakeEmailAddress + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-BimiRecord' { + It 'Test New-BimiRecord' { + #$TestResult = New-BimiRecord -GenerateBimiRecordOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-DmarcRecord' { + It 'Test New-DmarcRecord' { + #$TestResult = New-DmarcRecord -GenerateDmarcRecordOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-MtaStsRecord' { + It 'Test New-MtaStsRecord' { + #$TestResult = New-MtaStsRecord -GenerateMtaStsRecordOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-TlsReportingRecord' { + It 'Test New-TlsReportingRecord' { + #$TestResult = New-TlsReportingRecord -GenerateTlsReportingRecordOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-FakeEmailById' { + It 'Test Get-FakeEmailById' { + #$TestResult = Get-FakeEmailById -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-FakeEmailsForAddress' { + It 'Test Get-FakeEmailsForAddress' { + #$TestResult = Get-FakeEmailsForAddress -EmailAddress "TEST_VALUE" -Page "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-LookupBimiDomain' { + It 'Test Invoke-LookupBimiDomain' { + #$TestResult = Invoke-LookupBimiDomain -LookupBimiDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-LookupDmarcDomain' { + It 'Test Invoke-LookupDmarcDomain' { + #$TestResult = Invoke-LookupDmarcDomain -LookupDmarcDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-LookupMtaStsDomain' { + It 'Test Invoke-LookupMtaStsDomain' { + #$TestResult = Invoke-LookupMtaStsDomain -LookupMtaStsDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-LookupTlsReportingDomain' { + It 'Test Invoke-LookupTlsReportingDomain' { + #$TestResult = Invoke-LookupTlsReportingDomain -LookupTlsReportingDomainOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/TrackingControllerApi.Tests.ps1 b/tests/Api/TrackingControllerApi.Tests.ps1 new file mode 100644 index 00000000..dfea53ff --- /dev/null +++ b/tests/Api/TrackingControllerApi.Tests.ps1 @@ -0,0 +1,34 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TrackingControllerApi' { + Context 'New-TrackingPixel' { + It 'Test New-TrackingPixel' { + #$TestResult = New-TrackingPixel -CreateTrackingPixelOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllTrackingPixels' { + It 'Test Get-AllTrackingPixels' { + #$TestResult = Get-AllTrackingPixels -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TrackingPixel' { + It 'Test Get-TrackingPixel' { + #$TestResult = Get-TrackingPixel -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/UserControllerApi.Tests.ps1 b/tests/Api/UserControllerApi.Tests.ps1 new file mode 100644 index 00000000..82f1e771 --- /dev/null +++ b/tests/Api/UserControllerApi.Tests.ps1 @@ -0,0 +1,26 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UserControllerApi' { + Context 'Get-JsonPropertyAsString' { + It 'Test Get-JsonPropertyAsString' { + #$TestResult = Get-JsonPropertyAsString -Property "TEST_VALUE" -Body "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-UserInfo' { + It 'Test Get-UserInfo' { + #$TestResult = Get-UserInfo + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/WaitForControllerApi.Tests.ps1 b/tests/Api/WaitForControllerApi.Tests.ps1 new file mode 100644 index 00000000..f95d0dae --- /dev/null +++ b/tests/Api/WaitForControllerApi.Tests.ps1 @@ -0,0 +1,74 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WaitForControllerApi' { + Context 'Wait-For' { + It 'Test Wait-For' { + #$TestResult = Wait-For -WaitForConditions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForEmailCount' { + It 'Test Wait-ForEmailCount' { + #$TestResult = Wait-ForEmailCount -InboxId "TEST_VALUE" -Count "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Before "TEST_VALUE" -Since "TEST_VALUE" -Sort "TEST_VALUE" -Delay "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForLatestEmail' { + It 'Test Wait-ForLatestEmail' { + #$TestResult = Wait-ForLatestEmail -InboxId "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Before "TEST_VALUE" -Since "TEST_VALUE" -Sort "TEST_VALUE" -Delay "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForLatestSms' { + It 'Test Wait-ForLatestSms' { + #$TestResult = Wait-ForLatestSms -WaitForSingleSmsOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForMatchingEmails' { + It 'Test Wait-ForMatchingEmails' { + #$TestResult = Wait-ForMatchingEmails -InboxId "TEST_VALUE" -Count "TEST_VALUE" -MatchOptions "TEST_VALUE" -Before "TEST_VALUE" -Since "TEST_VALUE" -Sort "TEST_VALUE" -Delay "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForMatchingFirstEmail' { + It 'Test Wait-ForMatchingFirstEmail' { + #$TestResult = Wait-ForMatchingFirstEmail -InboxId "TEST_VALUE" -MatchOptions "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -Sort "TEST_VALUE" -Delay "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForNthEmail' { + It 'Test Wait-ForNthEmail' { + #$TestResult = Wait-ForNthEmail -InboxId "TEST_VALUE" -Index "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -Sort "TEST_VALUE" -Delay "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForSms' { + It 'Test Wait-ForSms' { + #$TestResult = Wait-ForSms -WaitForSmsConditions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Api/WebhookControllerApi.Tests.ps1 b/tests/Api/WebhookControllerApi.Tests.ps1 new file mode 100644 index 00000000..547bd8ea --- /dev/null +++ b/tests/Api/WebhookControllerApi.Tests.ps1 @@ -0,0 +1,298 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookControllerApi' { + Context 'New-AccountWebhook' { + It 'Test New-AccountWebhook' { + #$TestResult = New-AccountWebhook -CreateWebhookOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-Webhook' { + It 'Test New-Webhook' { + #$TestResult = New-Webhook -InboxId "TEST_VALUE" -CreateWebhookOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'New-WebhookForPhoneNumber' { + It 'Test New-WebhookForPhoneNumber' { + #$TestResult = New-WebhookForPhoneNumber -PhoneNumberId "TEST_VALUE" -CreateWebhookOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteAllWebhooks' { + It 'Test Invoke-DeleteAllWebhooks' { + #$TestResult = Invoke-DeleteAllWebhooks -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteWebhook' { + It 'Test Invoke-DeleteWebhook' { + #$TestResult = Invoke-DeleteWebhook -InboxId "TEST_VALUE" -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-DeleteWebhookById' { + It 'Test Invoke-DeleteWebhookById' { + #$TestResult = Invoke-DeleteWebhookById -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllAccountWebhooks' { + It 'Test Get-AllAccountWebhooks' { + #$TestResult = Get-AllAccountWebhooks -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -EventType "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllWebhookResults' { + It 'Test Get-AllWebhookResults' { + #$TestResult = Get-AllWebhookResults -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -UnseenOnly "TEST_VALUE" -ResultType "TEST_VALUE" -EventName "TEST_VALUE" -MinStatusCode "TEST_VALUE" -MaxStatusCode "TEST_VALUE" -InboxId "TEST_VALUE" -SmsId "TEST_VALUE" -AttachmentId "TEST_VALUE" -EmailId "TEST_VALUE" -PhoneId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-AllWebhooks' { + It 'Test Get-AllWebhooks' { + #$TestResult = Get-AllWebhooks -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -InboxId "TEST_VALUE" -PhoneId "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-InboxWebhooksPaginated' { + It 'Test Get-InboxWebhooksPaginated' { + #$TestResult = Get-InboxWebhooksPaginated -InboxId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-JsonSchemaForWebhookEvent' { + It 'Test Get-JsonSchemaForWebhookEvent' { + #$TestResult = Get-JsonSchemaForWebhookEvent -Event "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-JsonSchemaForWebhookPayload' { + It 'Test Get-JsonSchemaForWebhookPayload' { + #$TestResult = Get-JsonSchemaForWebhookPayload -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-PhoneNumberWebhooksPaginated' { + It 'Test Get-PhoneNumberWebhooksPaginated' { + #$TestResult = Get-PhoneNumberWebhooksPaginated -PhoneId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayload' { + It 'Test Get-TestWebhookPayload' { + #$TestResult = Get-TestWebhookPayload -EventName "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadBounce' { + It 'Test Get-TestWebhookPayloadBounce' { + #$TestResult = Get-TestWebhookPayloadBounce + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadBounceRecipient' { + It 'Test Get-TestWebhookPayloadBounceRecipient' { + #$TestResult = Get-TestWebhookPayloadBounceRecipient + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadDeliveryStatus' { + It 'Test Get-TestWebhookPayloadDeliveryStatus' { + #$TestResult = Get-TestWebhookPayloadDeliveryStatus + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadEmailOpened' { + It 'Test Get-TestWebhookPayloadEmailOpened' { + #$TestResult = Get-TestWebhookPayloadEmailOpened + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadEmailRead' { + It 'Test Get-TestWebhookPayloadEmailRead' { + #$TestResult = Get-TestWebhookPayloadEmailRead + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadForWebhook' { + It 'Test Get-TestWebhookPayloadForWebhook' { + #$TestResult = Get-TestWebhookPayloadForWebhook -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadNewAttachment' { + It 'Test Get-TestWebhookPayloadNewAttachment' { + #$TestResult = Get-TestWebhookPayloadNewAttachment + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadNewContact' { + It 'Test Get-TestWebhookPayloadNewContact' { + #$TestResult = Get-TestWebhookPayloadNewContact + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadNewEmail' { + It 'Test Get-TestWebhookPayloadNewEmail' { + #$TestResult = Get-TestWebhookPayloadNewEmail + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-TestWebhookPayloadNewSms' { + It 'Test Get-TestWebhookPayloadNewSms' { + #$TestResult = Get-TestWebhookPayloadNewSms + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Webhook' { + It 'Test Get-Webhook' { + #$TestResult = Get-Webhook -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-WebhookResult' { + It 'Test Get-WebhookResult' { + #$TestResult = Get-WebhookResult -WebhookResultId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-WebhookResults' { + It 'Test Get-WebhookResults' { + #$TestResult = Get-WebhookResults -WebhookId "TEST_VALUE" -Page "TEST_VALUE" -Size "TEST_VALUE" -Sort "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -UnseenOnly "TEST_VALUE" -ResultType "TEST_VALUE" -EventName "TEST_VALUE" -MinStatusCode "TEST_VALUE" -MaxStatusCode "TEST_VALUE" -InboxId "TEST_VALUE" -SmsId "TEST_VALUE" -AttachmentId "TEST_VALUE" -EmailId "TEST_VALUE" -PhoneId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-WebhookResultsCount' { + It 'Test Get-WebhookResultsCount' { + #$TestResult = Get-WebhookResultsCount -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-WebhookResultsUnseenErrorCount' { + It 'Test Get-WebhookResultsUnseenErrorCount' { + #$TestResult = Get-WebhookResultsUnseenErrorCount + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Get-Webhooks' { + It 'Test Get-Webhooks' { + #$TestResult = Get-Webhooks -InboxId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-RedriveAllWebhookResults' { + It 'Test Invoke-RedriveAllWebhookResults' { + #$TestResult = Invoke-RedriveAllWebhookResults + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Invoke-RedriveWebhookResult' { + It 'Test Invoke-RedriveWebhookResult' { + #$TestResult = Invoke-RedriveWebhookResult -WebhookResultId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Send-TestData' { + It 'Test Send-TestData' { + #$TestResult = Send-TestData -WebhookId "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Update-WebhookHeaders' { + It 'Test Update-WebhookHeaders' { + #$TestResult = Update-WebhookHeaders -WebhookId "TEST_VALUE" -WebhookHeaders "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Test-WebhookSignature' { + It 'Test Test-WebhookSignature' { + #$TestResult = Test-WebhookSignature -VerifyWebhookSignatureOptions "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + + Context 'Wait-ForWebhookResults' { + It 'Test Wait-ForWebhookResults' { + #$TestResult = Wait-ForWebhookResults -WebhookId "TEST_VALUE" -ExpectedCount "TEST_VALUE" -Timeout "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + +} diff --git a/tests/Model/AbstractWebhookPayload.Tests.ps1 b/tests/Model/AbstractWebhookPayload.Tests.ps1 new file mode 100644 index 00000000..fa4d897d --- /dev/null +++ b/tests/Model/AbstractWebhookPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AbstractWebhookPayload' { + Context 'AbstractWebhookPayload' { + It 'Initialize-AbstractWebhookPayload' { + # a simple test to create an object + #$NewObject = Initialize-AbstractWebhookPayload -EventName "TEST_VALUE" -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -WebhookName "TEST_VALUE" + #$NewObject | Should -BeOfType AbstractWebhookPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/AccountBounceBlockDto.Tests.ps1 b/tests/Model/AccountBounceBlockDto.Tests.ps1 new file mode 100644 index 00000000..d9712be9 --- /dev/null +++ b/tests/Model/AccountBounceBlockDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AccountBounceBlockDto' { + Context 'AccountBounceBlockDto' { + It 'Initialize-AccountBounceBlockDto' { + # a simple test to create an object + #$NewObject = Initialize-AccountBounceBlockDto -IsSendingBlocked "TEST_VALUE" -BounceCount "TEST_VALUE" -BounceCountToday "TEST_VALUE" -MaximumDailyBounces "TEST_VALUE" -MaximumAccountBounces "TEST_VALUE" + #$NewObject | Should -BeOfType AccountBounceBlockDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/AliasDto.Tests.ps1 b/tests/Model/AliasDto.Tests.ps1 new file mode 100644 index 00000000..877375ac --- /dev/null +++ b/tests/Model/AliasDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AliasDto' { + Context 'AliasDto' { + It 'Initialize-AliasDto' { + # a simple test to create an object + #$NewObject = Initialize-AliasDto -Id "TEST_VALUE" -EmailAddress "TEST_VALUE" -MaskedEmailAddress "TEST_VALUE" -UserId "TEST_VALUE" -InboxId "TEST_VALUE" -Name "TEST_VALUE" -UseThreads "TEST_VALUE" -IsVerified "TEST_VALUE" -DomainId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType AliasDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/AliasProjection.Tests.ps1 b/tests/Model/AliasProjection.Tests.ps1 new file mode 100644 index 00000000..2a9971a5 --- /dev/null +++ b/tests/Model/AliasProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AliasProjection' { + Context 'AliasProjection' { + It 'Initialize-AliasProjection' { + # a simple test to create an object + #$NewObject = Initialize-AliasProjection -EmailAddress "TEST_VALUE" -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -UseThreads "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType AliasProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/AttachmentEntity.Tests.ps1 b/tests/Model/AttachmentEntity.Tests.ps1 new file mode 100644 index 00000000..06f27a7e --- /dev/null +++ b/tests/Model/AttachmentEntity.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AttachmentEntity' { + Context 'AttachmentEntity' { + It 'Initialize-AttachmentEntity' { + # a simple test to create an object + #$NewObject = Initialize-AttachmentEntity -Id "TEST_VALUE" -AttachmentId "TEST_VALUE" -Bucket "TEST_VALUE" -UserId "TEST_VALUE" -ContentType "TEST_VALUE" -ContentLength "TEST_VALUE" -ContentId "TEST_VALUE" -Name "TEST_VALUE" -InboxId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType AttachmentEntity + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/AttachmentMetaData.Tests.ps1 b/tests/Model/AttachmentMetaData.Tests.ps1 new file mode 100644 index 00000000..91988c59 --- /dev/null +++ b/tests/Model/AttachmentMetaData.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AttachmentMetaData' { + Context 'AttachmentMetaData' { + It 'Initialize-AttachmentMetaData' { + # a simple test to create an object + #$NewObject = Initialize-AttachmentMetaData -Name "TEST_VALUE" -ContentType "TEST_VALUE" -ContentLength "TEST_VALUE" -Id "TEST_VALUE" -ContentId "TEST_VALUE" + #$NewObject | Should -BeOfType AttachmentMetaData + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/AttachmentProjection.Tests.ps1 b/tests/Model/AttachmentProjection.Tests.ps1 new file mode 100644 index 00000000..be0a07ac --- /dev/null +++ b/tests/Model/AttachmentProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'AttachmentProjection' { + Context 'AttachmentProjection' { + It 'Initialize-AttachmentProjection' { + # a simple test to create an object + #$NewObject = Initialize-AttachmentProjection -UserId "TEST_VALUE" -ContentId "TEST_VALUE" -AttachmentId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Name "TEST_VALUE" -ContentLength "TEST_VALUE" -ContentType "TEST_VALUE" + #$NewObject | Should -BeOfType AttachmentProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/BasicAuthOptions.Tests.ps1 b/tests/Model/BasicAuthOptions.Tests.ps1 new file mode 100644 index 00000000..ecda955b --- /dev/null +++ b/tests/Model/BasicAuthOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BasicAuthOptions' { + Context 'BasicAuthOptions' { + It 'Initialize-BasicAuthOptions' { + # a simple test to create an object + #$NewObject = Initialize-BasicAuthOptions -Username "TEST_VALUE" -Password "TEST_VALUE" + #$NewObject | Should -BeOfType BasicAuthOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/BounceProjection.Tests.ps1 b/tests/Model/BounceProjection.Tests.ps1 new file mode 100644 index 00000000..ddb73674 --- /dev/null +++ b/tests/Model/BounceProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BounceProjection' { + Context 'BounceProjection' { + It 'Initialize-BounceProjection' { + # a simple test to create an object + #$NewObject = Initialize-BounceProjection -VarSender "TEST_VALUE" -BounceMta "TEST_VALUE" -BounceType "TEST_VALUE" -CreatedAt "TEST_VALUE" -Subject "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType BounceProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/BounceRecipientProjection.Tests.ps1 b/tests/Model/BounceRecipientProjection.Tests.ps1 new file mode 100644 index 00000000..2fecae2d --- /dev/null +++ b/tests/Model/BounceRecipientProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BounceRecipientProjection' { + Context 'BounceRecipientProjection' { + It 'Initialize-BounceRecipientProjection' { + # a simple test to create an object + #$NewObject = Initialize-BounceRecipientProjection -SentEmailId "TEST_VALUE" -Recipient "TEST_VALUE" -Action "TEST_VALUE" -BounceType "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" -Status "TEST_VALUE" + #$NewObject | Should -BeOfType BounceRecipientProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/BouncedEmailDto.Tests.ps1 b/tests/Model/BouncedEmailDto.Tests.ps1 new file mode 100644 index 00000000..101521fd --- /dev/null +++ b/tests/Model/BouncedEmailDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BouncedEmailDto' { + Context 'BouncedEmailDto' { + It 'Initialize-BouncedEmailDto' { + # a simple test to create an object + #$NewObject = Initialize-BouncedEmailDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -NotificationType "TEST_VALUE" -SentToRecipients "TEST_VALUE" -VarSender "TEST_VALUE" -BounceMta "TEST_VALUE" -BounceType "TEST_VALUE" -BounceRecipients "TEST_VALUE" -BounceSubType "TEST_VALUE" -SentEmailId "TEST_VALUE" -Subject "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType BouncedEmailDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/BouncedRecipientDto.Tests.ps1 b/tests/Model/BouncedRecipientDto.Tests.ps1 new file mode 100644 index 00000000..71d4a78c --- /dev/null +++ b/tests/Model/BouncedRecipientDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BouncedRecipientDto' { + Context 'BouncedRecipientDto' { + It 'Initialize-BouncedRecipientDto' { + # a simple test to create an object + #$NewObject = Initialize-BouncedRecipientDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -SentEmailId "TEST_VALUE" -Recipient "TEST_VALUE" -DiagnosticCode "TEST_VALUE" -Action "TEST_VALUE" -BounceType "TEST_VALUE" -Status "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType BouncedRecipientDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/BulkSendEmailOptions.Tests.ps1 b/tests/Model/BulkSendEmailOptions.Tests.ps1 new file mode 100644 index 00000000..c718a6ca --- /dev/null +++ b/tests/Model/BulkSendEmailOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'BulkSendEmailOptions' { + Context 'BulkSendEmailOptions' { + It 'Initialize-BulkSendEmailOptions' { + # a simple test to create an object + #$NewObject = Initialize-BulkSendEmailOptions -InboxIds "TEST_VALUE" -SendEmailOptions "TEST_VALUE" + #$NewObject | Should -BeOfType BulkSendEmailOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CanSendEmailResults.Tests.ps1 b/tests/Model/CanSendEmailResults.Tests.ps1 new file mode 100644 index 00000000..ba0878f3 --- /dev/null +++ b/tests/Model/CanSendEmailResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CanSendEmailResults' { + Context 'CanSendEmailResults' { + It 'Initialize-CanSendEmailResults' { + # a simple test to create an object + #$NewObject = Initialize-CanSendEmailResults -IsSendingPermitted "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType CanSendEmailResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CheckEmailBodyFeatureSupportResults.Tests.ps1 b/tests/Model/CheckEmailBodyFeatureSupportResults.Tests.ps1 new file mode 100644 index 00000000..b8b7207e --- /dev/null +++ b/tests/Model/CheckEmailBodyFeatureSupportResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CheckEmailBodyFeatureSupportResults' { + Context 'CheckEmailBodyFeatureSupportResults' { + It 'Initialize-CheckEmailBodyFeatureSupportResults' { + # a simple test to create an object + #$NewObject = Initialize-CheckEmailBodyFeatureSupportResults -Result "TEST_VALUE" + #$NewObject | Should -BeOfType CheckEmailBodyFeatureSupportResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CheckEmailBodyResults.Tests.ps1 b/tests/Model/CheckEmailBodyResults.Tests.ps1 new file mode 100644 index 00000000..3ce4ef46 --- /dev/null +++ b/tests/Model/CheckEmailBodyResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CheckEmailBodyResults' { + Context 'CheckEmailBodyResults' { + It 'Initialize-CheckEmailBodyResults' { + # a simple test to create an object + #$NewObject = Initialize-CheckEmailBodyResults -HasIssues "TEST_VALUE" -LinkIssues "TEST_VALUE" -ImageIssues "TEST_VALUE" -SpellingIssues "TEST_VALUE" + #$NewObject | Should -BeOfType CheckEmailBodyResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CheckEmailClientSupportOptions.Tests.ps1 b/tests/Model/CheckEmailClientSupportOptions.Tests.ps1 new file mode 100644 index 00000000..29ffe839 --- /dev/null +++ b/tests/Model/CheckEmailClientSupportOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CheckEmailClientSupportOptions' { + Context 'CheckEmailClientSupportOptions' { + It 'Initialize-CheckEmailClientSupportOptions' { + # a simple test to create an object + #$NewObject = Initialize-CheckEmailClientSupportOptions -EmailBody "TEST_VALUE" + #$NewObject | Should -BeOfType CheckEmailClientSupportOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CheckEmailClientSupportResults.Tests.ps1 b/tests/Model/CheckEmailClientSupportResults.Tests.ps1 new file mode 100644 index 00000000..a747083b --- /dev/null +++ b/tests/Model/CheckEmailClientSupportResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CheckEmailClientSupportResults' { + Context 'CheckEmailClientSupportResults' { + It 'Initialize-CheckEmailClientSupportResults' { + # a simple test to create an object + #$NewObject = Initialize-CheckEmailClientSupportResults -Result "TEST_VALUE" + #$NewObject | Should -BeOfType CheckEmailClientSupportResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CheckEmailFeaturesClientSupportOptions.Tests.ps1 b/tests/Model/CheckEmailFeaturesClientSupportOptions.Tests.ps1 new file mode 100644 index 00000000..ac7fda0f --- /dev/null +++ b/tests/Model/CheckEmailFeaturesClientSupportOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CheckEmailFeaturesClientSupportOptions' { + Context 'CheckEmailFeaturesClientSupportOptions' { + It 'Initialize-CheckEmailFeaturesClientSupportOptions' { + # a simple test to create an object + #$NewObject = Initialize-CheckEmailFeaturesClientSupportOptions -EmailBody "TEST_VALUE" + #$NewObject | Should -BeOfType CheckEmailFeaturesClientSupportOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CheckEmailFeaturesClientSupportResults.Tests.ps1 b/tests/Model/CheckEmailFeaturesClientSupportResults.Tests.ps1 new file mode 100644 index 00000000..91b4d403 --- /dev/null +++ b/tests/Model/CheckEmailFeaturesClientSupportResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CheckEmailFeaturesClientSupportResults' { + Context 'CheckEmailFeaturesClientSupportResults' { + It 'Initialize-CheckEmailFeaturesClientSupportResults' { + # a simple test to create an object + #$NewObject = Initialize-CheckEmailFeaturesClientSupportResults -Result "TEST_VALUE" + #$NewObject | Should -BeOfType CheckEmailFeaturesClientSupportResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/Complaint.Tests.ps1 b/tests/Model/Complaint.Tests.ps1 new file mode 100644 index 00000000..9a741a49 --- /dev/null +++ b/tests/Model/Complaint.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'Complaint' { + Context 'Complaint' { + It 'Initialize-Complaint' { + # a simple test to create an object + #$NewObject = Initialize-Complaint -Id "TEST_VALUE" -UserId "TEST_VALUE" -EventType "TEST_VALUE" -MailSource "TEST_VALUE" -MailMessageId "TEST_VALUE" -ComplaintRecipient "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType Complaint + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConditionOption.Tests.ps1 b/tests/Model/ConditionOption.Tests.ps1 new file mode 100644 index 00000000..344e900f --- /dev/null +++ b/tests/Model/ConditionOption.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConditionOption' { + Context 'ConditionOption' { + It 'Initialize-ConditionOption' { + # a simple test to create an object + #$NewObject = Initialize-ConditionOption -Condition "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType ConditionOption + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorDto.Tests.ps1 b/tests/Model/ConnectorDto.Tests.ps1 new file mode 100644 index 00000000..684c430f --- /dev/null +++ b/tests/Model/ConnectorDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorDto' { + Context 'ConnectorDto' { + It 'Initialize-ConnectorDto' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorDto -Id "TEST_VALUE" -Name "TEST_VALUE" -Enabled "TEST_VALUE" -UserId "TEST_VALUE" -InboxId "TEST_VALUE" -SyncEnabled "TEST_VALUE" -SyncScheduleType "TEST_VALUE" -SyncInterval "TEST_VALUE" -HasImapConnection "TEST_VALUE" -HasSmtpConnection "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorImapConnectionDto.Tests.ps1 b/tests/Model/ConnectorImapConnectionDto.Tests.ps1 new file mode 100644 index 00000000..0f61ca83 --- /dev/null +++ b/tests/Model/ConnectorImapConnectionDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorImapConnectionDto' { + Context 'ConnectorImapConnectionDto' { + It 'Initialize-ConnectorImapConnectionDto' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorImapConnectionDto -ConnectorId "TEST_VALUE" -ImapHost "TEST_VALUE" -ImapPort "TEST_VALUE" -ImapUsername "TEST_VALUE" -ImapPassword "TEST_VALUE" -ImapSsl "TEST_VALUE" -SelectFolder "TEST_VALUE" -SearchTerms "TEST_VALUE" -Enabled "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorImapConnectionDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorProjection.Tests.ps1 b/tests/Model/ConnectorProjection.Tests.ps1 new file mode 100644 index 00000000..9a8a23ae --- /dev/null +++ b/tests/Model/ConnectorProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorProjection' { + Context 'ConnectorProjection' { + It 'Initialize-ConnectorProjection' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorProjection -Enabled "TEST_VALUE" -EmailAddress "TEST_VALUE" -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -SyncEnabled "TEST_VALUE" -SyncScheduleType "TEST_VALUE" -SyncInterval "TEST_VALUE" -CreatedAt "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSmtpConnectionDto.Tests.ps1 b/tests/Model/ConnectorSmtpConnectionDto.Tests.ps1 new file mode 100644 index 00000000..1de79042 --- /dev/null +++ b/tests/Model/ConnectorSmtpConnectionDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSmtpConnectionDto' { + Context 'ConnectorSmtpConnectionDto' { + It 'Initialize-ConnectorSmtpConnectionDto' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSmtpConnectionDto -ConnectorId "TEST_VALUE" -SmtpHost "TEST_VALUE" -SmtpPort "TEST_VALUE" -SmtpUsername "TEST_VALUE" -SmtpPassword "TEST_VALUE" -SmtpSsl "TEST_VALUE" -Enabled "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSmtpConnectionDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncEventDto.Tests.ps1 b/tests/Model/ConnectorSyncEventDto.Tests.ps1 new file mode 100644 index 00000000..560baeb2 --- /dev/null +++ b/tests/Model/ConnectorSyncEventDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncEventDto' { + Context 'ConnectorSyncEventDto' { + It 'Initialize-ConnectorSyncEventDto' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncEventDto -Id "TEST_VALUE" -ConnectorId "TEST_VALUE" -SyncStatus "TEST_VALUE" -SyncCount "TEST_VALUE" -Message "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncEventDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncEventProjection.Tests.ps1 b/tests/Model/ConnectorSyncEventProjection.Tests.ps1 new file mode 100644 index 00000000..d4499c33 --- /dev/null +++ b/tests/Model/ConnectorSyncEventProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncEventProjection' { + Context 'ConnectorSyncEventProjection' { + It 'Initialize-ConnectorSyncEventProjection' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncEventProjection -ConnectorId "TEST_VALUE" -SyncCount "TEST_VALUE" -SyncStatus "TEST_VALUE" -CreatedAt "TEST_VALUE" -Message "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncEventProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncRequestResult.Tests.ps1 b/tests/Model/ConnectorSyncRequestResult.Tests.ps1 new file mode 100644 index 00000000..930e3ef5 --- /dev/null +++ b/tests/Model/ConnectorSyncRequestResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncRequestResult' { + Context 'ConnectorSyncRequestResult' { + It 'Initialize-ConnectorSyncRequestResult' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncRequestResult -SyncResult "TEST_VALUE" -Exception "TEST_VALUE" -EventId "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncRequestResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncRequestResultException.Tests.ps1 b/tests/Model/ConnectorSyncRequestResultException.Tests.ps1 new file mode 100644 index 00000000..66f82c86 --- /dev/null +++ b/tests/Model/ConnectorSyncRequestResultException.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncRequestResultException' { + Context 'ConnectorSyncRequestResultException' { + It 'Initialize-ConnectorSyncRequestResultException' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncRequestResultException -Cause "TEST_VALUE" -VarStackTrace "TEST_VALUE" -Message "TEST_VALUE" -Suppressed "TEST_VALUE" -LocalizedMessage "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncRequestResultException + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncRequestResultExceptionCause.Tests.ps1 b/tests/Model/ConnectorSyncRequestResultExceptionCause.Tests.ps1 new file mode 100644 index 00000000..312552cc --- /dev/null +++ b/tests/Model/ConnectorSyncRequestResultExceptionCause.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncRequestResultExceptionCause' { + Context 'ConnectorSyncRequestResultExceptionCause' { + It 'Initialize-ConnectorSyncRequestResultExceptionCause' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncRequestResultExceptionCause -VarStackTrace "TEST_VALUE" -Message "TEST_VALUE" -LocalizedMessage "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncRequestResultExceptionCause + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.Tests.ps1 b/tests/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.Tests.ps1 new file mode 100644 index 00000000..6b19e1a6 --- /dev/null +++ b/tests/Model/ConnectorSyncRequestResultExceptionCauseStackTrace.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncRequestResultExceptionCauseStackTrace' { + Context 'ConnectorSyncRequestResultExceptionCauseStackTrace' { + It 'Initialize-ConnectorSyncRequestResultExceptionCauseStackTrace' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncRequestResultExceptionCauseStackTrace -ClassLoaderName "TEST_VALUE" -ModuleName "TEST_VALUE" -ModuleVersion "TEST_VALUE" -MethodName "TEST_VALUE" -FileName "TEST_VALUE" -LineNumber "TEST_VALUE" -ClassName "TEST_VALUE" -NativeMethod "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncRequestResultExceptionCauseStackTrace + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ConnectorSyncResult.Tests.ps1 b/tests/Model/ConnectorSyncResult.Tests.ps1 new file mode 100644 index 00000000..c7e12163 --- /dev/null +++ b/tests/Model/ConnectorSyncResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ConnectorSyncResult' { + Context 'ConnectorSyncResult' { + It 'Initialize-ConnectorSyncResult' { + # a simple test to create an object + #$NewObject = Initialize-ConnectorSyncResult -EmailSyncCount "TEST_VALUE" -LogLines "TEST_VALUE" + #$NewObject | Should -BeOfType ConnectorSyncResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ContactDto.Tests.ps1 b/tests/Model/ContactDto.Tests.ps1 new file mode 100644 index 00000000..3b74cbec --- /dev/null +++ b/tests/Model/ContactDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ContactDto' { + Context 'ContactDto' { + It 'Initialize-ContactDto' { + # a simple test to create an object + #$NewObject = Initialize-ContactDto -Id "TEST_VALUE" -GroupId "TEST_VALUE" -FirstName "TEST_VALUE" -LastName "TEST_VALUE" -Company "TEST_VALUE" -EmailAddresses "TEST_VALUE" -PrimaryEmailAddress "TEST_VALUE" -Tags "TEST_VALUE" -MetaData "TEST_VALUE" -OptOut "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType ContactDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ContactProjection.Tests.ps1 b/tests/Model/ContactProjection.Tests.ps1 new file mode 100644 index 00000000..d83836ba --- /dev/null +++ b/tests/Model/ContactProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ContactProjection' { + Context 'ContactProjection' { + It 'Initialize-ContactProjection' { + # a simple test to create an object + #$NewObject = Initialize-ContactProjection -EmailAddress "TEST_VALUE" -EmailAddresses "TEST_VALUE" -FirstName "TEST_VALUE" -LastName "TEST_VALUE" -Company "TEST_VALUE" -OptOut "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" -GroupId "TEST_VALUE" + #$NewObject | Should -BeOfType ContactProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ContentMatchOptions.Tests.ps1 b/tests/Model/ContentMatchOptions.Tests.ps1 new file mode 100644 index 00000000..bc9eaa76 --- /dev/null +++ b/tests/Model/ContentMatchOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ContentMatchOptions' { + Context 'ContentMatchOptions' { + It 'Initialize-ContentMatchOptions' { + # a simple test to create an object + #$NewObject = Initialize-ContentMatchOptions -Pattern "TEST_VALUE" + #$NewObject | Should -BeOfType ContentMatchOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CountDto.Tests.ps1 b/tests/Model/CountDto.Tests.ps1 new file mode 100644 index 00000000..587e4bc2 --- /dev/null +++ b/tests/Model/CountDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CountDto' { + Context 'CountDto' { + It 'Initialize-CountDto' { + # a simple test to create an object + #$NewObject = Initialize-CountDto -TotalElements "TEST_VALUE" + #$NewObject | Should -BeOfType CountDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateAliasOptions.Tests.ps1 b/tests/Model/CreateAliasOptions.Tests.ps1 new file mode 100644 index 00000000..b7659a62 --- /dev/null +++ b/tests/Model/CreateAliasOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateAliasOptions' { + Context 'CreateAliasOptions' { + It 'Initialize-CreateAliasOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateAliasOptions -EmailAddress "TEST_VALUE" -InboxId "TEST_VALUE" -Name "TEST_VALUE" -UseThreads "TEST_VALUE" -DomainId "TEST_VALUE" -VerifyEmailAddress "TEST_VALUE" + #$NewObject | Should -BeOfType CreateAliasOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateConnectorImapConnectionOptions.Tests.ps1 b/tests/Model/CreateConnectorImapConnectionOptions.Tests.ps1 new file mode 100644 index 00000000..4c864d15 --- /dev/null +++ b/tests/Model/CreateConnectorImapConnectionOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateConnectorImapConnectionOptions' { + Context 'CreateConnectorImapConnectionOptions' { + It 'Initialize-CreateConnectorImapConnectionOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateConnectorImapConnectionOptions -ImapSsl "TEST_VALUE" -ImapUsername "TEST_VALUE" -ImapPassword "TEST_VALUE" -SelectFolder "TEST_VALUE" -SearchTerms "TEST_VALUE" -ImapPort "TEST_VALUE" -ImapHost "TEST_VALUE" -Enabled "TEST_VALUE" + #$NewObject | Should -BeOfType CreateConnectorImapConnectionOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateConnectorOptions.Tests.ps1 b/tests/Model/CreateConnectorOptions.Tests.ps1 new file mode 100644 index 00000000..25bbaacb --- /dev/null +++ b/tests/Model/CreateConnectorOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateConnectorOptions' { + Context 'CreateConnectorOptions' { + It 'Initialize-CreateConnectorOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateConnectorOptions -SyncEnabled "TEST_VALUE" -SyncScheduleType "TEST_VALUE" -SyncInterval "TEST_VALUE" -Name "TEST_VALUE" -EmailAddress "TEST_VALUE" -Enabled "TEST_VALUE" + #$NewObject | Should -BeOfType CreateConnectorOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateConnectorSmtpConnectionOptions.Tests.ps1 b/tests/Model/CreateConnectorSmtpConnectionOptions.Tests.ps1 new file mode 100644 index 00000000..52bc2634 --- /dev/null +++ b/tests/Model/CreateConnectorSmtpConnectionOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateConnectorSmtpConnectionOptions' { + Context 'CreateConnectorSmtpConnectionOptions' { + It 'Initialize-CreateConnectorSmtpConnectionOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateConnectorSmtpConnectionOptions -Enabled "TEST_VALUE" -SmtpHost "TEST_VALUE" -SmtpPort "TEST_VALUE" -SmtpSsl "TEST_VALUE" -SmtpUsername "TEST_VALUE" -SmtpPassword "TEST_VALUE" + #$NewObject | Should -BeOfType CreateConnectorSmtpConnectionOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateContactOptions.Tests.ps1 b/tests/Model/CreateContactOptions.Tests.ps1 new file mode 100644 index 00000000..205ec691 --- /dev/null +++ b/tests/Model/CreateContactOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateContactOptions' { + Context 'CreateContactOptions' { + It 'Initialize-CreateContactOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateContactOptions -FirstName "TEST_VALUE" -LastName "TEST_VALUE" -Company "TEST_VALUE" -EmailAddresses "TEST_VALUE" -Tags "TEST_VALUE" -MetaData "TEST_VALUE" -OptOut "TEST_VALUE" -GroupId "TEST_VALUE" -VerifyEmailAddresses "TEST_VALUE" + #$NewObject | Should -BeOfType CreateContactOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateDomainOptions.Tests.ps1 b/tests/Model/CreateDomainOptions.Tests.ps1 new file mode 100644 index 00000000..c03f0d45 --- /dev/null +++ b/tests/Model/CreateDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateDomainOptions' { + Context 'CreateDomainOptions' { + It 'Initialize-CreateDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateDomainOptions -Domain "TEST_VALUE" -Description "TEST_VALUE" -CreatedCatchAllInbox "TEST_VALUE" -DomainType "TEST_VALUE" + #$NewObject | Should -BeOfType CreateDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateEmergencyAddressOptions.Tests.ps1 b/tests/Model/CreateEmergencyAddressOptions.Tests.ps1 new file mode 100644 index 00000000..3cef9118 --- /dev/null +++ b/tests/Model/CreateEmergencyAddressOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateEmergencyAddressOptions' { + Context 'CreateEmergencyAddressOptions' { + It 'Initialize-CreateEmergencyAddressOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateEmergencyAddressOptions -CustomerName "TEST_VALUE" -Address1 "TEST_VALUE" -City "TEST_VALUE" -Region "TEST_VALUE" -PostalCode "TEST_VALUE" -IsoCountryCode "TEST_VALUE" -DisplayName "TEST_VALUE" + #$NewObject | Should -BeOfType CreateEmergencyAddressOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateGroupOptions.Tests.ps1 b/tests/Model/CreateGroupOptions.Tests.ps1 new file mode 100644 index 00000000..ce19c07d --- /dev/null +++ b/tests/Model/CreateGroupOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateGroupOptions' { + Context 'CreateGroupOptions' { + It 'Initialize-CreateGroupOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateGroupOptions -Name "TEST_VALUE" -Description "TEST_VALUE" + #$NewObject | Should -BeOfType CreateGroupOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateInboxDto.Tests.ps1 b/tests/Model/CreateInboxDto.Tests.ps1 new file mode 100644 index 00000000..f11f643b --- /dev/null +++ b/tests/Model/CreateInboxDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateInboxDto' { + Context 'CreateInboxDto' { + It 'Initialize-CreateInboxDto' { + # a simple test to create an object + #$NewObject = Initialize-CreateInboxDto -EmailAddress "TEST_VALUE" -DomainName "TEST_VALUE" -DomainId "TEST_VALUE" -Name "TEST_VALUE" -Description "TEST_VALUE" -UseDomainPool "TEST_VALUE" -Tags "TEST_VALUE" -ExpiresAt "TEST_VALUE" -Favourite "TEST_VALUE" -ExpiresIn "TEST_VALUE" -AllowTeamAccess "TEST_VALUE" -InboxType "TEST_VALUE" -VirtualInbox "TEST_VALUE" -UseShortAddress "TEST_VALUE" -Prefix "TEST_VALUE" + #$NewObject | Should -BeOfType CreateInboxDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateInboxForwarderOptions.Tests.ps1 b/tests/Model/CreateInboxForwarderOptions.Tests.ps1 new file mode 100644 index 00000000..9670d621 --- /dev/null +++ b/tests/Model/CreateInboxForwarderOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateInboxForwarderOptions' { + Context 'CreateInboxForwarderOptions' { + It 'Initialize-CreateInboxForwarderOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateInboxForwarderOptions -Field "TEST_VALUE" -Match "TEST_VALUE" -ForwardToRecipients "TEST_VALUE" + #$NewObject | Should -BeOfType CreateInboxForwarderOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateInboxReplierOptions.Tests.ps1 b/tests/Model/CreateInboxReplierOptions.Tests.ps1 new file mode 100644 index 00000000..51743c87 --- /dev/null +++ b/tests/Model/CreateInboxReplierOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateInboxReplierOptions' { + Context 'CreateInboxReplierOptions' { + It 'Initialize-CreateInboxReplierOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateInboxReplierOptions -InboxId "TEST_VALUE" -Name "TEST_VALUE" -Field "TEST_VALUE" -Match "TEST_VALUE" -ReplyTo "TEST_VALUE" -Subject "TEST_VALUE" -VarFrom "TEST_VALUE" -Charset "TEST_VALUE" -IgnoreReplyTo "TEST_VALUE" -IsHTML "TEST_VALUE" -Body "TEST_VALUE" -TemplateId "TEST_VALUE" -TemplateVariables "TEST_VALUE" + #$NewObject | Should -BeOfType CreateInboxReplierOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateInboxRulesetOptions.Tests.ps1 b/tests/Model/CreateInboxRulesetOptions.Tests.ps1 new file mode 100644 index 00000000..306c6319 --- /dev/null +++ b/tests/Model/CreateInboxRulesetOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateInboxRulesetOptions' { + Context 'CreateInboxRulesetOptions' { + It 'Initialize-CreateInboxRulesetOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateInboxRulesetOptions -Scope "TEST_VALUE" -Action "TEST_VALUE" -Target "TEST_VALUE" + #$NewObject | Should -BeOfType CreateInboxRulesetOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateTemplateOptions.Tests.ps1 b/tests/Model/CreateTemplateOptions.Tests.ps1 new file mode 100644 index 00000000..6378d333 --- /dev/null +++ b/tests/Model/CreateTemplateOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateTemplateOptions' { + Context 'CreateTemplateOptions' { + It 'Initialize-CreateTemplateOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateTemplateOptions -Name "TEST_VALUE" -Content "TEST_VALUE" + #$NewObject | Should -BeOfType CreateTemplateOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateTrackingPixelOptions.Tests.ps1 b/tests/Model/CreateTrackingPixelOptions.Tests.ps1 new file mode 100644 index 00000000..525d7f17 --- /dev/null +++ b/tests/Model/CreateTrackingPixelOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateTrackingPixelOptions' { + Context 'CreateTrackingPixelOptions' { + It 'Initialize-CreateTrackingPixelOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateTrackingPixelOptions -Name "TEST_VALUE" -Recipient "TEST_VALUE" + #$NewObject | Should -BeOfType CreateTrackingPixelOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/CreateWebhookOptions.Tests.ps1 b/tests/Model/CreateWebhookOptions.Tests.ps1 new file mode 100644 index 00000000..59c55cb8 --- /dev/null +++ b/tests/Model/CreateWebhookOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'CreateWebhookOptions' { + Context 'CreateWebhookOptions' { + It 'Initialize-CreateWebhookOptions' { + # a simple test to create an object + #$NewObject = Initialize-CreateWebhookOptions -Url "TEST_VALUE" -BasicAuth "TEST_VALUE" -Name "TEST_VALUE" -EventName "TEST_VALUE" -IncludeHeaders "TEST_VALUE" -RequestBodyTemplate "TEST_VALUE" -UseStaticIpRange "TEST_VALUE" -IgnoreInsecureSslCertificates "TEST_VALUE" + #$NewObject | Should -BeOfType CreateWebhookOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DNSLookupOptions.Tests.ps1 b/tests/Model/DNSLookupOptions.Tests.ps1 new file mode 100644 index 00000000..63318a4e --- /dev/null +++ b/tests/Model/DNSLookupOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DNSLookupOptions' { + Context 'DNSLookupOptions' { + It 'Initialize-DNSLookupOptions' { + # a simple test to create an object + #$NewObject = Initialize-DNSLookupOptions -Hostname "TEST_VALUE" -RecordTypes "TEST_VALUE" -OmitFinalDNSDot "TEST_VALUE" + #$NewObject | Should -BeOfType DNSLookupOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DNSLookupResult.Tests.ps1 b/tests/Model/DNSLookupResult.Tests.ps1 new file mode 100644 index 00000000..ebd790df --- /dev/null +++ b/tests/Model/DNSLookupResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DNSLookupResult' { + Context 'DNSLookupResult' { + It 'Initialize-DNSLookupResult' { + # a simple test to create an object + #$NewObject = Initialize-DNSLookupResult -RecordType "TEST_VALUE" -Ttl "TEST_VALUE" -RecordEntries "TEST_VALUE" -Name "TEST_VALUE" + #$NewObject | Should -BeOfType DNSLookupResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DNSLookupResults.Tests.ps1 b/tests/Model/DNSLookupResults.Tests.ps1 new file mode 100644 index 00000000..60497815 --- /dev/null +++ b/tests/Model/DNSLookupResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DNSLookupResults' { + Context 'DNSLookupResults' { + It 'Initialize-DNSLookupResults' { + # a simple test to create an object + #$NewObject = Initialize-DNSLookupResults -Results "TEST_VALUE" + #$NewObject | Should -BeOfType DNSLookupResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DNSLookupsOptions.Tests.ps1 b/tests/Model/DNSLookupsOptions.Tests.ps1 new file mode 100644 index 00000000..f46635da --- /dev/null +++ b/tests/Model/DNSLookupsOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DNSLookupsOptions' { + Context 'DNSLookupsOptions' { + It 'Initialize-DNSLookupsOptions' { + # a simple test to create an object + #$NewObject = Initialize-DNSLookupsOptions -Lookups "TEST_VALUE" + #$NewObject | Should -BeOfType DNSLookupsOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DeliveryStatusDto.Tests.ps1 b/tests/Model/DeliveryStatusDto.Tests.ps1 new file mode 100644 index 00000000..e5a12b45 --- /dev/null +++ b/tests/Model/DeliveryStatusDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DeliveryStatusDto' { + Context 'DeliveryStatusDto' { + It 'Initialize-DeliveryStatusDto' { + # a simple test to create an object + #$NewObject = Initialize-DeliveryStatusDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -SentId "TEST_VALUE" -RemoteMtaIp "TEST_VALUE" -InboxId "TEST_VALUE" -ReportingMta "TEST_VALUE" -Recipients "TEST_VALUE" -SmtpResponse "TEST_VALUE" -SmtpStatusCode "TEST_VALUE" -ProcessingTimeMillis "TEST_VALUE" -Received "TEST_VALUE" -Subject "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType DeliveryStatusDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DescribeDomainOptions.Tests.ps1 b/tests/Model/DescribeDomainOptions.Tests.ps1 new file mode 100644 index 00000000..44d9ac0e --- /dev/null +++ b/tests/Model/DescribeDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DescribeDomainOptions' { + Context 'DescribeDomainOptions' { + It 'Initialize-DescribeDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-DescribeDomainOptions -Domain "TEST_VALUE" + #$NewObject | Should -BeOfType DescribeDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DescribeMailServerDomainResult.Tests.ps1 b/tests/Model/DescribeMailServerDomainResult.Tests.ps1 new file mode 100644 index 00000000..2e474a2b --- /dev/null +++ b/tests/Model/DescribeMailServerDomainResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DescribeMailServerDomainResult' { + Context 'DescribeMailServerDomainResult' { + It 'Initialize-DescribeMailServerDomainResult' { + # a simple test to create an object + #$NewObject = Initialize-DescribeMailServerDomainResult -MxRecords "TEST_VALUE" -Domain "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType DescribeMailServerDomainResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainDto.Tests.ps1 b/tests/Model/DomainDto.Tests.ps1 new file mode 100644 index 00000000..80666a4d --- /dev/null +++ b/tests/Model/DomainDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainDto' { + Context 'DomainDto' { + It 'Initialize-DomainDto' { + # a simple test to create an object + #$NewObject = Initialize-DomainDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -Domain "TEST_VALUE" -VerificationToken "TEST_VALUE" -DkimTokens "TEST_VALUE" -MissingRecordsMessage "TEST_VALUE" -HasMissingRecords "TEST_VALUE" -IsVerified "TEST_VALUE" -DomainNameRecords "TEST_VALUE" -CatchAllInboxId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -DomainType "TEST_VALUE" + #$NewObject | Should -BeOfType DomainDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainGroup.Tests.ps1 b/tests/Model/DomainGroup.Tests.ps1 new file mode 100644 index 00000000..19d2ccff --- /dev/null +++ b/tests/Model/DomainGroup.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainGroup' { + Context 'DomainGroup' { + It 'Initialize-DomainGroup' { + # a simple test to create an object + #$NewObject = Initialize-DomainGroup -Label "TEST_VALUE" -Domains "TEST_VALUE" + #$NewObject | Should -BeOfType DomainGroup + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainGroupsDto.Tests.ps1 b/tests/Model/DomainGroupsDto.Tests.ps1 new file mode 100644 index 00000000..be2b2625 --- /dev/null +++ b/tests/Model/DomainGroupsDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainGroupsDto' { + Context 'DomainGroupsDto' { + It 'Initialize-DomainGroupsDto' { + # a simple test to create an object + #$NewObject = Initialize-DomainGroupsDto -DomainGroups "TEST_VALUE" + #$NewObject | Should -BeOfType DomainGroupsDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainInformation.Tests.ps1 b/tests/Model/DomainInformation.Tests.ps1 new file mode 100644 index 00000000..5e96c7a2 --- /dev/null +++ b/tests/Model/DomainInformation.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainInformation' { + Context 'DomainInformation' { + It 'Initialize-DomainInformation' { + # a simple test to create an object + #$NewObject = Initialize-DomainInformation -DomainName "TEST_VALUE" -Verified "TEST_VALUE" -DomainType "TEST_VALUE" + #$NewObject | Should -BeOfType DomainInformation + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainIssuesDto.Tests.ps1 b/tests/Model/DomainIssuesDto.Tests.ps1 new file mode 100644 index 00000000..5696b681 --- /dev/null +++ b/tests/Model/DomainIssuesDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainIssuesDto' { + Context 'DomainIssuesDto' { + It 'Initialize-DomainIssuesDto' { + # a simple test to create an object + #$NewObject = Initialize-DomainIssuesDto -HasIssues "TEST_VALUE" + #$NewObject | Should -BeOfType DomainIssuesDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainNameRecord.Tests.ps1 b/tests/Model/DomainNameRecord.Tests.ps1 new file mode 100644 index 00000000..c4815033 --- /dev/null +++ b/tests/Model/DomainNameRecord.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainNameRecord' { + Context 'DomainNameRecord' { + It 'Initialize-DomainNameRecord' { + # a simple test to create an object + #$NewObject = Initialize-DomainNameRecord -Label "TEST_VALUE" -Required "TEST_VALUE" -RecordType "TEST_VALUE" -Name "TEST_VALUE" -RecordEntries "TEST_VALUE" -Ttl "TEST_VALUE" + #$NewObject | Should -BeOfType DomainNameRecord + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DomainPreview.Tests.ps1 b/tests/Model/DomainPreview.Tests.ps1 new file mode 100644 index 00000000..8053f325 --- /dev/null +++ b/tests/Model/DomainPreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DomainPreview' { + Context 'DomainPreview' { + It 'Initialize-DomainPreview' { + # a simple test to create an object + #$NewObject = Initialize-DomainPreview -Id "TEST_VALUE" -Domain "TEST_VALUE" -CatchAllInboxId "TEST_VALUE" -CreatedAt "TEST_VALUE" -DomainType "TEST_VALUE" -IsVerified "TEST_VALUE" -HasMissingRecords "TEST_VALUE" + #$NewObject | Should -BeOfType DomainPreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/DownloadAttachmentDto.Tests.ps1 b/tests/Model/DownloadAttachmentDto.Tests.ps1 new file mode 100644 index 00000000..a53fee19 --- /dev/null +++ b/tests/Model/DownloadAttachmentDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'DownloadAttachmentDto' { + Context 'DownloadAttachmentDto' { + It 'Initialize-DownloadAttachmentDto' { + # a simple test to create an object + #$NewObject = Initialize-DownloadAttachmentDto -Base64FileContents "TEST_VALUE" -ContentType "TEST_VALUE" -SizeBytes "TEST_VALUE" + #$NewObject | Should -BeOfType DownloadAttachmentDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/Email.Tests.ps1 b/tests/Model/Email.Tests.ps1 new file mode 100644 index 00000000..b707079a --- /dev/null +++ b/tests/Model/Email.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'Email' { + Context 'Email' { + It 'Initialize-Email' { + # a simple test to create an object + #$NewObject = Initialize-Email -Id "TEST_VALUE" -UserId "TEST_VALUE" -InboxId "TEST_VALUE" -DomainId "TEST_VALUE" -To "TEST_VALUE" -VarFrom "TEST_VALUE" -VarSender "TEST_VALUE" -Recipients "TEST_VALUE" -ReplyTo "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" -Headers "TEST_VALUE" -HeadersMap "TEST_VALUE" -Attachments "TEST_VALUE" -Subject "TEST_VALUE" -Body "TEST_VALUE" -BodyExcerpt "TEST_VALUE" -TextExcerpt "TEST_VALUE" -BodyMD5Hash "TEST_VALUE" -IsHTML "TEST_VALUE" -Charset "TEST_VALUE" -Analysis "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Read "TEST_VALUE" -TeamAccess "TEST_VALUE" -IsXAmpHtml "TEST_VALUE" -BodyPartContentTypes "TEST_VALUE" -Html "TEST_VALUE" -XampHtml "TEST_VALUE" + #$NewObject | Should -BeOfType Email + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailAnalysis.Tests.ps1 b/tests/Model/EmailAnalysis.Tests.ps1 new file mode 100644 index 00000000..1a1af3c7 --- /dev/null +++ b/tests/Model/EmailAnalysis.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailAnalysis' { + Context 'EmailAnalysis' { + It 'Initialize-EmailAnalysis' { + # a simple test to create an object + #$NewObject = Initialize-EmailAnalysis -SpamVerdict "TEST_VALUE" -VirusVerdict "TEST_VALUE" -SpfVerdict "TEST_VALUE" -DkimVerdict "TEST_VALUE" -DmarcVerdict "TEST_VALUE" + #$NewObject | Should -BeOfType EmailAnalysis + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailContentMatchResult.Tests.ps1 b/tests/Model/EmailContentMatchResult.Tests.ps1 new file mode 100644 index 00000000..48e772ee --- /dev/null +++ b/tests/Model/EmailContentMatchResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailContentMatchResult' { + Context 'EmailContentMatchResult' { + It 'Initialize-EmailContentMatchResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailContentMatchResult -Pattern "TEST_VALUE" -VarMatches "TEST_VALUE" + #$NewObject | Should -BeOfType EmailContentMatchResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailContentPartResult.Tests.ps1 b/tests/Model/EmailContentPartResult.Tests.ps1 new file mode 100644 index 00000000..3f440e27 --- /dev/null +++ b/tests/Model/EmailContentPartResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailContentPartResult' { + Context 'EmailContentPartResult' { + It 'Initialize-EmailContentPartResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailContentPartResult -Content "TEST_VALUE" + #$NewObject | Should -BeOfType EmailContentPartResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureCategoryName.Tests.ps1 b/tests/Model/EmailFeatureCategoryName.Tests.ps1 new file mode 100644 index 00000000..7c1c79f3 --- /dev/null +++ b/tests/Model/EmailFeatureCategoryName.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureCategoryName' { + Context 'EmailFeatureCategoryName' { + It 'Initialize-EmailFeatureCategoryName' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureCategoryName -Slug "TEST_VALUE" -Name "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureCategoryName + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureFamilyName.Tests.ps1 b/tests/Model/EmailFeatureFamilyName.Tests.ps1 new file mode 100644 index 00000000..65172c93 --- /dev/null +++ b/tests/Model/EmailFeatureFamilyName.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureFamilyName' { + Context 'EmailFeatureFamilyName' { + It 'Initialize-EmailFeatureFamilyName' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureFamilyName -Slug "TEST_VALUE" -Name "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureFamilyName + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureFamilyStatistics.Tests.ps1 b/tests/Model/EmailFeatureFamilyStatistics.Tests.ps1 new file mode 100644 index 00000000..c3f82074 --- /dev/null +++ b/tests/Model/EmailFeatureFamilyStatistics.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureFamilyStatistics' { + Context 'EmailFeatureFamilyStatistics' { + It 'Initialize-EmailFeatureFamilyStatistics' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureFamilyStatistics -Feature "TEST_VALUE" -Family "TEST_VALUE" -Platforms "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureFamilyStatistics + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureNames.Tests.ps1 b/tests/Model/EmailFeatureNames.Tests.ps1 new file mode 100644 index 00000000..0fcb6578 --- /dev/null +++ b/tests/Model/EmailFeatureNames.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureNames' { + Context 'EmailFeatureNames' { + It 'Initialize-EmailFeatureNames' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureNames -Family "TEST_VALUE" -Platform "TEST_VALUE" -Category "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureNames + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureOverview.Tests.ps1 b/tests/Model/EmailFeatureOverview.Tests.ps1 new file mode 100644 index 00000000..7de7bf58 --- /dev/null +++ b/tests/Model/EmailFeatureOverview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureOverview' { + Context 'EmailFeatureOverview' { + It 'Initialize-EmailFeatureOverview' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureOverview -Feature "TEST_VALUE" -Title "TEST_VALUE" -Description "TEST_VALUE" -Category "TEST_VALUE" -Notes "TEST_VALUE" -NotesNumbers "TEST_VALUE" -FeatureStatistics "TEST_VALUE" -Statuses "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureOverview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeaturePlatformName.Tests.ps1 b/tests/Model/EmailFeaturePlatformName.Tests.ps1 new file mode 100644 index 00000000..a891aa3e --- /dev/null +++ b/tests/Model/EmailFeaturePlatformName.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeaturePlatformName' { + Context 'EmailFeaturePlatformName' { + It 'Initialize-EmailFeaturePlatformName' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeaturePlatformName -Slug "TEST_VALUE" -Name "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeaturePlatformName + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeaturePlatformStatistics.Tests.ps1 b/tests/Model/EmailFeaturePlatformStatistics.Tests.ps1 new file mode 100644 index 00000000..47c97cee --- /dev/null +++ b/tests/Model/EmailFeaturePlatformStatistics.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeaturePlatformStatistics' { + Context 'EmailFeaturePlatformStatistics' { + It 'Initialize-EmailFeaturePlatformStatistics' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeaturePlatformStatistics -Platform "TEST_VALUE" -Versions "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeaturePlatformStatistics + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureSupportFlags.Tests.ps1 b/tests/Model/EmailFeatureSupportFlags.Tests.ps1 new file mode 100644 index 00000000..dda0eb37 --- /dev/null +++ b/tests/Model/EmailFeatureSupportFlags.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureSupportFlags' { + Context 'EmailFeatureSupportFlags' { + It 'Initialize-EmailFeatureSupportFlags' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureSupportFlags -Status "TEST_VALUE" -Notes "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureSupportFlags + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureSupportResult.Tests.ps1 b/tests/Model/EmailFeatureSupportResult.Tests.ps1 new file mode 100644 index 00000000..1a71429f --- /dev/null +++ b/tests/Model/EmailFeatureSupportResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureSupportResult' { + Context 'EmailFeatureSupportResult' { + It 'Initialize-EmailFeatureSupportResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureSupportResult -Names "TEST_VALUE" -DetectedFeatures "TEST_VALUE" -FeatureOverviews "TEST_VALUE" -FeaturePercentages "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureSupportResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureSupportStatusPercentage.Tests.ps1 b/tests/Model/EmailFeatureSupportStatusPercentage.Tests.ps1 new file mode 100644 index 00000000..726edc08 --- /dev/null +++ b/tests/Model/EmailFeatureSupportStatusPercentage.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureSupportStatusPercentage' { + Context 'EmailFeatureSupportStatusPercentage' { + It 'Initialize-EmailFeatureSupportStatusPercentage' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureSupportStatusPercentage -Status "TEST_VALUE" -Percentage "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureSupportStatusPercentage + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailFeatureVersionStatistics.Tests.ps1 b/tests/Model/EmailFeatureVersionStatistics.Tests.ps1 new file mode 100644 index 00000000..729fdf98 --- /dev/null +++ b/tests/Model/EmailFeatureVersionStatistics.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailFeatureVersionStatistics' { + Context 'EmailFeatureVersionStatistics' { + It 'Initialize-EmailFeatureVersionStatistics' { + # a simple test to create an object + #$NewObject = Initialize-EmailFeatureVersionStatistics -Version "TEST_VALUE" -SupportFlags "TEST_VALUE" + #$NewObject | Should -BeOfType EmailFeatureVersionStatistics + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailHtmlDto.Tests.ps1 b/tests/Model/EmailHtmlDto.Tests.ps1 new file mode 100644 index 00000000..04fa4d8e --- /dev/null +++ b/tests/Model/EmailHtmlDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailHtmlDto' { + Context 'EmailHtmlDto' { + It 'Initialize-EmailHtmlDto' { + # a simple test to create an object + #$NewObject = Initialize-EmailHtmlDto -Subject "TEST_VALUE" -Body "TEST_VALUE" + #$NewObject | Should -BeOfType EmailHtmlDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailLinksResult.Tests.ps1 b/tests/Model/EmailLinksResult.Tests.ps1 new file mode 100644 index 00000000..1e0d283d --- /dev/null +++ b/tests/Model/EmailLinksResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailLinksResult' { + Context 'EmailLinksResult' { + It 'Initialize-EmailLinksResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailLinksResult -Links "TEST_VALUE" -Body "TEST_VALUE" + #$NewObject | Should -BeOfType EmailLinksResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailPreview.Tests.ps1 b/tests/Model/EmailPreview.Tests.ps1 new file mode 100644 index 00000000..694e0b13 --- /dev/null +++ b/tests/Model/EmailPreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailPreview' { + Context 'EmailPreview' { + It 'Initialize-EmailPreview' { + # a simple test to create an object + #$NewObject = Initialize-EmailPreview -Id "TEST_VALUE" -DomainId "TEST_VALUE" -Subject "TEST_VALUE" -To "TEST_VALUE" -VarFrom "TEST_VALUE" -Bcc "TEST_VALUE" -Cc "TEST_VALUE" -CreatedAt "TEST_VALUE" -Read "TEST_VALUE" -Attachments "TEST_VALUE" + #$NewObject | Should -BeOfType EmailPreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailPreviewUrls.Tests.ps1 b/tests/Model/EmailPreviewUrls.Tests.ps1 new file mode 100644 index 00000000..bd31ed15 --- /dev/null +++ b/tests/Model/EmailPreviewUrls.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailPreviewUrls' { + Context 'EmailPreviewUrls' { + It 'Initialize-EmailPreviewUrls' { + # a simple test to create an object + #$NewObject = Initialize-EmailPreviewUrls -RawSmtpMessageUrl "TEST_VALUE" -PlainHtmlBodyUrl "TEST_VALUE" -Origin "TEST_VALUE" + #$NewObject | Should -BeOfType EmailPreviewUrls + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailProjection.Tests.ps1 b/tests/Model/EmailProjection.Tests.ps1 new file mode 100644 index 00000000..7841ecad --- /dev/null +++ b/tests/Model/EmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailProjection' { + Context 'EmailProjection' { + It 'Initialize-EmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-EmailProjection -Attachments "TEST_VALUE" -InboxId "TEST_VALUE" -To "TEST_VALUE" -DomainId "TEST_VALUE" -Bcc "TEST_VALUE" -Cc "TEST_VALUE" -Read "TEST_VALUE" -BodyExcerpt "TEST_VALUE" -TeamAccess "TEST_VALUE" -BodyMD5Hash "TEST_VALUE" -TextExcerpt "TEST_VALUE" -CreatedAt "TEST_VALUE" -Subject "TEST_VALUE" -Id "TEST_VALUE" -VarFrom "TEST_VALUE" + #$NewObject | Should -BeOfType EmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailRecipients.Tests.ps1 b/tests/Model/EmailRecipients.Tests.ps1 new file mode 100644 index 00000000..1efceab5 --- /dev/null +++ b/tests/Model/EmailRecipients.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailRecipients' { + Context 'EmailRecipients' { + It 'Initialize-EmailRecipients' { + # a simple test to create an object + #$NewObject = Initialize-EmailRecipients -To "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" + #$NewObject | Should -BeOfType EmailRecipients + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailScreenshotResult.Tests.ps1 b/tests/Model/EmailScreenshotResult.Tests.ps1 new file mode 100644 index 00000000..3671187b --- /dev/null +++ b/tests/Model/EmailScreenshotResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailScreenshotResult' { + Context 'EmailScreenshotResult' { + It 'Initialize-EmailScreenshotResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailScreenshotResult -Base64EncodedImage "TEST_VALUE" + #$NewObject | Should -BeOfType EmailScreenshotResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailTextLinesResult.Tests.ps1 b/tests/Model/EmailTextLinesResult.Tests.ps1 new file mode 100644 index 00000000..2a3dc0e0 --- /dev/null +++ b/tests/Model/EmailTextLinesResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailTextLinesResult' { + Context 'EmailTextLinesResult' { + It 'Initialize-EmailTextLinesResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailTextLinesResult -Lines "TEST_VALUE" -Body "TEST_VALUE" + #$NewObject | Should -BeOfType EmailTextLinesResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailValidationRequestDto.Tests.ps1 b/tests/Model/EmailValidationRequestDto.Tests.ps1 new file mode 100644 index 00000000..9483f080 --- /dev/null +++ b/tests/Model/EmailValidationRequestDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailValidationRequestDto' { + Context 'EmailValidationRequestDto' { + It 'Initialize-EmailValidationRequestDto' { + # a simple test to create an object + #$NewObject = Initialize-EmailValidationRequestDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -EmailAddress "TEST_VALUE" -IsValid "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType EmailValidationRequestDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmailVerificationResult.Tests.ps1 b/tests/Model/EmailVerificationResult.Tests.ps1 new file mode 100644 index 00000000..3dc02ca7 --- /dev/null +++ b/tests/Model/EmailVerificationResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmailVerificationResult' { + Context 'EmailVerificationResult' { + It 'Initialize-EmailVerificationResult' { + # a simple test to create an object + #$NewObject = Initialize-EmailVerificationResult -DomainName "TEST_VALUE" -Port "TEST_VALUE" -EmailAddress "TEST_VALUE" -IsValid "TEST_VALUE" -VarError "TEST_VALUE" + #$NewObject | Should -BeOfType EmailVerificationResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmergencyAddress.Tests.ps1 b/tests/Model/EmergencyAddress.Tests.ps1 new file mode 100644 index 00000000..6c68376c --- /dev/null +++ b/tests/Model/EmergencyAddress.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmergencyAddress' { + Context 'EmergencyAddress' { + It 'Initialize-EmergencyAddress' { + # a simple test to create an object + #$NewObject = Initialize-EmergencyAddress -Id "TEST_VALUE" -Sid "TEST_VALUE" -UserId "TEST_VALUE" -DisplayName "TEST_VALUE" -CustomerName "TEST_VALUE" -Address1 "TEST_VALUE" -City "TEST_VALUE" -Region "TEST_VALUE" -PostalCode "TEST_VALUE" -PhoneCountry "TEST_VALUE" -AccountSid "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType EmergencyAddress + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmergencyAddressDto.Tests.ps1 b/tests/Model/EmergencyAddressDto.Tests.ps1 new file mode 100644 index 00000000..afc62f29 --- /dev/null +++ b/tests/Model/EmergencyAddressDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmergencyAddressDto' { + Context 'EmergencyAddressDto' { + It 'Initialize-EmergencyAddressDto' { + # a simple test to create an object + #$NewObject = Initialize-EmergencyAddressDto -Id "TEST_VALUE" -Address1 "TEST_VALUE" -PhoneCountry "TEST_VALUE" + #$NewObject | Should -BeOfType EmergencyAddressDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/EmptyResponseDto.Tests.ps1 b/tests/Model/EmptyResponseDto.Tests.ps1 new file mode 100644 index 00000000..69c15f26 --- /dev/null +++ b/tests/Model/EmptyResponseDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'EmptyResponseDto' { + Context 'EmptyResponseDto' { + It 'Initialize-EmptyResponseDto' { + # a simple test to create an object + #$NewObject = Initialize-EmptyResponseDto -Message "TEST_VALUE" + #$NewObject | Should -BeOfType EmptyResponseDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ExpirationDefaults.Tests.ps1 b/tests/Model/ExpirationDefaults.Tests.ps1 new file mode 100644 index 00000000..9a8da067 --- /dev/null +++ b/tests/Model/ExpirationDefaults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExpirationDefaults' { + Context 'ExpirationDefaults' { + It 'Initialize-ExpirationDefaults' { + # a simple test to create an object + #$NewObject = Initialize-ExpirationDefaults -DefaultExpirationMillis "TEST_VALUE" -MaxExpirationMillis "TEST_VALUE" -DefaultExpiresAt "TEST_VALUE" -CanPermanentInbox "TEST_VALUE" -NextInboxAllowsPermanent "TEST_VALUE" + #$NewObject | Should -BeOfType ExpirationDefaults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ExpiredInboxDto.Tests.ps1 b/tests/Model/ExpiredInboxDto.Tests.ps1 new file mode 100644 index 00000000..0860d749 --- /dev/null +++ b/tests/Model/ExpiredInboxDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExpiredInboxDto' { + Context 'ExpiredInboxDto' { + It 'Initialize-ExpiredInboxDto' { + # a simple test to create an object + #$NewObject = Initialize-ExpiredInboxDto -Id "TEST_VALUE" -InboxId "TEST_VALUE" -EmailAddress "TEST_VALUE" + #$NewObject | Should -BeOfType ExpiredInboxDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ExpiredInboxRecordProjection.Tests.ps1 b/tests/Model/ExpiredInboxRecordProjection.Tests.ps1 new file mode 100644 index 00000000..84a12bc2 --- /dev/null +++ b/tests/Model/ExpiredInboxRecordProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExpiredInboxRecordProjection' { + Context 'ExpiredInboxRecordProjection' { + It 'Initialize-ExpiredInboxRecordProjection' { + # a simple test to create an object + #$NewObject = Initialize-ExpiredInboxRecordProjection -EmailAddress "TEST_VALUE" -UserId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ExpiredInboxRecordProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ExportLink.Tests.ps1 b/tests/Model/ExportLink.Tests.ps1 new file mode 100644 index 00000000..fa7d9110 --- /dev/null +++ b/tests/Model/ExportLink.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExportLink' { + Context 'ExportLink' { + It 'Initialize-ExportLink' { + # a simple test to create an object + #$NewObject = Initialize-ExportLink -DownloadLink "TEST_VALUE" + #$NewObject | Should -BeOfType ExportLink + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ExportOptions.Tests.ps1 b/tests/Model/ExportOptions.Tests.ps1 new file mode 100644 index 00000000..7d67614a --- /dev/null +++ b/tests/Model/ExportOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ExportOptions' { + Context 'ExportOptions' { + It 'Initialize-ExportOptions' { + # a simple test to create an object + #$NewObject = Initialize-ExportOptions -OutputFormat "TEST_VALUE" -ExcludePreviouslyExported "TEST_VALUE" -CreatedEarliestTime "TEST_VALUE" -CreatedOldestTime "TEST_VALUE" -VarFilter "TEST_VALUE" -ListSeparatorToken "TEST_VALUE" + #$NewObject | Should -BeOfType ExportOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/FakeEmailDto.Tests.ps1 b/tests/Model/FakeEmailDto.Tests.ps1 new file mode 100644 index 00000000..4c03c7d6 --- /dev/null +++ b/tests/Model/FakeEmailDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FakeEmailDto' { + Context 'FakeEmailDto' { + It 'Initialize-FakeEmailDto' { + # a simple test to create an object + #$NewObject = Initialize-FakeEmailDto -Id "TEST_VALUE" -EmailAddress "TEST_VALUE" -VarSender "TEST_VALUE" -Recipients "TEST_VALUE" -Subject "TEST_VALUE" -Preview "TEST_VALUE" -Body "TEST_VALUE" -Seen "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType FakeEmailDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/FakeEmailPreview.Tests.ps1 b/tests/Model/FakeEmailPreview.Tests.ps1 new file mode 100644 index 00000000..d63594c1 --- /dev/null +++ b/tests/Model/FakeEmailPreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FakeEmailPreview' { + Context 'FakeEmailPreview' { + It 'Initialize-FakeEmailPreview' { + # a simple test to create an object + #$NewObject = Initialize-FakeEmailPreview -Id "TEST_VALUE" -EmailAddress "TEST_VALUE" -VarSender "TEST_VALUE" -Recipients "TEST_VALUE" -Subject "TEST_VALUE" -Preview "TEST_VALUE" -CreatedAt "TEST_VALUE" -Seen "TEST_VALUE" + #$NewObject | Should -BeOfType FakeEmailPreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/FakeEmailResult.Tests.ps1 b/tests/Model/FakeEmailResult.Tests.ps1 new file mode 100644 index 00000000..2cdfaf16 --- /dev/null +++ b/tests/Model/FakeEmailResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FakeEmailResult' { + Context 'FakeEmailResult' { + It 'Initialize-FakeEmailResult' { + # a simple test to create an object + #$NewObject = Initialize-FakeEmailResult -Email "TEST_VALUE" + #$NewObject | Should -BeOfType FakeEmailResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/FilterBouncedRecipientsOptions.Tests.ps1 b/tests/Model/FilterBouncedRecipientsOptions.Tests.ps1 new file mode 100644 index 00000000..8279a22d --- /dev/null +++ b/tests/Model/FilterBouncedRecipientsOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FilterBouncedRecipientsOptions' { + Context 'FilterBouncedRecipientsOptions' { + It 'Initialize-FilterBouncedRecipientsOptions' { + # a simple test to create an object + #$NewObject = Initialize-FilterBouncedRecipientsOptions -EmailRecipients "TEST_VALUE" + #$NewObject | Should -BeOfType FilterBouncedRecipientsOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/FilterBouncedRecipientsResult.Tests.ps1 b/tests/Model/FilterBouncedRecipientsResult.Tests.ps1 new file mode 100644 index 00000000..cf941be6 --- /dev/null +++ b/tests/Model/FilterBouncedRecipientsResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FilterBouncedRecipientsResult' { + Context 'FilterBouncedRecipientsResult' { + It 'Initialize-FilterBouncedRecipientsResult' { + # a simple test to create an object + #$NewObject = Initialize-FilterBouncedRecipientsResult -FilteredRecipients "TEST_VALUE" + #$NewObject | Should -BeOfType FilterBouncedRecipientsResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/FlushExpiredInboxesResult.Tests.ps1 b/tests/Model/FlushExpiredInboxesResult.Tests.ps1 new file mode 100644 index 00000000..6446886b --- /dev/null +++ b/tests/Model/FlushExpiredInboxesResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'FlushExpiredInboxesResult' { + Context 'FlushExpiredInboxesResult' { + It 'Initialize-FlushExpiredInboxesResult' { + # a simple test to create an object + #$NewObject = Initialize-FlushExpiredInboxesResult -InboxIds "TEST_VALUE" -ExpireBefore "TEST_VALUE" + #$NewObject | Should -BeOfType FlushExpiredInboxesResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ForwardEmailOptions.Tests.ps1 b/tests/Model/ForwardEmailOptions.Tests.ps1 new file mode 100644 index 00000000..014bcde1 --- /dev/null +++ b/tests/Model/ForwardEmailOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ForwardEmailOptions' { + Context 'ForwardEmailOptions' { + It 'Initialize-ForwardEmailOptions' { + # a simple test to create an object + #$NewObject = Initialize-ForwardEmailOptions -To "TEST_VALUE" -Subject "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" -VarFrom "TEST_VALUE" -UseInboxName "TEST_VALUE" -FilterBouncedRecipients "TEST_VALUE" + #$NewObject | Should -BeOfType ForwardEmailOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateBimiRecordOptions.Tests.ps1 b/tests/Model/GenerateBimiRecordOptions.Tests.ps1 new file mode 100644 index 00000000..8d5af669 --- /dev/null +++ b/tests/Model/GenerateBimiRecordOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateBimiRecordOptions' { + Context 'GenerateBimiRecordOptions' { + It 'Initialize-GenerateBimiRecordOptions' { + # a simple test to create an object + #$NewObject = Initialize-GenerateBimiRecordOptions -Domain "TEST_VALUE" -Version "TEST_VALUE" -LogoUrl "TEST_VALUE" -VmcUrl "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateBimiRecordOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateBimiRecordResults.Tests.ps1 b/tests/Model/GenerateBimiRecordResults.Tests.ps1 new file mode 100644 index 00000000..f42a6b6a --- /dev/null +++ b/tests/Model/GenerateBimiRecordResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateBimiRecordResults' { + Context 'GenerateBimiRecordResults' { + It 'Initialize-GenerateBimiRecordResults' { + # a simple test to create an object + #$NewObject = Initialize-GenerateBimiRecordResults -Name "TEST_VALUE" -Type "TEST_VALUE" -Ttl "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateBimiRecordResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateDmarcRecordOptions.Tests.ps1 b/tests/Model/GenerateDmarcRecordOptions.Tests.ps1 new file mode 100644 index 00000000..3ef6696b --- /dev/null +++ b/tests/Model/GenerateDmarcRecordOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateDmarcRecordOptions' { + Context 'GenerateDmarcRecordOptions' { + It 'Initialize-GenerateDmarcRecordOptions' { + # a simple test to create an object + #$NewObject = Initialize-GenerateDmarcRecordOptions -Domain "TEST_VALUE" -Version "TEST_VALUE" -Policy "TEST_VALUE" -SubdomainPolicy "TEST_VALUE" -ReportEmailAddress "TEST_VALUE" -ForensicEmailAddress "TEST_VALUE" -Percentage "TEST_VALUE" -ReportFormat "TEST_VALUE" -SecondsBetweenReports "TEST_VALUE" -Adkim "TEST_VALUE" -Aspf "TEST_VALUE" -Fo "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateDmarcRecordOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateDmarcRecordResults.Tests.ps1 b/tests/Model/GenerateDmarcRecordResults.Tests.ps1 new file mode 100644 index 00000000..bb439dda --- /dev/null +++ b/tests/Model/GenerateDmarcRecordResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateDmarcRecordResults' { + Context 'GenerateDmarcRecordResults' { + It 'Initialize-GenerateDmarcRecordResults' { + # a simple test to create an object + #$NewObject = Initialize-GenerateDmarcRecordResults -Name "TEST_VALUE" -Type "TEST_VALUE" -Ttl "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateDmarcRecordResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateMtaStsRecordOptions.Tests.ps1 b/tests/Model/GenerateMtaStsRecordOptions.Tests.ps1 new file mode 100644 index 00000000..95ad0f47 --- /dev/null +++ b/tests/Model/GenerateMtaStsRecordOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateMtaStsRecordOptions' { + Context 'GenerateMtaStsRecordOptions' { + It 'Initialize-GenerateMtaStsRecordOptions' { + # a simple test to create an object + #$NewObject = Initialize-GenerateMtaStsRecordOptions -VarHost "TEST_VALUE" -Version "TEST_VALUE" -Mode "TEST_VALUE" -Ttl "TEST_VALUE" -MaxAgeSeconds "TEST_VALUE" -MxRecords "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateMtaStsRecordOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateMtaStsRecordResults.Tests.ps1 b/tests/Model/GenerateMtaStsRecordResults.Tests.ps1 new file mode 100644 index 00000000..6f9e5986 --- /dev/null +++ b/tests/Model/GenerateMtaStsRecordResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateMtaStsRecordResults' { + Context 'GenerateMtaStsRecordResults' { + It 'Initialize-GenerateMtaStsRecordResults' { + # a simple test to create an object + #$NewObject = Initialize-GenerateMtaStsRecordResults -Name "TEST_VALUE" -Type "TEST_VALUE" -Ttl "TEST_VALUE" -Value "TEST_VALUE" -WellKnownValue "TEST_VALUE" -WellKnownUrl "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateMtaStsRecordResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateTlsReportingRecordOptions.Tests.ps1 b/tests/Model/GenerateTlsReportingRecordOptions.Tests.ps1 new file mode 100644 index 00000000..8df239da --- /dev/null +++ b/tests/Model/GenerateTlsReportingRecordOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateTlsReportingRecordOptions' { + Context 'GenerateTlsReportingRecordOptions' { + It 'Initialize-GenerateTlsReportingRecordOptions' { + # a simple test to create an object + #$NewObject = Initialize-GenerateTlsReportingRecordOptions -ReportingAddresses "TEST_VALUE" -ReportingUrl "TEST_VALUE" -VarHost "TEST_VALUE" -Version "TEST_VALUE" -Ttl "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateTlsReportingRecordOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GenerateTlsReportingRecordResults.Tests.ps1 b/tests/Model/GenerateTlsReportingRecordResults.Tests.ps1 new file mode 100644 index 00000000..c4e039e0 --- /dev/null +++ b/tests/Model/GenerateTlsReportingRecordResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GenerateTlsReportingRecordResults' { + Context 'GenerateTlsReportingRecordResults' { + It 'Initialize-GenerateTlsReportingRecordResults' { + # a simple test to create an object + #$NewObject = Initialize-GenerateTlsReportingRecordResults -Name "TEST_VALUE" -Type "TEST_VALUE" -Ttl "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType GenerateTlsReportingRecordResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GetEmailScreenshotOptions.Tests.ps1 b/tests/Model/GetEmailScreenshotOptions.Tests.ps1 new file mode 100644 index 00000000..e30c92d6 --- /dev/null +++ b/tests/Model/GetEmailScreenshotOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GetEmailScreenshotOptions' { + Context 'GetEmailScreenshotOptions' { + It 'Initialize-GetEmailScreenshotOptions' { + # a simple test to create an object + #$NewObject = Initialize-GetEmailScreenshotOptions -Height "TEST_VALUE" -Width "TEST_VALUE" + #$NewObject | Should -BeOfType GetEmailScreenshotOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GravatarUrl.Tests.ps1 b/tests/Model/GravatarUrl.Tests.ps1 new file mode 100644 index 00000000..d02dd0cd --- /dev/null +++ b/tests/Model/GravatarUrl.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GravatarUrl' { + Context 'GravatarUrl' { + It 'Initialize-GravatarUrl' { + # a simple test to create an object + #$NewObject = Initialize-GravatarUrl -Url "TEST_VALUE" -Hash "TEST_VALUE" + #$NewObject | Should -BeOfType GravatarUrl + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GroupContactsDto.Tests.ps1 b/tests/Model/GroupContactsDto.Tests.ps1 new file mode 100644 index 00000000..0c30d325 --- /dev/null +++ b/tests/Model/GroupContactsDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GroupContactsDto' { + Context 'GroupContactsDto' { + It 'Initialize-GroupContactsDto' { + # a simple test to create an object + #$NewObject = Initialize-GroupContactsDto -Group "TEST_VALUE" -Contacts "TEST_VALUE" + #$NewObject | Should -BeOfType GroupContactsDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GroupDto.Tests.ps1 b/tests/Model/GroupDto.Tests.ps1 new file mode 100644 index 00000000..5a474274 --- /dev/null +++ b/tests/Model/GroupDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GroupDto' { + Context 'GroupDto' { + It 'Initialize-GroupDto' { + # a simple test to create an object + #$NewObject = Initialize-GroupDto -Id "TEST_VALUE" -Name "TEST_VALUE" -Description "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType GroupDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/GroupProjection.Tests.ps1 b/tests/Model/GroupProjection.Tests.ps1 new file mode 100644 index 00000000..823a3eb1 --- /dev/null +++ b/tests/Model/GroupProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'GroupProjection' { + Context 'GroupProjection' { + It 'Initialize-GroupProjection' { + # a simple test to create an object + #$NewObject = Initialize-GroupProjection -CreatedAt "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" -Description "TEST_VALUE" + #$NewObject | Should -BeOfType GroupProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/HTMLValidationResult.Tests.ps1 b/tests/Model/HTMLValidationResult.Tests.ps1 new file mode 100644 index 00000000..61c7bc06 --- /dev/null +++ b/tests/Model/HTMLValidationResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'HTMLValidationResult' { + Context 'HTMLValidationResult' { + It 'Initialize-HTMLValidationResult' { + # a simple test to create an object + #$NewObject = Initialize-HTMLValidationResult -IsValid "TEST_VALUE" -Infos "TEST_VALUE" -Errors "TEST_VALUE" -Warnings "TEST_VALUE" + #$NewObject | Should -BeOfType HTMLValidationResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/IPAddressResult.Tests.ps1 b/tests/Model/IPAddressResult.Tests.ps1 new file mode 100644 index 00000000..001a7dc6 --- /dev/null +++ b/tests/Model/IPAddressResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'IPAddressResult' { + Context 'IPAddressResult' { + It 'Initialize-IPAddressResult' { + # a simple test to create an object + #$NewObject = Initialize-IPAddressResult -Address "TEST_VALUE" -Hostname "TEST_VALUE" + #$NewObject | Should -BeOfType IPAddressResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImageIssue.Tests.ps1 b/tests/Model/ImageIssue.Tests.ps1 new file mode 100644 index 00000000..23464f1d --- /dev/null +++ b/tests/Model/ImageIssue.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImageIssue' { + Context 'ImageIssue' { + It 'Initialize-ImageIssue' { + # a simple test to create an object + #$NewObject = Initialize-ImageIssue -Url "TEST_VALUE" -ResponseStatus "TEST_VALUE" -Severity "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType ImageIssue + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapAccessDetails.Tests.ps1 b/tests/Model/ImapAccessDetails.Tests.ps1 new file mode 100644 index 00000000..7c7e6001 --- /dev/null +++ b/tests/Model/ImapAccessDetails.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapAccessDetails' { + Context 'ImapAccessDetails' { + It 'Initialize-ImapAccessDetails' { + # a simple test to create an object + #$NewObject = Initialize-ImapAccessDetails -SecureImapServerHost "TEST_VALUE" -SecureImapServerPort "TEST_VALUE" -SecureImapUsername "TEST_VALUE" -SecureImapPassword "TEST_VALUE" -ImapServerHost "TEST_VALUE" -ImapServerPort "TEST_VALUE" -ImapUsername "TEST_VALUE" -ImapPassword "TEST_VALUE" -ImapMailbox "TEST_VALUE" + #$NewObject | Should -BeOfType ImapAccessDetails + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapEmailProjection.Tests.ps1 b/tests/Model/ImapEmailProjection.Tests.ps1 new file mode 100644 index 00000000..1c4e5daa --- /dev/null +++ b/tests/Model/ImapEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapEmailProjection' { + Context 'ImapEmailProjection' { + It 'Initialize-ImapEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-ImapEmailProjection -Read "TEST_VALUE" -Uid "TEST_VALUE" -SeqNum "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ImapEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapFlagOperationOptions.Tests.ps1 b/tests/Model/ImapFlagOperationOptions.Tests.ps1 new file mode 100644 index 00000000..5a99e28f --- /dev/null +++ b/tests/Model/ImapFlagOperationOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapFlagOperationOptions' { + Context 'ImapFlagOperationOptions' { + It 'Initialize-ImapFlagOperationOptions' { + # a simple test to create an object + #$NewObject = Initialize-ImapFlagOperationOptions -FlagOperation "TEST_VALUE" -Flags "TEST_VALUE" + #$NewObject | Should -BeOfType ImapFlagOperationOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapMailboxStatus.Tests.ps1 b/tests/Model/ImapMailboxStatus.Tests.ps1 new file mode 100644 index 00000000..fda048df --- /dev/null +++ b/tests/Model/ImapMailboxStatus.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapMailboxStatus' { + Context 'ImapMailboxStatus' { + It 'Initialize-ImapMailboxStatus' { + # a simple test to create an object + #$NewObject = Initialize-ImapMailboxStatus -Name "TEST_VALUE" -ReadOnly "TEST_VALUE" -Items "TEST_VALUE" -Flags "TEST_VALUE" -PermanentFlags "TEST_VALUE" -UnseenSeqNum "TEST_VALUE" -Messages "TEST_VALUE" -Recent "TEST_VALUE" -Unseen "TEST_VALUE" -UidNext "TEST_VALUE" -UidValidity "TEST_VALUE" -AppendLimit "TEST_VALUE" + #$NewObject | Should -BeOfType ImapMailboxStatus + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerFetchItem.Tests.ps1 b/tests/Model/ImapServerFetchItem.Tests.ps1 new file mode 100644 index 00000000..06818202 --- /dev/null +++ b/tests/Model/ImapServerFetchItem.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerFetchItem' { + Context 'ImapServerFetchItem' { + It 'Initialize-ImapServerFetchItem' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerFetchItem -Content "TEST_VALUE" -Id "TEST_VALUE" -Uid "TEST_VALUE" -SeqNum "TEST_VALUE" -Read "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerFetchItem + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerFetchResult.Tests.ps1 b/tests/Model/ImapServerFetchResult.Tests.ps1 new file mode 100644 index 00000000..d01e4b53 --- /dev/null +++ b/tests/Model/ImapServerFetchResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerFetchResult' { + Context 'ImapServerFetchResult' { + It 'Initialize-ImapServerFetchResult' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerFetchResult -Result "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerFetchResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerGetResult.Tests.ps1 b/tests/Model/ImapServerGetResult.Tests.ps1 new file mode 100644 index 00000000..77eebfc7 --- /dev/null +++ b/tests/Model/ImapServerGetResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerGetResult' { + Context 'ImapServerGetResult' { + It 'Initialize-ImapServerGetResult' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerGetResult -Result "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerGetResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerListOptions.Tests.ps1 b/tests/Model/ImapServerListOptions.Tests.ps1 new file mode 100644 index 00000000..26bc7559 --- /dev/null +++ b/tests/Model/ImapServerListOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerListOptions' { + Context 'ImapServerListOptions' { + It 'Initialize-ImapServerListOptions' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerListOptions -UidSet "TEST_VALUE" -SeqSet "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerListOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerListResult.Tests.ps1 b/tests/Model/ImapServerListResult.Tests.ps1 new file mode 100644 index 00000000..91f1ea76 --- /dev/null +++ b/tests/Model/ImapServerListResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerListResult' { + Context 'ImapServerListResult' { + It 'Initialize-ImapServerListResult' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerListResult -Results "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerListResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerSearchOptions.Tests.ps1 b/tests/Model/ImapServerSearchOptions.Tests.ps1 new file mode 100644 index 00000000..8d86d4b5 --- /dev/null +++ b/tests/Model/ImapServerSearchOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerSearchOptions' { + Context 'ImapServerSearchOptions' { + It 'Initialize-ImapServerSearchOptions' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerSearchOptions -SeqNum "TEST_VALUE" -Uid "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -SentSince "TEST_VALUE" -SentBefore "TEST_VALUE" -Header "TEST_VALUE" -Body "TEST_VALUE" -Text "TEST_VALUE" -WithFlags "TEST_VALUE" -WithoutFlags "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerSearchOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerSearchResult.Tests.ps1 b/tests/Model/ImapServerSearchResult.Tests.ps1 new file mode 100644 index 00000000..db4ca37e --- /dev/null +++ b/tests/Model/ImapServerSearchResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerSearchResult' { + Context 'ImapServerSearchResult' { + It 'Initialize-ImapServerSearchResult' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerSearchResult -Results "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerSearchResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerStatusOptions.Tests.ps1 b/tests/Model/ImapServerStatusOptions.Tests.ps1 new file mode 100644 index 00000000..b121c8b1 --- /dev/null +++ b/tests/Model/ImapServerStatusOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerStatusOptions' { + Context 'ImapServerStatusOptions' { + It 'Initialize-ImapServerStatusOptions' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerStatusOptions -Name "TEST_VALUE" -StatusItems "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerStatusOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapServerStatusResult.Tests.ps1 b/tests/Model/ImapServerStatusResult.Tests.ps1 new file mode 100644 index 00000000..6b4bb837 --- /dev/null +++ b/tests/Model/ImapServerStatusResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapServerStatusResult' { + Context 'ImapServerStatusResult' { + It 'Initialize-ImapServerStatusResult' { + # a simple test to create an object + #$NewObject = Initialize-ImapServerStatusResult -Result "TEST_VALUE" + #$NewObject | Should -BeOfType ImapServerStatusResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapSmtpAccessDetails.Tests.ps1 b/tests/Model/ImapSmtpAccessDetails.Tests.ps1 new file mode 100644 index 00000000..475ca0f9 --- /dev/null +++ b/tests/Model/ImapSmtpAccessDetails.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapSmtpAccessDetails' { + Context 'ImapSmtpAccessDetails' { + It 'Initialize-ImapSmtpAccessDetails' { + # a simple test to create an object + #$NewObject = Initialize-ImapSmtpAccessDetails -SecureSmtpServerHost "TEST_VALUE" -SecureSmtpServerPort "TEST_VALUE" -SecureSmtpUsername "TEST_VALUE" -SecureSmtpPassword "TEST_VALUE" -SmtpServerHost "TEST_VALUE" -SmtpServerPort "TEST_VALUE" -SmtpUsername "TEST_VALUE" -SmtpPassword "TEST_VALUE" -SecureImapServerHost "TEST_VALUE" -SecureImapServerPort "TEST_VALUE" -SecureImapUsername "TEST_VALUE" -SecureImapPassword "TEST_VALUE" -ImapServerHost "TEST_VALUE" -ImapServerPort "TEST_VALUE" -ImapUsername "TEST_VALUE" -ImapPassword "TEST_VALUE" -ImapMailbox "TEST_VALUE" -MailFromDomain "TEST_VALUE" + #$NewObject | Should -BeOfType ImapSmtpAccessDetails + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapSmtpAccessServers.Tests.ps1 b/tests/Model/ImapSmtpAccessServers.Tests.ps1 new file mode 100644 index 00000000..fae22ad0 --- /dev/null +++ b/tests/Model/ImapSmtpAccessServers.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapSmtpAccessServers' { + Context 'ImapSmtpAccessServers' { + It 'Initialize-ImapSmtpAccessServers' { + # a simple test to create an object + #$NewObject = Initialize-ImapSmtpAccessServers -ImapServer "TEST_VALUE" -SecureImapServer "TEST_VALUE" -SmtpServer "TEST_VALUE" -SecureSmtpServer "TEST_VALUE" + #$NewObject | Should -BeOfType ImapSmtpAccessServers + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ImapUpdateFlagsOptions.Tests.ps1 b/tests/Model/ImapUpdateFlagsOptions.Tests.ps1 new file mode 100644 index 00000000..cbc48421 --- /dev/null +++ b/tests/Model/ImapUpdateFlagsOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ImapUpdateFlagsOptions' { + Context 'ImapUpdateFlagsOptions' { + It 'Initialize-ImapUpdateFlagsOptions' { + # a simple test to create an object + #$NewObject = Initialize-ImapUpdateFlagsOptions -Operation "TEST_VALUE" -Flags "TEST_VALUE" -UidSet "TEST_VALUE" -SeqSet "TEST_VALUE" + #$NewObject | Should -BeOfType ImapUpdateFlagsOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxByEmailAddressResult.Tests.ps1 b/tests/Model/InboxByEmailAddressResult.Tests.ps1 new file mode 100644 index 00000000..5e0c0a2f --- /dev/null +++ b/tests/Model/InboxByEmailAddressResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxByEmailAddressResult' { + Context 'InboxByEmailAddressResult' { + It 'Initialize-InboxByEmailAddressResult' { + # a simple test to create an object + #$NewObject = Initialize-InboxByEmailAddressResult -InboxId "TEST_VALUE" -Exists "TEST_VALUE" + #$NewObject | Should -BeOfType InboxByEmailAddressResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxByNameResult.Tests.ps1 b/tests/Model/InboxByNameResult.Tests.ps1 new file mode 100644 index 00000000..c453af80 --- /dev/null +++ b/tests/Model/InboxByNameResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxByNameResult' { + Context 'InboxByNameResult' { + It 'Initialize-InboxByNameResult' { + # a simple test to create an object + #$NewObject = Initialize-InboxByNameResult -InboxId "TEST_VALUE" -Exists "TEST_VALUE" + #$NewObject | Should -BeOfType InboxByNameResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxDto.Tests.ps1 b/tests/Model/InboxDto.Tests.ps1 new file mode 100644 index 00000000..11b4d37e --- /dev/null +++ b/tests/Model/InboxDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxDto' { + Context 'InboxDto' { + It 'Initialize-InboxDto' { + # a simple test to create an object + #$NewObject = Initialize-InboxDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Name "TEST_VALUE" -DomainId "TEST_VALUE" -Description "TEST_VALUE" -EmailAddress "TEST_VALUE" -ExpiresAt "TEST_VALUE" -Favourite "TEST_VALUE" -Tags "TEST_VALUE" -InboxType "TEST_VALUE" -ReadOnly "TEST_VALUE" -VirtualInbox "TEST_VALUE" -FunctionsAs "TEST_VALUE" + #$NewObject | Should -BeOfType InboxDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxExistsDto.Tests.ps1 b/tests/Model/InboxExistsDto.Tests.ps1 new file mode 100644 index 00000000..8f6972aa --- /dev/null +++ b/tests/Model/InboxExistsDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxExistsDto' { + Context 'InboxExistsDto' { + It 'Initialize-InboxExistsDto' { + # a simple test to create an object + #$NewObject = Initialize-InboxExistsDto -Exists "TEST_VALUE" + #$NewObject | Should -BeOfType InboxExistsDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxForwarderDto.Tests.ps1 b/tests/Model/InboxForwarderDto.Tests.ps1 new file mode 100644 index 00000000..496b3664 --- /dev/null +++ b/tests/Model/InboxForwarderDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxForwarderDto' { + Context 'InboxForwarderDto' { + It 'Initialize-InboxForwarderDto' { + # a simple test to create an object + #$NewObject = Initialize-InboxForwarderDto -Id "TEST_VALUE" -InboxId "TEST_VALUE" -Name "TEST_VALUE" -Field "TEST_VALUE" -Match "TEST_VALUE" -ForwardToRecipients "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType InboxForwarderDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxForwarderEventDto.Tests.ps1 b/tests/Model/InboxForwarderEventDto.Tests.ps1 new file mode 100644 index 00000000..640a79e3 --- /dev/null +++ b/tests/Model/InboxForwarderEventDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxForwarderEventDto' { + Context 'InboxForwarderEventDto' { + It 'Initialize-InboxForwarderEventDto' { + # a simple test to create an object + #$NewObject = Initialize-InboxForwarderEventDto -Id "TEST_VALUE" -InboxId "TEST_VALUE" -EmailId "TEST_VALUE" -UserId "TEST_VALUE" -ForwarderId "TEST_VALUE" -Message "TEST_VALUE" -Status "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType InboxForwarderEventDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxForwarderEventProjection.Tests.ps1 b/tests/Model/InboxForwarderEventProjection.Tests.ps1 new file mode 100644 index 00000000..343ed805 --- /dev/null +++ b/tests/Model/InboxForwarderEventProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxForwarderEventProjection' { + Context 'InboxForwarderEventProjection' { + It 'Initialize-InboxForwarderEventProjection' { + # a simple test to create an object + #$NewObject = Initialize-InboxForwarderEventProjection -EmailId "TEST_VALUE" -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -ForwarderId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Message "TEST_VALUE" -Id "TEST_VALUE" -Status "TEST_VALUE" + #$NewObject | Should -BeOfType InboxForwarderEventProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxForwarderTestOptions.Tests.ps1 b/tests/Model/InboxForwarderTestOptions.Tests.ps1 new file mode 100644 index 00000000..92da3172 --- /dev/null +++ b/tests/Model/InboxForwarderTestOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxForwarderTestOptions' { + Context 'InboxForwarderTestOptions' { + It 'Initialize-InboxForwarderTestOptions' { + # a simple test to create an object + #$NewObject = Initialize-InboxForwarderTestOptions -TestValue "TEST_VALUE" + #$NewObject | Should -BeOfType InboxForwarderTestOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxForwarderTestResult.Tests.ps1 b/tests/Model/InboxForwarderTestResult.Tests.ps1 new file mode 100644 index 00000000..5a3a95cb --- /dev/null +++ b/tests/Model/InboxForwarderTestResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxForwarderTestResult' { + Context 'InboxForwarderTestResult' { + It 'Initialize-InboxForwarderTestResult' { + # a simple test to create an object + #$NewObject = Initialize-InboxForwarderTestResult -VarMatches "TEST_VALUE" -DoesMatch "TEST_VALUE" + #$NewObject | Should -BeOfType InboxForwarderTestResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxIdItem.Tests.ps1 b/tests/Model/InboxIdItem.Tests.ps1 new file mode 100644 index 00000000..8947d416 --- /dev/null +++ b/tests/Model/InboxIdItem.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxIdItem' { + Context 'InboxIdItem' { + It 'Initialize-InboxIdItem' { + # a simple test to create an object + #$NewObject = Initialize-InboxIdItem -Id "TEST_VALUE" -EmailAddress "TEST_VALUE" + #$NewObject | Should -BeOfType InboxIdItem + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxIdsResult.Tests.ps1 b/tests/Model/InboxIdsResult.Tests.ps1 new file mode 100644 index 00000000..4294a936 --- /dev/null +++ b/tests/Model/InboxIdsResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxIdsResult' { + Context 'InboxIdsResult' { + It 'Initialize-InboxIdsResult' { + # a simple test to create an object + #$NewObject = Initialize-InboxIdsResult -InboxIds "TEST_VALUE" + #$NewObject | Should -BeOfType InboxIdsResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxPreview.Tests.ps1 b/tests/Model/InboxPreview.Tests.ps1 new file mode 100644 index 00000000..68c30a86 --- /dev/null +++ b/tests/Model/InboxPreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxPreview' { + Context 'InboxPreview' { + It 'Initialize-InboxPreview' { + # a simple test to create an object + #$NewObject = Initialize-InboxPreview -Id "TEST_VALUE" -DomainId "TEST_VALUE" -EmailAddress "TEST_VALUE" -CreatedAt "TEST_VALUE" -Favourite "TEST_VALUE" -Name "TEST_VALUE" -Tags "TEST_VALUE" -TeamAccess "TEST_VALUE" -InboxType "TEST_VALUE" -VirtualInbox "TEST_VALUE" -ExpiresAt "TEST_VALUE" -FunctionsAs "TEST_VALUE" + #$NewObject | Should -BeOfType InboxPreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxReplierDto.Tests.ps1 b/tests/Model/InboxReplierDto.Tests.ps1 new file mode 100644 index 00000000..227f6b36 --- /dev/null +++ b/tests/Model/InboxReplierDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxReplierDto' { + Context 'InboxReplierDto' { + It 'Initialize-InboxReplierDto' { + # a simple test to create an object + #$NewObject = Initialize-InboxReplierDto -Id "TEST_VALUE" -InboxId "TEST_VALUE" -Name "TEST_VALUE" -Field "TEST_VALUE" -Match "TEST_VALUE" -ReplyTo "TEST_VALUE" -Subject "TEST_VALUE" -VarFrom "TEST_VALUE" -Charset "TEST_VALUE" -IsHTML "TEST_VALUE" -TemplateId "TEST_VALUE" -TemplateVariables "TEST_VALUE" -IgnoreReplyTo "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType InboxReplierDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxReplierEventProjection.Tests.ps1 b/tests/Model/InboxReplierEventProjection.Tests.ps1 new file mode 100644 index 00000000..b47af00c --- /dev/null +++ b/tests/Model/InboxReplierEventProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxReplierEventProjection' { + Context 'InboxReplierEventProjection' { + It 'Initialize-InboxReplierEventProjection' { + # a simple test to create an object + #$NewObject = Initialize-InboxReplierEventProjection -Recipients "TEST_VALUE" -EmailId "TEST_VALUE" -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -SentId "TEST_VALUE" -ReplierId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Message "TEST_VALUE" -Id "TEST_VALUE" -Status "TEST_VALUE" + #$NewObject | Should -BeOfType InboxReplierEventProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxRulesetDto.Tests.ps1 b/tests/Model/InboxRulesetDto.Tests.ps1 new file mode 100644 index 00000000..304a93b1 --- /dev/null +++ b/tests/Model/InboxRulesetDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxRulesetDto' { + Context 'InboxRulesetDto' { + It 'Initialize-InboxRulesetDto' { + # a simple test to create an object + #$NewObject = Initialize-InboxRulesetDto -Id "TEST_VALUE" -InboxId "TEST_VALUE" -Scope "TEST_VALUE" -Action "TEST_VALUE" -Target "TEST_VALUE" -Handler "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType InboxRulesetDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxRulesetTestOptions.Tests.ps1 b/tests/Model/InboxRulesetTestOptions.Tests.ps1 new file mode 100644 index 00000000..2f8e95e1 --- /dev/null +++ b/tests/Model/InboxRulesetTestOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxRulesetTestOptions' { + Context 'InboxRulesetTestOptions' { + It 'Initialize-InboxRulesetTestOptions' { + # a simple test to create an object + #$NewObject = Initialize-InboxRulesetTestOptions -TestTarget "TEST_VALUE" + #$NewObject | Should -BeOfType InboxRulesetTestOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InboxRulesetTestResult.Tests.ps1 b/tests/Model/InboxRulesetTestResult.Tests.ps1 new file mode 100644 index 00000000..a6d8352e --- /dev/null +++ b/tests/Model/InboxRulesetTestResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InboxRulesetTestResult' { + Context 'InboxRulesetTestResult' { + It 'Initialize-InboxRulesetTestResult' { + # a simple test to create an object + #$NewObject = Initialize-InboxRulesetTestResult -RulesetMatches "TEST_VALUE" -VarMatches "TEST_VALUE" + #$NewObject | Should -BeOfType InboxRulesetTestResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/InlineObject.Tests.ps1 b/tests/Model/InlineObject.Tests.ps1 new file mode 100644 index 00000000..db4a630b --- /dev/null +++ b/tests/Model/InlineObject.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'InlineObject' { + Context 'InlineObject' { + It 'Initialize-InlineObject' { + # a simple test to create an object + #$NewObject = Initialize-InlineObject -ContentTypeHeader "TEST_VALUE" -File "TEST_VALUE" + #$NewObject | Should -BeOfType InlineObject + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/JSONSchemaDto.Tests.ps1 b/tests/Model/JSONSchemaDto.Tests.ps1 new file mode 100644 index 00000000..c448a8c7 --- /dev/null +++ b/tests/Model/JSONSchemaDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'JSONSchemaDto' { + Context 'JSONSchemaDto' { + It 'Initialize-JSONSchemaDto' { + # a simple test to create an object + #$NewObject = Initialize-JSONSchemaDto -Value "TEST_VALUE" + #$NewObject | Should -BeOfType JSONSchemaDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LinkIssue.Tests.ps1 b/tests/Model/LinkIssue.Tests.ps1 new file mode 100644 index 00000000..9dac6462 --- /dev/null +++ b/tests/Model/LinkIssue.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LinkIssue' { + Context 'LinkIssue' { + It 'Initialize-LinkIssue' { + # a simple test to create an object + #$NewObject = Initialize-LinkIssue -Url "TEST_VALUE" -ResponseStatus "TEST_VALUE" -Severity "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType LinkIssue + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ListUnsubscribeRecipientProjection.Tests.ps1 b/tests/Model/ListUnsubscribeRecipientProjection.Tests.ps1 new file mode 100644 index 00000000..78656f11 --- /dev/null +++ b/tests/Model/ListUnsubscribeRecipientProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ListUnsubscribeRecipientProjection' { + Context 'ListUnsubscribeRecipientProjection' { + It 'Initialize-ListUnsubscribeRecipientProjection' { + # a simple test to create an object + #$NewObject = Initialize-ListUnsubscribeRecipientProjection -EmailAddress "TEST_VALUE" -DomainId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ListUnsubscribeRecipientProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupBimiDomainOptions.Tests.ps1 b/tests/Model/LookupBimiDomainOptions.Tests.ps1 new file mode 100644 index 00000000..c6fc5d1d --- /dev/null +++ b/tests/Model/LookupBimiDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupBimiDomainOptions' { + Context 'LookupBimiDomainOptions' { + It 'Initialize-LookupBimiDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-LookupBimiDomainOptions -VarHost "TEST_VALUE" + #$NewObject | Should -BeOfType LookupBimiDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupBimiDomainResults.Tests.ps1 b/tests/Model/LookupBimiDomainResults.Tests.ps1 new file mode 100644 index 00000000..a21c9a23 --- /dev/null +++ b/tests/Model/LookupBimiDomainResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupBimiDomainResults' { + Context 'LookupBimiDomainResults' { + It 'Initialize-LookupBimiDomainResults' { + # a simple test to create an object + #$NewObject = Initialize-LookupBimiDomainResults -Valid "TEST_VALUE" -Query "TEST_VALUE" -Records "TEST_VALUE" -Errors "TEST_VALUE" -Warnings "TEST_VALUE" + #$NewObject | Should -BeOfType LookupBimiDomainResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupDmarcDomainOptions.Tests.ps1 b/tests/Model/LookupDmarcDomainOptions.Tests.ps1 new file mode 100644 index 00000000..6ee99ecf --- /dev/null +++ b/tests/Model/LookupDmarcDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupDmarcDomainOptions' { + Context 'LookupDmarcDomainOptions' { + It 'Initialize-LookupDmarcDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-LookupDmarcDomainOptions -VarHost "TEST_VALUE" + #$NewObject | Should -BeOfType LookupDmarcDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupDmarcDomainResults.Tests.ps1 b/tests/Model/LookupDmarcDomainResults.Tests.ps1 new file mode 100644 index 00000000..29c0b790 --- /dev/null +++ b/tests/Model/LookupDmarcDomainResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupDmarcDomainResults' { + Context 'LookupDmarcDomainResults' { + It 'Initialize-LookupDmarcDomainResults' { + # a simple test to create an object + #$NewObject = Initialize-LookupDmarcDomainResults -Valid "TEST_VALUE" -Query "TEST_VALUE" -Records "TEST_VALUE" -Errors "TEST_VALUE" -Warnings "TEST_VALUE" + #$NewObject | Should -BeOfType LookupDmarcDomainResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupMtaStsDomainOptions.Tests.ps1 b/tests/Model/LookupMtaStsDomainOptions.Tests.ps1 new file mode 100644 index 00000000..0e59b9a1 --- /dev/null +++ b/tests/Model/LookupMtaStsDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupMtaStsDomainOptions' { + Context 'LookupMtaStsDomainOptions' { + It 'Initialize-LookupMtaStsDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-LookupMtaStsDomainOptions -VarHost "TEST_VALUE" + #$NewObject | Should -BeOfType LookupMtaStsDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupMtaStsDomainResults.Tests.ps1 b/tests/Model/LookupMtaStsDomainResults.Tests.ps1 new file mode 100644 index 00000000..8310c424 --- /dev/null +++ b/tests/Model/LookupMtaStsDomainResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupMtaStsDomainResults' { + Context 'LookupMtaStsDomainResults' { + It 'Initialize-LookupMtaStsDomainResults' { + # a simple test to create an object + #$NewObject = Initialize-LookupMtaStsDomainResults -Valid "TEST_VALUE" -Query "TEST_VALUE" -Records "TEST_VALUE" -WellKnownQuery "TEST_VALUE" -WellKnownPresent "TEST_VALUE" -WellKnownValue "TEST_VALUE" -Errors "TEST_VALUE" -Warnings "TEST_VALUE" + #$NewObject | Should -BeOfType LookupMtaStsDomainResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupTlsReportingDomainOptions.Tests.ps1 b/tests/Model/LookupTlsReportingDomainOptions.Tests.ps1 new file mode 100644 index 00000000..e17faf6c --- /dev/null +++ b/tests/Model/LookupTlsReportingDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupTlsReportingDomainOptions' { + Context 'LookupTlsReportingDomainOptions' { + It 'Initialize-LookupTlsReportingDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-LookupTlsReportingDomainOptions -VarHost "TEST_VALUE" + #$NewObject | Should -BeOfType LookupTlsReportingDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/LookupTlsReportingDomainResults.Tests.ps1 b/tests/Model/LookupTlsReportingDomainResults.Tests.ps1 new file mode 100644 index 00000000..6984a755 --- /dev/null +++ b/tests/Model/LookupTlsReportingDomainResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'LookupTlsReportingDomainResults' { + Context 'LookupTlsReportingDomainResults' { + It 'Initialize-LookupTlsReportingDomainResults' { + # a simple test to create an object + #$NewObject = Initialize-LookupTlsReportingDomainResults -Valid "TEST_VALUE" -Query "TEST_VALUE" -Records "TEST_VALUE" -Errors "TEST_VALUE" -Warnings "TEST_VALUE" + #$NewObject | Should -BeOfType LookupTlsReportingDomainResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/MatchOption.Tests.ps1 b/tests/Model/MatchOption.Tests.ps1 new file mode 100644 index 00000000..65102469 --- /dev/null +++ b/tests/Model/MatchOption.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'MatchOption' { + Context 'MatchOption' { + It 'Initialize-MatchOption' { + # a simple test to create an object + #$NewObject = Initialize-MatchOption -Field "TEST_VALUE" -Should "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType MatchOption + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/MatchOptions.Tests.ps1 b/tests/Model/MatchOptions.Tests.ps1 new file mode 100644 index 00000000..a582967c --- /dev/null +++ b/tests/Model/MatchOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'MatchOptions' { + Context 'MatchOptions' { + It 'Initialize-MatchOptions' { + # a simple test to create an object + #$NewObject = Initialize-MatchOptions -VarMatches "TEST_VALUE" -Conditions "TEST_VALUE" + #$NewObject | Should -BeOfType MatchOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/MissedEmailDto.Tests.ps1 b/tests/Model/MissedEmailDto.Tests.ps1 new file mode 100644 index 00000000..5c347b84 --- /dev/null +++ b/tests/Model/MissedEmailDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'MissedEmailDto' { + Context 'MissedEmailDto' { + It 'Initialize-MissedEmailDto' { + # a simple test to create an object + #$NewObject = Initialize-MissedEmailDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -Subject "TEST_VALUE" -BodyExcerpt "TEST_VALUE" -AttachmentCount "TEST_VALUE" -VarFrom "TEST_VALUE" -RawUrl "TEST_VALUE" -RawKey "TEST_VALUE" -RawBucket "TEST_VALUE" -CanRestore "TEST_VALUE" -To "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" -InboxIds "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType MissedEmailDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/MissedEmailProjection.Tests.ps1 b/tests/Model/MissedEmailProjection.Tests.ps1 new file mode 100644 index 00000000..84924f87 --- /dev/null +++ b/tests/Model/MissedEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'MissedEmailProjection' { + Context 'MissedEmailProjection' { + It 'Initialize-MissedEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-MissedEmailProjection -UserId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Subject "TEST_VALUE" -Id "TEST_VALUE" -VarFrom "TEST_VALUE" + #$NewObject | Should -BeOfType MissedEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ModelSender.Tests.ps1 b/tests/Model/ModelSender.Tests.ps1 new file mode 100644 index 00000000..e528a824 --- /dev/null +++ b/tests/Model/ModelSender.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ModelSender' { + Context 'ModelSender' { + It 'Initialize-ModelSender' { + # a simple test to create an object + #$NewObject = Initialize-ModelSender -RawValue "TEST_VALUE" -EmailAddress "TEST_VALUE" -Name "TEST_VALUE" + #$NewObject | Should -BeOfType ModelSender + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/NameServerRecord.Tests.ps1 b/tests/Model/NameServerRecord.Tests.ps1 new file mode 100644 index 00000000..3134c118 --- /dev/null +++ b/tests/Model/NameServerRecord.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'NameServerRecord' { + Context 'NameServerRecord' { + It 'Initialize-NameServerRecord' { + # a simple test to create an object + #$NewObject = Initialize-NameServerRecord -Raw "TEST_VALUE" -RecordType "TEST_VALUE" -Priority "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType NameServerRecord + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/NewFakeEmailAddressResult.Tests.ps1 b/tests/Model/NewFakeEmailAddressResult.Tests.ps1 new file mode 100644 index 00000000..f6c08c1d --- /dev/null +++ b/tests/Model/NewFakeEmailAddressResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'NewFakeEmailAddressResult' { + Context 'NewFakeEmailAddressResult' { + It 'Initialize-NewFakeEmailAddressResult' { + # a simple test to create an object + #$NewObject = Initialize-NewFakeEmailAddressResult -EmailAddress "TEST_VALUE" + #$NewObject | Should -BeOfType NewFakeEmailAddressResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/OrganizationInboxProjection.Tests.ps1 b/tests/Model/OrganizationInboxProjection.Tests.ps1 new file mode 100644 index 00000000..cbf775f7 --- /dev/null +++ b/tests/Model/OrganizationInboxProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'OrganizationInboxProjection' { + Context 'OrganizationInboxProjection' { + It 'Initialize-OrganizationInboxProjection' { + # a simple test to create an object + #$NewObject = Initialize-OrganizationInboxProjection -Id "TEST_VALUE" -DomainId "TEST_VALUE" -CreatedAt "TEST_VALUE" -Name "TEST_VALUE" -EmailAddress "TEST_VALUE" -Favourite "TEST_VALUE" -Tags "TEST_VALUE" -TeamAccess "TEST_VALUE" -InboxType "TEST_VALUE" -ReadOnly "TEST_VALUE" -VirtualInbox "TEST_VALUE" -FunctionsAs "TEST_VALUE" + #$NewObject | Should -BeOfType OrganizationInboxProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageAlias.Tests.ps1 b/tests/Model/PageAlias.Tests.ps1 new file mode 100644 index 00000000..829f792e --- /dev/null +++ b/tests/Model/PageAlias.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageAlias' { + Context 'PageAlias' { + It 'Initialize-PageAlias' { + # a simple test to create an object + #$NewObject = Initialize-PageAlias -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageAlias + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageAttachmentEntity.Tests.ps1 b/tests/Model/PageAttachmentEntity.Tests.ps1 new file mode 100644 index 00000000..d117451a --- /dev/null +++ b/tests/Model/PageAttachmentEntity.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageAttachmentEntity' { + Context 'PageAttachmentEntity' { + It 'Initialize-PageAttachmentEntity' { + # a simple test to create an object + #$NewObject = Initialize-PageAttachmentEntity -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageAttachmentEntity + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageBouncedEmail.Tests.ps1 b/tests/Model/PageBouncedEmail.Tests.ps1 new file mode 100644 index 00000000..45d8beb7 --- /dev/null +++ b/tests/Model/PageBouncedEmail.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageBouncedEmail' { + Context 'PageBouncedEmail' { + It 'Initialize-PageBouncedEmail' { + # a simple test to create an object + #$NewObject = Initialize-PageBouncedEmail -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageBouncedEmail + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageBouncedRecipients.Tests.ps1 b/tests/Model/PageBouncedRecipients.Tests.ps1 new file mode 100644 index 00000000..34ff5020 --- /dev/null +++ b/tests/Model/PageBouncedRecipients.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageBouncedRecipients' { + Context 'PageBouncedRecipients' { + It 'Initialize-PageBouncedRecipients' { + # a simple test to create an object + #$NewObject = Initialize-PageBouncedRecipients -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageBouncedRecipients + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageComplaint.Tests.ps1 b/tests/Model/PageComplaint.Tests.ps1 new file mode 100644 index 00000000..e0aefa17 --- /dev/null +++ b/tests/Model/PageComplaint.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageComplaint' { + Context 'PageComplaint' { + It 'Initialize-PageComplaint' { + # a simple test to create an object + #$NewObject = Initialize-PageComplaint -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageComplaint + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageConnector.Tests.ps1 b/tests/Model/PageConnector.Tests.ps1 new file mode 100644 index 00000000..97e6b550 --- /dev/null +++ b/tests/Model/PageConnector.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageConnector' { + Context 'PageConnector' { + It 'Initialize-PageConnector' { + # a simple test to create an object + #$NewObject = Initialize-PageConnector -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageConnector + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageConnectorSyncEvents.Tests.ps1 b/tests/Model/PageConnectorSyncEvents.Tests.ps1 new file mode 100644 index 00000000..ff106174 --- /dev/null +++ b/tests/Model/PageConnectorSyncEvents.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageConnectorSyncEvents' { + Context 'PageConnectorSyncEvents' { + It 'Initialize-PageConnectorSyncEvents' { + # a simple test to create an object + #$NewObject = Initialize-PageConnectorSyncEvents -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageConnectorSyncEvents + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageContactProjection.Tests.ps1 b/tests/Model/PageContactProjection.Tests.ps1 new file mode 100644 index 00000000..5bf054be --- /dev/null +++ b/tests/Model/PageContactProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageContactProjection' { + Context 'PageContactProjection' { + It 'Initialize-PageContactProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageContactProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageContactProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageDeliveryStatus.Tests.ps1 b/tests/Model/PageDeliveryStatus.Tests.ps1 new file mode 100644 index 00000000..ebfbd48f --- /dev/null +++ b/tests/Model/PageDeliveryStatus.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageDeliveryStatus' { + Context 'PageDeliveryStatus' { + It 'Initialize-PageDeliveryStatus' { + # a simple test to create an object + #$NewObject = Initialize-PageDeliveryStatus -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageDeliveryStatus + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageEmailPreview.Tests.ps1 b/tests/Model/PageEmailPreview.Tests.ps1 new file mode 100644 index 00000000..da2ea854 --- /dev/null +++ b/tests/Model/PageEmailPreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageEmailPreview' { + Context 'PageEmailPreview' { + It 'Initialize-PageEmailPreview' { + # a simple test to create an object + #$NewObject = Initialize-PageEmailPreview -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageEmailPreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageEmailProjection.Tests.ps1 b/tests/Model/PageEmailProjection.Tests.ps1 new file mode 100644 index 00000000..6f86f53a --- /dev/null +++ b/tests/Model/PageEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageEmailProjection' { + Context 'PageEmailProjection' { + It 'Initialize-PageEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageEmailProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageEmailValidationRequest.Tests.ps1 b/tests/Model/PageEmailValidationRequest.Tests.ps1 new file mode 100644 index 00000000..d61ab73e --- /dev/null +++ b/tests/Model/PageEmailValidationRequest.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageEmailValidationRequest' { + Context 'PageEmailValidationRequest' { + It 'Initialize-PageEmailValidationRequest' { + # a simple test to create an object + #$NewObject = Initialize-PageEmailValidationRequest -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageEmailValidationRequest + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageExpiredInboxRecordProjection.Tests.ps1 b/tests/Model/PageExpiredInboxRecordProjection.Tests.ps1 new file mode 100644 index 00000000..31392f18 --- /dev/null +++ b/tests/Model/PageExpiredInboxRecordProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageExpiredInboxRecordProjection' { + Context 'PageExpiredInboxRecordProjection' { + It 'Initialize-PageExpiredInboxRecordProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageExpiredInboxRecordProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageExpiredInboxRecordProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageGroupProjection.Tests.ps1 b/tests/Model/PageGroupProjection.Tests.ps1 new file mode 100644 index 00000000..8e9fff15 --- /dev/null +++ b/tests/Model/PageGroupProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageGroupProjection' { + Context 'PageGroupProjection' { + It 'Initialize-PageGroupProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageGroupProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageGroupProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageInboxForwarderDto.Tests.ps1 b/tests/Model/PageInboxForwarderDto.Tests.ps1 new file mode 100644 index 00000000..7c4e2e29 --- /dev/null +++ b/tests/Model/PageInboxForwarderDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageInboxForwarderDto' { + Context 'PageInboxForwarderDto' { + It 'Initialize-PageInboxForwarderDto' { + # a simple test to create an object + #$NewObject = Initialize-PageInboxForwarderDto -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageInboxForwarderDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageInboxForwarderEvents.Tests.ps1 b/tests/Model/PageInboxForwarderEvents.Tests.ps1 new file mode 100644 index 00000000..bc71c027 --- /dev/null +++ b/tests/Model/PageInboxForwarderEvents.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageInboxForwarderEvents' { + Context 'PageInboxForwarderEvents' { + It 'Initialize-PageInboxForwarderEvents' { + # a simple test to create an object + #$NewObject = Initialize-PageInboxForwarderEvents -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageInboxForwarderEvents + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageInboxProjection.Tests.ps1 b/tests/Model/PageInboxProjection.Tests.ps1 new file mode 100644 index 00000000..72e0df92 --- /dev/null +++ b/tests/Model/PageInboxProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageInboxProjection' { + Context 'PageInboxProjection' { + It 'Initialize-PageInboxProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageInboxProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageInboxProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageInboxReplierDto.Tests.ps1 b/tests/Model/PageInboxReplierDto.Tests.ps1 new file mode 100644 index 00000000..aab297fe --- /dev/null +++ b/tests/Model/PageInboxReplierDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageInboxReplierDto' { + Context 'PageInboxReplierDto' { + It 'Initialize-PageInboxReplierDto' { + # a simple test to create an object + #$NewObject = Initialize-PageInboxReplierDto -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageInboxReplierDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageInboxReplierEvents.Tests.ps1 b/tests/Model/PageInboxReplierEvents.Tests.ps1 new file mode 100644 index 00000000..cfdf77c1 --- /dev/null +++ b/tests/Model/PageInboxReplierEvents.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageInboxReplierEvents' { + Context 'PageInboxReplierEvents' { + It 'Initialize-PageInboxReplierEvents' { + # a simple test to create an object + #$NewObject = Initialize-PageInboxReplierEvents -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageInboxReplierEvents + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageInboxRulesetDto.Tests.ps1 b/tests/Model/PageInboxRulesetDto.Tests.ps1 new file mode 100644 index 00000000..ea131949 --- /dev/null +++ b/tests/Model/PageInboxRulesetDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageInboxRulesetDto' { + Context 'PageInboxRulesetDto' { + It 'Initialize-PageInboxRulesetDto' { + # a simple test to create an object + #$NewObject = Initialize-PageInboxRulesetDto -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageInboxRulesetDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageListUnsubscribeRecipients.Tests.ps1 b/tests/Model/PageListUnsubscribeRecipients.Tests.ps1 new file mode 100644 index 00000000..35e29f61 --- /dev/null +++ b/tests/Model/PageListUnsubscribeRecipients.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageListUnsubscribeRecipients' { + Context 'PageListUnsubscribeRecipients' { + It 'Initialize-PageListUnsubscribeRecipients' { + # a simple test to create an object + #$NewObject = Initialize-PageListUnsubscribeRecipients -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageListUnsubscribeRecipients + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageMissedEmailProjection.Tests.ps1 b/tests/Model/PageMissedEmailProjection.Tests.ps1 new file mode 100644 index 00000000..32f2dc35 --- /dev/null +++ b/tests/Model/PageMissedEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageMissedEmailProjection' { + Context 'PageMissedEmailProjection' { + It 'Initialize-PageMissedEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageMissedEmailProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageMissedEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageOrganizationInboxProjection.Tests.ps1 b/tests/Model/PageOrganizationInboxProjection.Tests.ps1 new file mode 100644 index 00000000..d20175cd --- /dev/null +++ b/tests/Model/PageOrganizationInboxProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageOrganizationInboxProjection' { + Context 'PageOrganizationInboxProjection' { + It 'Initialize-PageOrganizationInboxProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageOrganizationInboxProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageOrganizationInboxProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PagePhoneNumberProjection.Tests.ps1 b/tests/Model/PagePhoneNumberProjection.Tests.ps1 new file mode 100644 index 00000000..a3b68d12 --- /dev/null +++ b/tests/Model/PagePhoneNumberProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PagePhoneNumberProjection' { + Context 'PagePhoneNumberProjection' { + It 'Initialize-PagePhoneNumberProjection' { + # a simple test to create an object + #$NewObject = Initialize-PagePhoneNumberProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PagePhoneNumberProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageScheduledJobs.Tests.ps1 b/tests/Model/PageScheduledJobs.Tests.ps1 new file mode 100644 index 00000000..c3fb6dad --- /dev/null +++ b/tests/Model/PageScheduledJobs.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageScheduledJobs' { + Context 'PageScheduledJobs' { + It 'Initialize-PageScheduledJobs' { + # a simple test to create an object + #$NewObject = Initialize-PageScheduledJobs -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageScheduledJobs + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageSentEmailProjection.Tests.ps1 b/tests/Model/PageSentEmailProjection.Tests.ps1 new file mode 100644 index 00000000..13f84e35 --- /dev/null +++ b/tests/Model/PageSentEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageSentEmailProjection' { + Context 'PageSentEmailProjection' { + It 'Initialize-PageSentEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageSentEmailProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageSentEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageSentEmailWithQueueProjection.Tests.ps1 b/tests/Model/PageSentEmailWithQueueProjection.Tests.ps1 new file mode 100644 index 00000000..2aead5a3 --- /dev/null +++ b/tests/Model/PageSentEmailWithQueueProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageSentEmailWithQueueProjection' { + Context 'PageSentEmailWithQueueProjection' { + It 'Initialize-PageSentEmailWithQueueProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageSentEmailWithQueueProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageSentEmailWithQueueProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageSmsProjection.Tests.ps1 b/tests/Model/PageSmsProjection.Tests.ps1 new file mode 100644 index 00000000..9d4abb01 --- /dev/null +++ b/tests/Model/PageSmsProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageSmsProjection' { + Context 'PageSmsProjection' { + It 'Initialize-PageSmsProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageSmsProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageSmsProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageTemplateProjection.Tests.ps1 b/tests/Model/PageTemplateProjection.Tests.ps1 new file mode 100644 index 00000000..a963f81a --- /dev/null +++ b/tests/Model/PageTemplateProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageTemplateProjection' { + Context 'PageTemplateProjection' { + It 'Initialize-PageTemplateProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageTemplateProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageTemplateProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageThreadProjection.Tests.ps1 b/tests/Model/PageThreadProjection.Tests.ps1 new file mode 100644 index 00000000..873f4ce6 --- /dev/null +++ b/tests/Model/PageThreadProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageThreadProjection' { + Context 'PageThreadProjection' { + It 'Initialize-PageThreadProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageThreadProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageThreadProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageTrackingPixelProjection.Tests.ps1 b/tests/Model/PageTrackingPixelProjection.Tests.ps1 new file mode 100644 index 00000000..d3bf188c --- /dev/null +++ b/tests/Model/PageTrackingPixelProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageTrackingPixelProjection' { + Context 'PageTrackingPixelProjection' { + It 'Initialize-PageTrackingPixelProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageTrackingPixelProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageTrackingPixelProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageUnknownMissedEmailProjection.Tests.ps1 b/tests/Model/PageUnknownMissedEmailProjection.Tests.ps1 new file mode 100644 index 00000000..1940ffc1 --- /dev/null +++ b/tests/Model/PageUnknownMissedEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageUnknownMissedEmailProjection' { + Context 'PageUnknownMissedEmailProjection' { + It 'Initialize-PageUnknownMissedEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageUnknownMissedEmailProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageUnknownMissedEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageWebhookProjection.Tests.ps1 b/tests/Model/PageWebhookProjection.Tests.ps1 new file mode 100644 index 00000000..61068c05 --- /dev/null +++ b/tests/Model/PageWebhookProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageWebhookProjection' { + Context 'PageWebhookProjection' { + It 'Initialize-PageWebhookProjection' { + # a simple test to create an object + #$NewObject = Initialize-PageWebhookProjection -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageWebhookProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageWebhookResult.Tests.ps1 b/tests/Model/PageWebhookResult.Tests.ps1 new file mode 100644 index 00000000..e0dc1a0d --- /dev/null +++ b/tests/Model/PageWebhookResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageWebhookResult' { + Context 'PageWebhookResult' { + It 'Initialize-PageWebhookResult' { + # a simple test to create an object + #$NewObject = Initialize-PageWebhookResult -Content "TEST_VALUE" -Pageable "TEST_VALUE" -TotalPages "TEST_VALUE" -TotalElements "TEST_VALUE" -Last "TEST_VALUE" -NumberOfElements "TEST_VALUE" -Size "TEST_VALUE" -Number "TEST_VALUE" -Sort "TEST_VALUE" -First "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType PageWebhookResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PageableObject.Tests.ps1 b/tests/Model/PageableObject.Tests.ps1 new file mode 100644 index 00000000..1991cb97 --- /dev/null +++ b/tests/Model/PageableObject.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PageableObject' { + Context 'PageableObject' { + It 'Initialize-PageableObject' { + # a simple test to create an object + #$NewObject = Initialize-PageableObject -PageNumber "TEST_VALUE" -PageSize "TEST_VALUE" -Paged "TEST_VALUE" -Unpaged "TEST_VALUE" -Offset "TEST_VALUE" -Sort "TEST_VALUE" + #$NewObject | Should -BeOfType PageableObject + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PhoneNumberDto.Tests.ps1 b/tests/Model/PhoneNumberDto.Tests.ps1 new file mode 100644 index 00000000..334dabb5 --- /dev/null +++ b/tests/Model/PhoneNumberDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PhoneNumberDto' { + Context 'PhoneNumberDto' { + It 'Initialize-PhoneNumberDto' { + # a simple test to create an object + #$NewObject = Initialize-PhoneNumberDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -ComplianceAddress "TEST_VALUE" -EmergencyAddress "TEST_VALUE" -PhoneNumber "TEST_VALUE" -PhoneCountry "TEST_VALUE" -PhonePlan "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType PhoneNumberDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PhoneNumberProjection.Tests.ps1 b/tests/Model/PhoneNumberProjection.Tests.ps1 new file mode 100644 index 00000000..0438bd61 --- /dev/null +++ b/tests/Model/PhoneNumberProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PhoneNumberProjection' { + Context 'PhoneNumberProjection' { + It 'Initialize-PhoneNumberProjection' { + # a simple test to create an object + #$NewObject = Initialize-PhoneNumberProjection -UserId "TEST_VALUE" -PhoneNumber "TEST_VALUE" -PhoneCountry "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType PhoneNumberProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/PhonePlanDto.Tests.ps1 b/tests/Model/PhonePlanDto.Tests.ps1 new file mode 100644 index 00000000..5654a6ff --- /dev/null +++ b/tests/Model/PhonePlanDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'PhonePlanDto' { + Context 'PhonePlanDto' { + It 'Initialize-PhonePlanDto' { + # a simple test to create an object + #$NewObject = Initialize-PhonePlanDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -PhoneCountry "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType PhonePlanDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/RawEmailJson.Tests.ps1 b/tests/Model/RawEmailJson.Tests.ps1 new file mode 100644 index 00000000..cb7ea395 --- /dev/null +++ b/tests/Model/RawEmailJson.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'RawEmailJson' { + Context 'RawEmailJson' { + It 'Initialize-RawEmailJson' { + # a simple test to create an object + #$NewObject = Initialize-RawEmailJson -Content "TEST_VALUE" + #$NewObject | Should -BeOfType RawEmailJson + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/Recipient.Tests.ps1 b/tests/Model/Recipient.Tests.ps1 new file mode 100644 index 00000000..64f7d8f4 --- /dev/null +++ b/tests/Model/Recipient.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'Recipient' { + Context 'Recipient' { + It 'Initialize-Recipient' { + # a simple test to create an object + #$NewObject = Initialize-Recipient -RawValue "TEST_VALUE" -EmailAddress "TEST_VALUE" -Name "TEST_VALUE" + #$NewObject | Should -BeOfType Recipient + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ReplyForSms.Tests.ps1 b/tests/Model/ReplyForSms.Tests.ps1 new file mode 100644 index 00000000..47c82722 --- /dev/null +++ b/tests/Model/ReplyForSms.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ReplyForSms' { + Context 'ReplyForSms' { + It 'Initialize-ReplyForSms' { + # a simple test to create an object + #$NewObject = Initialize-ReplyForSms -Reply "TEST_VALUE" + #$NewObject | Should -BeOfType ReplyForSms + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ReplyToAliasEmailOptions.Tests.ps1 b/tests/Model/ReplyToAliasEmailOptions.Tests.ps1 new file mode 100644 index 00000000..111c2bf9 --- /dev/null +++ b/tests/Model/ReplyToAliasEmailOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ReplyToAliasEmailOptions' { + Context 'ReplyToAliasEmailOptions' { + It 'Initialize-ReplyToAliasEmailOptions' { + # a simple test to create an object + #$NewObject = Initialize-ReplyToAliasEmailOptions -Body "TEST_VALUE" -IsHTML "TEST_VALUE" -Charset "TEST_VALUE" -Attachments "TEST_VALUE" -TemplateVariables "TEST_VALUE" -Template "TEST_VALUE" -SendStrategy "TEST_VALUE" -CustomHeaders "TEST_VALUE" -UseInboxName "TEST_VALUE" -Html "TEST_VALUE" + #$NewObject | Should -BeOfType ReplyToAliasEmailOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ReplyToEmailOptions.Tests.ps1 b/tests/Model/ReplyToEmailOptions.Tests.ps1 new file mode 100644 index 00000000..d0de12cc --- /dev/null +++ b/tests/Model/ReplyToEmailOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ReplyToEmailOptions' { + Context 'ReplyToEmailOptions' { + It 'Initialize-ReplyToEmailOptions' { + # a simple test to create an object + #$NewObject = Initialize-ReplyToEmailOptions -Body "TEST_VALUE" -IsHTML "TEST_VALUE" -VarFrom "TEST_VALUE" -ReplyTo "TEST_VALUE" -CustomHeaders "TEST_VALUE" -Charset "TEST_VALUE" -Attachments "TEST_VALUE" -TemplateVariables "TEST_VALUE" -Template "TEST_VALUE" -SendStrategy "TEST_VALUE" -UseInboxName "TEST_VALUE" -Html "TEST_VALUE" + #$NewObject | Should -BeOfType ReplyToEmailOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ScheduledJob.Tests.ps1 b/tests/Model/ScheduledJob.Tests.ps1 new file mode 100644 index 00000000..f1140445 --- /dev/null +++ b/tests/Model/ScheduledJob.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ScheduledJob' { + Context 'ScheduledJob' { + It 'Initialize-ScheduledJob' { + # a simple test to create an object + #$NewObject = Initialize-ScheduledJob -Id "TEST_VALUE" -UserId "TEST_VALUE" -InboxId "TEST_VALUE" -JobId "TEST_VALUE" -GroupId "TEST_VALUE" -TriggerId "TEST_VALUE" -Status "TEST_VALUE" -SendAtTimestamp "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType ScheduledJob + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ScheduledJobDto.Tests.ps1 b/tests/Model/ScheduledJobDto.Tests.ps1 new file mode 100644 index 00000000..24fac8ca --- /dev/null +++ b/tests/Model/ScheduledJobDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ScheduledJobDto' { + Context 'ScheduledJobDto' { + It 'Initialize-ScheduledJobDto' { + # a simple test to create an object + #$NewObject = Initialize-ScheduledJobDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -InboxId "TEST_VALUE" -JobId "TEST_VALUE" -GroupId "TEST_VALUE" -TriggerId "TEST_VALUE" -Status "TEST_VALUE" -SendAtTimestamp "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType ScheduledJobDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SearchEmailsOptions.Tests.ps1 b/tests/Model/SearchEmailsOptions.Tests.ps1 new file mode 100644 index 00000000..2912659c --- /dev/null +++ b/tests/Model/SearchEmailsOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SearchEmailsOptions' { + Context 'SearchEmailsOptions' { + It 'Initialize-SearchEmailsOptions' { + # a simple test to create an object + #$NewObject = Initialize-SearchEmailsOptions -InboxIds "TEST_VALUE" -PageIndex "TEST_VALUE" -PageSize "TEST_VALUE" -SortDirection "TEST_VALUE" -UnreadOnly "TEST_VALUE" -SearchFilter "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$NewObject | Should -BeOfType SearchEmailsOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SearchInboxesOptions.Tests.ps1 b/tests/Model/SearchInboxesOptions.Tests.ps1 new file mode 100644 index 00000000..2fb08ceb --- /dev/null +++ b/tests/Model/SearchInboxesOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SearchInboxesOptions' { + Context 'SearchInboxesOptions' { + It 'Initialize-SearchInboxesOptions' { + # a simple test to create an object + #$NewObject = Initialize-SearchInboxesOptions -PageIndex "TEST_VALUE" -PageSize "TEST_VALUE" -SortDirection "TEST_VALUE" -Favourite "TEST_VALUE" -Search "TEST_VALUE" -Tag "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" -InboxType "TEST_VALUE" -InboxFunction "TEST_VALUE" -DomainId "TEST_VALUE" + #$NewObject | Should -BeOfType SearchInboxesOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SendEmailBodyPart.Tests.ps1 b/tests/Model/SendEmailBodyPart.Tests.ps1 new file mode 100644 index 00000000..b9bab7ea --- /dev/null +++ b/tests/Model/SendEmailBodyPart.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SendEmailBodyPart' { + Context 'SendEmailBodyPart' { + It 'Initialize-SendEmailBodyPart' { + # a simple test to create an object + #$NewObject = Initialize-SendEmailBodyPart -ContentType "TEST_VALUE" -ContentBody "TEST_VALUE" + #$NewObject | Should -BeOfType SendEmailBodyPart + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SendEmailOptions.Tests.ps1 b/tests/Model/SendEmailOptions.Tests.ps1 new file mode 100644 index 00000000..3eca7ba2 --- /dev/null +++ b/tests/Model/SendEmailOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SendEmailOptions' { + Context 'SendEmailOptions' { + It 'Initialize-SendEmailOptions' { + # a simple test to create an object + #$NewObject = Initialize-SendEmailOptions -ToContacts "TEST_VALUE" -ToGroup "TEST_VALUE" -To "TEST_VALUE" -VarFrom "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" -Subject "TEST_VALUE" -ReplyTo "TEST_VALUE" -CustomHeaders "TEST_VALUE" -Body "TEST_VALUE" -Html "TEST_VALUE" -IsHTML "TEST_VALUE" -Charset "TEST_VALUE" -Attachments "TEST_VALUE" -TemplateVariables "TEST_VALUE" -Template "TEST_VALUE" -SendStrategy "TEST_VALUE" -UseInboxName "TEST_VALUE" -AddTrackingPixel "TEST_VALUE" -FilterBouncedRecipients "TEST_VALUE" -ValidateEmailAddresses "TEST_VALUE" -IgnoreEmptyRecipients "TEST_VALUE" -IsXAmpHtml "TEST_VALUE" -BodyParts "TEST_VALUE" + #$NewObject | Should -BeOfType SendEmailOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SendSMTPEnvelopeOptions.Tests.ps1 b/tests/Model/SendSMTPEnvelopeOptions.Tests.ps1 new file mode 100644 index 00000000..472c56c5 --- /dev/null +++ b/tests/Model/SendSMTPEnvelopeOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SendSMTPEnvelopeOptions' { + Context 'SendSMTPEnvelopeOptions' { + It 'Initialize-SendSMTPEnvelopeOptions' { + # a simple test to create an object + #$NewObject = Initialize-SendSMTPEnvelopeOptions -RcptTo "TEST_VALUE" -MailFrom "TEST_VALUE" -VarData "TEST_VALUE" + #$NewObject | Should -BeOfType SendSMTPEnvelopeOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SendWithQueueResult.Tests.ps1 b/tests/Model/SendWithQueueResult.Tests.ps1 new file mode 100644 index 00000000..ad7e120d --- /dev/null +++ b/tests/Model/SendWithQueueResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SendWithQueueResult' { + Context 'SendWithQueueResult' { + It 'Initialize-SendWithQueueResult' { + # a simple test to create an object + #$NewObject = Initialize-SendWithQueueResult -Id "TEST_VALUE" -UserId "TEST_VALUE" -Subject "TEST_VALUE" -InboxId "TEST_VALUE" -HeaderId "TEST_VALUE" -Delivered "TEST_VALUE" -ExceptionName "TEST_VALUE" -Message "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType SendWithQueueResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SentEmailDto.Tests.ps1 b/tests/Model/SentEmailDto.Tests.ps1 new file mode 100644 index 00000000..4cf3d817 --- /dev/null +++ b/tests/Model/SentEmailDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SentEmailDto' { + Context 'SentEmailDto' { + It 'Initialize-SentEmailDto' { + # a simple test to create an object + #$NewObject = Initialize-SentEmailDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -InboxId "TEST_VALUE" -DomainId "TEST_VALUE" -To "TEST_VALUE" -VarFrom "TEST_VALUE" -ReplyTo "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" -Attachments "TEST_VALUE" -Subject "TEST_VALUE" -BodyMD5Hash "TEST_VALUE" -Body "TEST_VALUE" -ToContacts "TEST_VALUE" -ToGroup "TEST_VALUE" -Charset "TEST_VALUE" -IsHTML "TEST_VALUE" -SentAt "TEST_VALUE" -PixelIds "TEST_VALUE" -MessageId "TEST_VALUE" -MessageIds "TEST_VALUE" -VirtualSend "TEST_VALUE" -TemplateId "TEST_VALUE" -TemplateVariables "TEST_VALUE" -Headers "TEST_VALUE" -Html "TEST_VALUE" + #$NewObject | Should -BeOfType SentEmailDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SentEmailProjection.Tests.ps1 b/tests/Model/SentEmailProjection.Tests.ps1 new file mode 100644 index 00000000..be528618 --- /dev/null +++ b/tests/Model/SentEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SentEmailProjection' { + Context 'SentEmailProjection' { + It 'Initialize-SentEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-SentEmailProjection -Id "TEST_VALUE" -VarFrom "TEST_VALUE" -Subject "TEST_VALUE" -Attachments "TEST_VALUE" -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -To "TEST_VALUE" -Bcc "TEST_VALUE" -Cc "TEST_VALUE" -CreatedAt "TEST_VALUE" -BodyMD5Hash "TEST_VALUE" -VirtualSend "TEST_VALUE" + #$NewObject | Should -BeOfType SentEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SentSmsDto.Tests.ps1 b/tests/Model/SentSmsDto.Tests.ps1 new file mode 100644 index 00000000..26345f71 --- /dev/null +++ b/tests/Model/SentSmsDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SentSmsDto' { + Context 'SentSmsDto' { + It 'Initialize-SentSmsDto' { + # a simple test to create an object + #$NewObject = Initialize-SentSmsDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -PhoneNumber "TEST_VALUE" -FromNumber "TEST_VALUE" -ToNumber "TEST_VALUE" -Body "TEST_VALUE" -Sid "TEST_VALUE" -ReplyToSid "TEST_VALUE" -ReplyToId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType SentSmsDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ServerEndpoints.Tests.ps1 b/tests/Model/ServerEndpoints.Tests.ps1 new file mode 100644 index 00000000..60b0c40c --- /dev/null +++ b/tests/Model/ServerEndpoints.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ServerEndpoints' { + Context 'ServerEndpoints' { + It 'Initialize-ServerEndpoints' { + # a simple test to create an object + #$NewObject = Initialize-ServerEndpoints -VarHost "TEST_VALUE" -Port "TEST_VALUE" -Tls "TEST_VALUE" -AltPorts "TEST_VALUE" + #$NewObject | Should -BeOfType ServerEndpoints + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SetInboxFavouritedOptions.Tests.ps1 b/tests/Model/SetInboxFavouritedOptions.Tests.ps1 new file mode 100644 index 00000000..4e5456bb --- /dev/null +++ b/tests/Model/SetInboxFavouritedOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SetInboxFavouritedOptions' { + Context 'SetInboxFavouritedOptions' { + It 'Initialize-SetInboxFavouritedOptions' { + # a simple test to create an object + #$NewObject = Initialize-SetInboxFavouritedOptions -State "TEST_VALUE" + #$NewObject | Should -BeOfType SetInboxFavouritedOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SimpleSendEmailOptions.Tests.ps1 b/tests/Model/SimpleSendEmailOptions.Tests.ps1 new file mode 100644 index 00000000..351b9e5f --- /dev/null +++ b/tests/Model/SimpleSendEmailOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SimpleSendEmailOptions' { + Context 'SimpleSendEmailOptions' { + It 'Initialize-SimpleSendEmailOptions' { + # a simple test to create an object + #$NewObject = Initialize-SimpleSendEmailOptions -SenderId "TEST_VALUE" -To "TEST_VALUE" -Body "TEST_VALUE" -Subject "TEST_VALUE" + #$NewObject | Should -BeOfType SimpleSendEmailOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SmsDto.Tests.ps1 b/tests/Model/SmsDto.Tests.ps1 new file mode 100644 index 00000000..46972add --- /dev/null +++ b/tests/Model/SmsDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmsDto' { + Context 'SmsDto' { + It 'Initialize-SmsDto' { + # a simple test to create an object + #$NewObject = Initialize-SmsDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -PhoneNumber "TEST_VALUE" -FromNumber "TEST_VALUE" -Body "TEST_VALUE" -Read "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType SmsDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SmsMatchOption.Tests.ps1 b/tests/Model/SmsMatchOption.Tests.ps1 new file mode 100644 index 00000000..8ae6e938 --- /dev/null +++ b/tests/Model/SmsMatchOption.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmsMatchOption' { + Context 'SmsMatchOption' { + It 'Initialize-SmsMatchOption' { + # a simple test to create an object + #$NewObject = Initialize-SmsMatchOption -Field "TEST_VALUE" -Should "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType SmsMatchOption + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SmsPreview.Tests.ps1 b/tests/Model/SmsPreview.Tests.ps1 new file mode 100644 index 00000000..4f5965eb --- /dev/null +++ b/tests/Model/SmsPreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmsPreview' { + Context 'SmsPreview' { + It 'Initialize-SmsPreview' { + # a simple test to create an object + #$NewObject = Initialize-SmsPreview -Id "TEST_VALUE" -UserId "TEST_VALUE" -Body "TEST_VALUE" -PhoneNumber "TEST_VALUE" -FromNumber "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType SmsPreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SmsProjection.Tests.ps1 b/tests/Model/SmsProjection.Tests.ps1 new file mode 100644 index 00000000..ded6b89b --- /dev/null +++ b/tests/Model/SmsProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmsProjection' { + Context 'SmsProjection' { + It 'Initialize-SmsProjection' { + # a simple test to create an object + #$NewObject = Initialize-SmsProjection -UserId "TEST_VALUE" -PhoneNumber "TEST_VALUE" -FromNumber "TEST_VALUE" -Read "TEST_VALUE" -Body "TEST_VALUE" -CreatedAt "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType SmsProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SmsReplyOptions.Tests.ps1 b/tests/Model/SmsReplyOptions.Tests.ps1 new file mode 100644 index 00000000..518a007d --- /dev/null +++ b/tests/Model/SmsReplyOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmsReplyOptions' { + Context 'SmsReplyOptions' { + It 'Initialize-SmsReplyOptions' { + # a simple test to create an object + #$NewObject = Initialize-SmsReplyOptions -Body "TEST_VALUE" + #$NewObject | Should -BeOfType SmsReplyOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SmtpAccessDetails.Tests.ps1 b/tests/Model/SmtpAccessDetails.Tests.ps1 new file mode 100644 index 00000000..87e7984f --- /dev/null +++ b/tests/Model/SmtpAccessDetails.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SmtpAccessDetails' { + Context 'SmtpAccessDetails' { + It 'Initialize-SmtpAccessDetails' { + # a simple test to create an object + #$NewObject = Initialize-SmtpAccessDetails -SecureSmtpServerHost "TEST_VALUE" -SecureSmtpServerPort "TEST_VALUE" -SecureSmtpUsername "TEST_VALUE" -SecureSmtpPassword "TEST_VALUE" -SmtpServerHost "TEST_VALUE" -SmtpServerPort "TEST_VALUE" -SmtpUsername "TEST_VALUE" -SmtpPassword "TEST_VALUE" -MailFromDomain "TEST_VALUE" + #$NewObject | Should -BeOfType SmtpAccessDetails + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SortObject.Tests.ps1 b/tests/Model/SortObject.Tests.ps1 new file mode 100644 index 00000000..15ee8ec1 --- /dev/null +++ b/tests/Model/SortObject.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SortObject' { + Context 'SortObject' { + It 'Initialize-SortObject' { + # a simple test to create an object + #$NewObject = Initialize-SortObject -Sorted "TEST_VALUE" -Unsorted "TEST_VALUE" -Empty "TEST_VALUE" + #$NewObject | Should -BeOfType SortObject + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/SpellingIssue.Tests.ps1 b/tests/Model/SpellingIssue.Tests.ps1 new file mode 100644 index 00000000..3f3a6461 --- /dev/null +++ b/tests/Model/SpellingIssue.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'SpellingIssue' { + Context 'SpellingIssue' { + It 'Initialize-SpellingIssue' { + # a simple test to create an object + #$NewObject = Initialize-SpellingIssue -Group "TEST_VALUE" -Suggestion "TEST_VALUE" -Severity "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType SpellingIssue + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TemplateDto.Tests.ps1 b/tests/Model/TemplateDto.Tests.ps1 new file mode 100644 index 00000000..b2f1d5aa --- /dev/null +++ b/tests/Model/TemplateDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TemplateDto' { + Context 'TemplateDto' { + It 'Initialize-TemplateDto' { + # a simple test to create an object + #$NewObject = Initialize-TemplateDto -Id "TEST_VALUE" -Name "TEST_VALUE" -Variables "TEST_VALUE" -Content "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType TemplateDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TemplatePreview.Tests.ps1 b/tests/Model/TemplatePreview.Tests.ps1 new file mode 100644 index 00000000..880b1c6c --- /dev/null +++ b/tests/Model/TemplatePreview.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TemplatePreview' { + Context 'TemplatePreview' { + It 'Initialize-TemplatePreview' { + # a simple test to create an object + #$NewObject = Initialize-TemplatePreview -Preview "TEST_VALUE" + #$NewObject | Should -BeOfType TemplatePreview + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TemplateProjection.Tests.ps1 b/tests/Model/TemplateProjection.Tests.ps1 new file mode 100644 index 00000000..ccb9bb60 --- /dev/null +++ b/tests/Model/TemplateProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TemplateProjection' { + Context 'TemplateProjection' { + It 'Initialize-TemplateProjection' { + # a simple test to create an object + #$NewObject = Initialize-TemplateProjection -Variables "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType TemplateProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TemplateVariable.Tests.ps1 b/tests/Model/TemplateVariable.Tests.ps1 new file mode 100644 index 00000000..d5f0f768 --- /dev/null +++ b/tests/Model/TemplateVariable.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TemplateVariable' { + Context 'TemplateVariable' { + It 'Initialize-TemplateVariable' { + # a simple test to create an object + #$NewObject = Initialize-TemplateVariable -Name "TEST_VALUE" -VariableType "TEST_VALUE" + #$NewObject | Should -BeOfType TemplateVariable + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestInboxRulesetReceivingOptions.Tests.ps1 b/tests/Model/TestInboxRulesetReceivingOptions.Tests.ps1 new file mode 100644 index 00000000..7630ad1b --- /dev/null +++ b/tests/Model/TestInboxRulesetReceivingOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestInboxRulesetReceivingOptions' { + Context 'TestInboxRulesetReceivingOptions' { + It 'Initialize-TestInboxRulesetReceivingOptions' { + # a simple test to create an object + #$NewObject = Initialize-TestInboxRulesetReceivingOptions -InboxId "TEST_VALUE" -FromSender "TEST_VALUE" + #$NewObject | Should -BeOfType TestInboxRulesetReceivingOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestInboxRulesetReceivingResult.Tests.ps1 b/tests/Model/TestInboxRulesetReceivingResult.Tests.ps1 new file mode 100644 index 00000000..3ee72a81 --- /dev/null +++ b/tests/Model/TestInboxRulesetReceivingResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestInboxRulesetReceivingResult' { + Context 'TestInboxRulesetReceivingResult' { + It 'Initialize-TestInboxRulesetReceivingResult' { + # a simple test to create an object + #$NewObject = Initialize-TestInboxRulesetReceivingResult -CanReceive "TEST_VALUE" + #$NewObject | Should -BeOfType TestInboxRulesetReceivingResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestInboxRulesetSendingOptions.Tests.ps1 b/tests/Model/TestInboxRulesetSendingOptions.Tests.ps1 new file mode 100644 index 00000000..09c91ebf --- /dev/null +++ b/tests/Model/TestInboxRulesetSendingOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestInboxRulesetSendingOptions' { + Context 'TestInboxRulesetSendingOptions' { + It 'Initialize-TestInboxRulesetSendingOptions' { + # a simple test to create an object + #$NewObject = Initialize-TestInboxRulesetSendingOptions -InboxId "TEST_VALUE" -Recipient "TEST_VALUE" + #$NewObject | Should -BeOfType TestInboxRulesetSendingOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestInboxRulesetSendingResult.Tests.ps1 b/tests/Model/TestInboxRulesetSendingResult.Tests.ps1 new file mode 100644 index 00000000..f2e24063 --- /dev/null +++ b/tests/Model/TestInboxRulesetSendingResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestInboxRulesetSendingResult' { + Context 'TestInboxRulesetSendingResult' { + It 'Initialize-TestInboxRulesetSendingResult' { + # a simple test to create an object + #$NewObject = Initialize-TestInboxRulesetSendingResult -CanSend "TEST_VALUE" + #$NewObject | Should -BeOfType TestInboxRulesetSendingResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestNewInboxForwarderOptions.Tests.ps1 b/tests/Model/TestNewInboxForwarderOptions.Tests.ps1 new file mode 100644 index 00000000..7d7c3986 --- /dev/null +++ b/tests/Model/TestNewInboxForwarderOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestNewInboxForwarderOptions' { + Context 'TestNewInboxForwarderOptions' { + It 'Initialize-TestNewInboxForwarderOptions' { + # a simple test to create an object + #$NewObject = Initialize-TestNewInboxForwarderOptions -InboxForwarderTestOptions "TEST_VALUE" -CreateInboxForwarderOptions "TEST_VALUE" + #$NewObject | Should -BeOfType TestNewInboxForwarderOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestNewInboxRulesetOptions.Tests.ps1 b/tests/Model/TestNewInboxRulesetOptions.Tests.ps1 new file mode 100644 index 00000000..e254d85c --- /dev/null +++ b/tests/Model/TestNewInboxRulesetOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestNewInboxRulesetOptions' { + Context 'TestNewInboxRulesetOptions' { + It 'Initialize-TestNewInboxRulesetOptions' { + # a simple test to create an object + #$NewObject = Initialize-TestNewInboxRulesetOptions -InboxRulesetTestOptions "TEST_VALUE" -CreateInboxRulesetOptions "TEST_VALUE" + #$NewObject | Should -BeOfType TestNewInboxRulesetOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TestPhoneNumberOptions.Tests.ps1 b/tests/Model/TestPhoneNumberOptions.Tests.ps1 new file mode 100644 index 00000000..5cf970f5 --- /dev/null +++ b/tests/Model/TestPhoneNumberOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TestPhoneNumberOptions' { + Context 'TestPhoneNumberOptions' { + It 'Initialize-TestPhoneNumberOptions' { + # a simple test to create an object + #$NewObject = Initialize-TestPhoneNumberOptions -Message "TEST_VALUE" + #$NewObject | Should -BeOfType TestPhoneNumberOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ThreadProjection.Tests.ps1 b/tests/Model/ThreadProjection.Tests.ps1 new file mode 100644 index 00000000..aa554448 --- /dev/null +++ b/tests/Model/ThreadProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ThreadProjection' { + Context 'ThreadProjection' { + It 'Initialize-ThreadProjection' { + # a simple test to create an object + #$NewObject = Initialize-ThreadProjection -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -To "TEST_VALUE" -Bcc "TEST_VALUE" -Cc "TEST_VALUE" -AliasId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Subject "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType ThreadProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TrackingPixelDto.Tests.ps1 b/tests/Model/TrackingPixelDto.Tests.ps1 new file mode 100644 index 00000000..062a0f2a --- /dev/null +++ b/tests/Model/TrackingPixelDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TrackingPixelDto' { + Context 'TrackingPixelDto' { + It 'Initialize-TrackingPixelDto' { + # a simple test to create an object + #$NewObject = Initialize-TrackingPixelDto -Id "TEST_VALUE" -Seen "TEST_VALUE" -Recipient "TEST_VALUE" -Html "TEST_VALUE" -Url "TEST_VALUE" -InboxId "TEST_VALUE" -SentEmailId "TEST_VALUE" -SeenAt "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType TrackingPixelDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/TrackingPixelProjection.Tests.ps1 b/tests/Model/TrackingPixelProjection.Tests.ps1 new file mode 100644 index 00000000..20a83730 --- /dev/null +++ b/tests/Model/TrackingPixelProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'TrackingPixelProjection' { + Context 'TrackingPixelProjection' { + It 'Initialize-TrackingPixelProjection' { + # a simple test to create an object + #$NewObject = Initialize-TrackingPixelProjection -InboxId "TEST_VALUE" -UserId "TEST_VALUE" -SentEmailId "TEST_VALUE" -Recipient "TEST_VALUE" -Seen "TEST_VALUE" -SeenAt "TEST_VALUE" -CreatedAt "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType TrackingPixelProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UnknownMissedEmailProjection.Tests.ps1 b/tests/Model/UnknownMissedEmailProjection.Tests.ps1 new file mode 100644 index 00000000..cb8a5591 --- /dev/null +++ b/tests/Model/UnknownMissedEmailProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UnknownMissedEmailProjection' { + Context 'UnknownMissedEmailProjection' { + It 'Initialize-UnknownMissedEmailProjection' { + # a simple test to create an object + #$NewObject = Initialize-UnknownMissedEmailProjection -To "TEST_VALUE" -CreatedAt "TEST_VALUE" -Subject "TEST_VALUE" -Id "TEST_VALUE" -VarFrom "TEST_VALUE" + #$NewObject | Should -BeOfType UnknownMissedEmailProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UnreadCount.Tests.ps1 b/tests/Model/UnreadCount.Tests.ps1 new file mode 100644 index 00000000..725f1366 --- /dev/null +++ b/tests/Model/UnreadCount.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UnreadCount' { + Context 'UnreadCount' { + It 'Initialize-UnreadCount' { + # a simple test to create an object + #$NewObject = Initialize-UnreadCount -Count "TEST_VALUE" + #$NewObject | Should -BeOfType UnreadCount + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UnseenErrorCountDto.Tests.ps1 b/tests/Model/UnseenErrorCountDto.Tests.ps1 new file mode 100644 index 00000000..6aba941b --- /dev/null +++ b/tests/Model/UnseenErrorCountDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UnseenErrorCountDto' { + Context 'UnseenErrorCountDto' { + It 'Initialize-UnseenErrorCountDto' { + # a simple test to create an object + #$NewObject = Initialize-UnseenErrorCountDto -Count "TEST_VALUE" + #$NewObject | Should -BeOfType UnseenErrorCountDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateAliasOptions.Tests.ps1 b/tests/Model/UpdateAliasOptions.Tests.ps1 new file mode 100644 index 00000000..8f709450 --- /dev/null +++ b/tests/Model/UpdateAliasOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateAliasOptions' { + Context 'UpdateAliasOptions' { + It 'Initialize-UpdateAliasOptions' { + # a simple test to create an object + #$NewObject = Initialize-UpdateAliasOptions -Name "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateAliasOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateDomainOptions.Tests.ps1 b/tests/Model/UpdateDomainOptions.Tests.ps1 new file mode 100644 index 00000000..1ff658f7 --- /dev/null +++ b/tests/Model/UpdateDomainOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateDomainOptions' { + Context 'UpdateDomainOptions' { + It 'Initialize-UpdateDomainOptions' { + # a simple test to create an object + #$NewObject = Initialize-UpdateDomainOptions -CatchAllInboxId "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateDomainOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateGroupContacts.Tests.ps1 b/tests/Model/UpdateGroupContacts.Tests.ps1 new file mode 100644 index 00000000..7d5e90f1 --- /dev/null +++ b/tests/Model/UpdateGroupContacts.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateGroupContacts' { + Context 'UpdateGroupContacts' { + It 'Initialize-UpdateGroupContacts' { + # a simple test to create an object + #$NewObject = Initialize-UpdateGroupContacts -ContactIds "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateGroupContacts + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateImapAccessOptions.Tests.ps1 b/tests/Model/UpdateImapAccessOptions.Tests.ps1 new file mode 100644 index 00000000..ba686762 --- /dev/null +++ b/tests/Model/UpdateImapAccessOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateImapAccessOptions' { + Context 'UpdateImapAccessOptions' { + It 'Initialize-UpdateImapAccessOptions' { + # a simple test to create an object + #$NewObject = Initialize-UpdateImapAccessOptions -ImapUsername "TEST_VALUE" -ImapPassword "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateImapAccessOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateInboxOptions.Tests.ps1 b/tests/Model/UpdateInboxOptions.Tests.ps1 new file mode 100644 index 00000000..4b1e9fb0 --- /dev/null +++ b/tests/Model/UpdateInboxOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateInboxOptions' { + Context 'UpdateInboxOptions' { + It 'Initialize-UpdateInboxOptions' { + # a simple test to create an object + #$NewObject = Initialize-UpdateInboxOptions -Name "TEST_VALUE" -Description "TEST_VALUE" -Tags "TEST_VALUE" -ExpiresAt "TEST_VALUE" -Favourite "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateInboxOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateInboxReplierOptions.Tests.ps1 b/tests/Model/UpdateInboxReplierOptions.Tests.ps1 new file mode 100644 index 00000000..73281dc6 --- /dev/null +++ b/tests/Model/UpdateInboxReplierOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateInboxReplierOptions' { + Context 'UpdateInboxReplierOptions' { + It 'Initialize-UpdateInboxReplierOptions' { + # a simple test to create an object + #$NewObject = Initialize-UpdateInboxReplierOptions -InboxId "TEST_VALUE" -Name "TEST_VALUE" -Field "TEST_VALUE" -Match "TEST_VALUE" -ReplyTo "TEST_VALUE" -Subject "TEST_VALUE" -VarFrom "TEST_VALUE" -Charset "TEST_VALUE" -IsHTML "TEST_VALUE" -IgnoreReplyTo "TEST_VALUE" -Body "TEST_VALUE" -TemplateId "TEST_VALUE" -TemplateVariables "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateInboxReplierOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UpdateSmtpAccessOptions.Tests.ps1 b/tests/Model/UpdateSmtpAccessOptions.Tests.ps1 new file mode 100644 index 00000000..3a6a6d6a --- /dev/null +++ b/tests/Model/UpdateSmtpAccessOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UpdateSmtpAccessOptions' { + Context 'UpdateSmtpAccessOptions' { + It 'Initialize-UpdateSmtpAccessOptions' { + # a simple test to create an object + #$NewObject = Initialize-UpdateSmtpAccessOptions -SmtpUsername "TEST_VALUE" -SmtpPassword "TEST_VALUE" + #$NewObject | Should -BeOfType UpdateSmtpAccessOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UploadAttachmentOptions.Tests.ps1 b/tests/Model/UploadAttachmentOptions.Tests.ps1 new file mode 100644 index 00000000..66640a64 --- /dev/null +++ b/tests/Model/UploadAttachmentOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UploadAttachmentOptions' { + Context 'UploadAttachmentOptions' { + It 'Initialize-UploadAttachmentOptions' { + # a simple test to create an object + #$NewObject = Initialize-UploadAttachmentOptions -ContentId "TEST_VALUE" -ContentType "TEST_VALUE" -Filename "TEST_VALUE" -Base64Contents "TEST_VALUE" + #$NewObject | Should -BeOfType UploadAttachmentOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/UserInfoDto.Tests.ps1 b/tests/Model/UserInfoDto.Tests.ps1 new file mode 100644 index 00000000..f3d277a0 --- /dev/null +++ b/tests/Model/UserInfoDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'UserInfoDto' { + Context 'UserInfoDto' { + It 'Initialize-UserInfoDto' { + # a simple test to create an object + #$NewObject = Initialize-UserInfoDto -Id "TEST_VALUE" -EmailAddress "TEST_VALUE" -AccountState "TEST_VALUE" -SubscriptionType "TEST_VALUE" -AccountType "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType UserInfoDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ValidateEmailAddressListOptions.Tests.ps1 b/tests/Model/ValidateEmailAddressListOptions.Tests.ps1 new file mode 100644 index 00000000..f308826e --- /dev/null +++ b/tests/Model/ValidateEmailAddressListOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ValidateEmailAddressListOptions' { + Context 'ValidateEmailAddressListOptions' { + It 'Initialize-ValidateEmailAddressListOptions' { + # a simple test to create an object + #$NewObject = Initialize-ValidateEmailAddressListOptions -EmailAddressList "TEST_VALUE" -IgnoreOldResults "TEST_VALUE" + #$NewObject | Should -BeOfType ValidateEmailAddressListOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ValidateEmailAddressListResult.Tests.ps1 b/tests/Model/ValidateEmailAddressListResult.Tests.ps1 new file mode 100644 index 00000000..88f45377 --- /dev/null +++ b/tests/Model/ValidateEmailAddressListResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ValidateEmailAddressListResult' { + Context 'ValidateEmailAddressListResult' { + It 'Initialize-ValidateEmailAddressListResult' { + # a simple test to create an object + #$NewObject = Initialize-ValidateEmailAddressListResult -ValidEmailAddresses "TEST_VALUE" -InvalidEmailAddresses "TEST_VALUE" -ResultMapEmailAddressIsValid "TEST_VALUE" + #$NewObject | Should -BeOfType ValidateEmailAddressListResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ValidationDto.Tests.ps1 b/tests/Model/ValidationDto.Tests.ps1 new file mode 100644 index 00000000..5ba2eae1 --- /dev/null +++ b/tests/Model/ValidationDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ValidationDto' { + Context 'ValidationDto' { + It 'Initialize-ValidationDto' { + # a simple test to create an object + #$NewObject = Initialize-ValidationDto -EmailId "TEST_VALUE" -Html "TEST_VALUE" + #$NewObject | Should -BeOfType ValidationDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/ValidationMessage.Tests.ps1 b/tests/Model/ValidationMessage.Tests.ps1 new file mode 100644 index 00000000..a9fd44d5 --- /dev/null +++ b/tests/Model/ValidationMessage.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'ValidationMessage' { + Context 'ValidationMessage' { + It 'Initialize-ValidationMessage' { + # a simple test to create an object + #$NewObject = Initialize-ValidationMessage -LineNumber "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType ValidationMessage + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/VerifyEmailAddressOptions.Tests.ps1 b/tests/Model/VerifyEmailAddressOptions.Tests.ps1 new file mode 100644 index 00000000..8b7d8389 --- /dev/null +++ b/tests/Model/VerifyEmailAddressOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'VerifyEmailAddressOptions' { + Context 'VerifyEmailAddressOptions' { + It 'Initialize-VerifyEmailAddressOptions' { + # a simple test to create an object + #$NewObject = Initialize-VerifyEmailAddressOptions -MailServerDomain "TEST_VALUE" -EmailAddress "TEST_VALUE" -SenderEmailAddress "TEST_VALUE" -Port "TEST_VALUE" + #$NewObject | Should -BeOfType VerifyEmailAddressOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/VerifyWebhookSignatureOptions.Tests.ps1 b/tests/Model/VerifyWebhookSignatureOptions.Tests.ps1 new file mode 100644 index 00000000..8dd4971c --- /dev/null +++ b/tests/Model/VerifyWebhookSignatureOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'VerifyWebhookSignatureOptions' { + Context 'VerifyWebhookSignatureOptions' { + It 'Initialize-VerifyWebhookSignatureOptions' { + # a simple test to create an object + #$NewObject = Initialize-VerifyWebhookSignatureOptions -MessageId "TEST_VALUE" -Signature "TEST_VALUE" + #$NewObject | Should -BeOfType VerifyWebhookSignatureOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/VerifyWebhookSignatureResults.Tests.ps1 b/tests/Model/VerifyWebhookSignatureResults.Tests.ps1 new file mode 100644 index 00000000..a2009cdf --- /dev/null +++ b/tests/Model/VerifyWebhookSignatureResults.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'VerifyWebhookSignatureResults' { + Context 'VerifyWebhookSignatureResults' { + It 'Initialize-VerifyWebhookSignatureResults' { + # a simple test to create an object + #$NewObject = Initialize-VerifyWebhookSignatureResults -IsValid "TEST_VALUE" + #$NewObject | Should -BeOfType VerifyWebhookSignatureResults + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WaitForConditions.Tests.ps1 b/tests/Model/WaitForConditions.Tests.ps1 new file mode 100644 index 00000000..80f2d9b7 --- /dev/null +++ b/tests/Model/WaitForConditions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WaitForConditions' { + Context 'WaitForConditions' { + It 'Initialize-WaitForConditions' { + # a simple test to create an object + #$NewObject = Initialize-WaitForConditions -InboxId "TEST_VALUE" -Count "TEST_VALUE" -DelayTimeout "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -CountType "TEST_VALUE" -VarMatches "TEST_VALUE" -SortDirection "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$NewObject | Should -BeOfType WaitForConditions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WaitForSingleSmsOptions.Tests.ps1 b/tests/Model/WaitForSingleSmsOptions.Tests.ps1 new file mode 100644 index 00000000..903d1ef5 --- /dev/null +++ b/tests/Model/WaitForSingleSmsOptions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WaitForSingleSmsOptions' { + Context 'WaitForSingleSmsOptions' { + It 'Initialize-WaitForSingleSmsOptions' { + # a simple test to create an object + #$NewObject = Initialize-WaitForSingleSmsOptions -PhoneNumberId "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -Before "TEST_VALUE" -Since "TEST_VALUE" -SortDirection "TEST_VALUE" -Delay "TEST_VALUE" + #$NewObject | Should -BeOfType WaitForSingleSmsOptions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WaitForSmsConditions.Tests.ps1 b/tests/Model/WaitForSmsConditions.Tests.ps1 new file mode 100644 index 00000000..63bebee7 --- /dev/null +++ b/tests/Model/WaitForSmsConditions.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WaitForSmsConditions' { + Context 'WaitForSmsConditions' { + It 'Initialize-WaitForSmsConditions' { + # a simple test to create an object + #$NewObject = Initialize-WaitForSmsConditions -PhoneNumberId "TEST_VALUE" -Limit "TEST_VALUE" -Count "TEST_VALUE" -DelayTimeout "TEST_VALUE" -Timeout "TEST_VALUE" -UnreadOnly "TEST_VALUE" -CountType "TEST_VALUE" -VarMatches "TEST_VALUE" -SortDirection "TEST_VALUE" -Since "TEST_VALUE" -Before "TEST_VALUE" + #$NewObject | Should -BeOfType WaitForSmsConditions + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookBouncePayload.Tests.ps1 b/tests/Model/WebhookBouncePayload.Tests.ps1 new file mode 100644 index 00000000..de4f9cfd --- /dev/null +++ b/tests/Model/WebhookBouncePayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookBouncePayload' { + Context 'WebhookBouncePayload' { + It 'Initialize-WebhookBouncePayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookBouncePayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -BounceId "TEST_VALUE" -SentToRecipients "TEST_VALUE" -VarSender "TEST_VALUE" -BounceRecipients "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookBouncePayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookBounceRecipientPayload.Tests.ps1 b/tests/Model/WebhookBounceRecipientPayload.Tests.ps1 new file mode 100644 index 00000000..a742f1b7 --- /dev/null +++ b/tests/Model/WebhookBounceRecipientPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookBounceRecipientPayload' { + Context 'WebhookBounceRecipientPayload' { + It 'Initialize-WebhookBounceRecipientPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookBounceRecipientPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -Recipient "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookBounceRecipientPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookDeliveryStatusPayload.Tests.ps1 b/tests/Model/WebhookDeliveryStatusPayload.Tests.ps1 new file mode 100644 index 00000000..fce05562 --- /dev/null +++ b/tests/Model/WebhookDeliveryStatusPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookDeliveryStatusPayload' { + Context 'WebhookDeliveryStatusPayload' { + It 'Initialize-WebhookDeliveryStatusPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookDeliveryStatusPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -Id "TEST_VALUE" -UserId "TEST_VALUE" -SentId "TEST_VALUE" -RemoteMtaIp "TEST_VALUE" -InboxId "TEST_VALUE" -ReportingMta "TEST_VALUE" -Recipients "TEST_VALUE" -SmtpResponse "TEST_VALUE" -SmtpStatusCode "TEST_VALUE" -ProcessingTimeMillis "TEST_VALUE" -Received "TEST_VALUE" -Subject "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookDeliveryStatusPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookDto.Tests.ps1 b/tests/Model/WebhookDto.Tests.ps1 new file mode 100644 index 00000000..5d80adaa --- /dev/null +++ b/tests/Model/WebhookDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookDto' { + Context 'WebhookDto' { + It 'Initialize-WebhookDto' { + # a simple test to create an object + #$NewObject = Initialize-WebhookDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -BasicAuth "TEST_VALUE" -Name "TEST_VALUE" -PhoneId "TEST_VALUE" -InboxId "TEST_VALUE" -RequestBodyTemplate "TEST_VALUE" -Url "TEST_VALUE" -Method "TEST_VALUE" -PayloadJsonSchema "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -EventName "TEST_VALUE" -RequestHeaders "TEST_VALUE" -IgnoreInsecureSslCertificates "TEST_VALUE" -UseStaticIpRange "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookEmailOpenedPayload.Tests.ps1 b/tests/Model/WebhookEmailOpenedPayload.Tests.ps1 new file mode 100644 index 00000000..bb2c0a9d --- /dev/null +++ b/tests/Model/WebhookEmailOpenedPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookEmailOpenedPayload' { + Context 'WebhookEmailOpenedPayload' { + It 'Initialize-WebhookEmailOpenedPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookEmailOpenedPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -InboxId "TEST_VALUE" -PixelId "TEST_VALUE" -SentEmailId "TEST_VALUE" -Recipient "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookEmailOpenedPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookEmailReadPayload.Tests.ps1 b/tests/Model/WebhookEmailReadPayload.Tests.ps1 new file mode 100644 index 00000000..176dc31e --- /dev/null +++ b/tests/Model/WebhookEmailReadPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookEmailReadPayload' { + Context 'WebhookEmailReadPayload' { + It 'Initialize-WebhookEmailReadPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookEmailReadPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -EmailId "TEST_VALUE" -InboxId "TEST_VALUE" -EmailIsRead "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookEmailReadPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookHeaderNameValue.Tests.ps1 b/tests/Model/WebhookHeaderNameValue.Tests.ps1 new file mode 100644 index 00000000..edca7b76 --- /dev/null +++ b/tests/Model/WebhookHeaderNameValue.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookHeaderNameValue' { + Context 'WebhookHeaderNameValue' { + It 'Initialize-WebhookHeaderNameValue' { + # a simple test to create an object + #$NewObject = Initialize-WebhookHeaderNameValue -Name "TEST_VALUE" -Value "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookHeaderNameValue + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookHeaders.Tests.ps1 b/tests/Model/WebhookHeaders.Tests.ps1 new file mode 100644 index 00000000..3a4e3ef3 --- /dev/null +++ b/tests/Model/WebhookHeaders.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookHeaders' { + Context 'WebhookHeaders' { + It 'Initialize-WebhookHeaders' { + # a simple test to create an object + #$NewObject = Initialize-WebhookHeaders -Headers "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookHeaders + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookNewAttachmentPayload.Tests.ps1 b/tests/Model/WebhookNewAttachmentPayload.Tests.ps1 new file mode 100644 index 00000000..6e72dbdb --- /dev/null +++ b/tests/Model/WebhookNewAttachmentPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookNewAttachmentPayload' { + Context 'WebhookNewAttachmentPayload' { + It 'Initialize-WebhookNewAttachmentPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookNewAttachmentPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -WebhookName "TEST_VALUE" -EventName "TEST_VALUE" -AttachmentId "TEST_VALUE" -Name "TEST_VALUE" -ContentType "TEST_VALUE" -ContentLength "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookNewAttachmentPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookNewContactPayload.Tests.ps1 b/tests/Model/WebhookNewContactPayload.Tests.ps1 new file mode 100644 index 00000000..24033d46 --- /dev/null +++ b/tests/Model/WebhookNewContactPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookNewContactPayload' { + Context 'WebhookNewContactPayload' { + It 'Initialize-WebhookNewContactPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookNewContactPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -WebhookName "TEST_VALUE" -EventName "TEST_VALUE" -ContactId "TEST_VALUE" -GroupId "TEST_VALUE" -FirstName "TEST_VALUE" -LastName "TEST_VALUE" -Company "TEST_VALUE" -PrimaryEmailAddress "TEST_VALUE" -EmailAddresses "TEST_VALUE" -Tags "TEST_VALUE" -MetaData "TEST_VALUE" -OptOut "TEST_VALUE" -CreatedAt "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookNewContactPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookNewEmailPayload.Tests.ps1 b/tests/Model/WebhookNewEmailPayload.Tests.ps1 new file mode 100644 index 00000000..c6200f53 --- /dev/null +++ b/tests/Model/WebhookNewEmailPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookNewEmailPayload' { + Context 'WebhookNewEmailPayload' { + It 'Initialize-WebhookNewEmailPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookNewEmailPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -InboxId "TEST_VALUE" -DomainId "TEST_VALUE" -EmailId "TEST_VALUE" -CreatedAt "TEST_VALUE" -To "TEST_VALUE" -VarFrom "TEST_VALUE" -Cc "TEST_VALUE" -Bcc "TEST_VALUE" -Subject "TEST_VALUE" -AttachmentMetaDatas "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookNewEmailPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookNewSmsPayload.Tests.ps1 b/tests/Model/WebhookNewSmsPayload.Tests.ps1 new file mode 100644 index 00000000..46dea96f --- /dev/null +++ b/tests/Model/WebhookNewSmsPayload.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookNewSmsPayload' { + Context 'WebhookNewSmsPayload' { + It 'Initialize-WebhookNewSmsPayload' { + # a simple test to create an object + #$NewObject = Initialize-WebhookNewSmsPayload -MessageId "TEST_VALUE" -WebhookId "TEST_VALUE" -EventName "TEST_VALUE" -WebhookName "TEST_VALUE" -SmsId "TEST_VALUE" -UserId "TEST_VALUE" -PhoneNumber "TEST_VALUE" -ToNumber "TEST_VALUE" -FromNumber "TEST_VALUE" -Body "TEST_VALUE" -Read "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookNewSmsPayload + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookProjection.Tests.ps1 b/tests/Model/WebhookProjection.Tests.ps1 new file mode 100644 index 00000000..53662713 --- /dev/null +++ b/tests/Model/WebhookProjection.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookProjection' { + Context 'WebhookProjection' { + It 'Initialize-WebhookProjection' { + # a simple test to create an object + #$NewObject = Initialize-WebhookProjection -Url "TEST_VALUE" -InboxId "TEST_VALUE" -EventName "TEST_VALUE" -PhoneNumberId "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Name "TEST_VALUE" -Id "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookProjection + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookRedriveAllResult.Tests.ps1 b/tests/Model/WebhookRedriveAllResult.Tests.ps1 new file mode 100644 index 00000000..7205618e --- /dev/null +++ b/tests/Model/WebhookRedriveAllResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookRedriveAllResult' { + Context 'WebhookRedriveAllResult' { + It 'Initialize-WebhookRedriveAllResult' { + # a simple test to create an object + #$NewObject = Initialize-WebhookRedriveAllResult -Success "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookRedriveAllResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookRedriveResult.Tests.ps1 b/tests/Model/WebhookRedriveResult.Tests.ps1 new file mode 100644 index 00000000..907e1eac --- /dev/null +++ b/tests/Model/WebhookRedriveResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookRedriveResult' { + Context 'WebhookRedriveResult' { + It 'Initialize-WebhookRedriveResult' { + # a simple test to create an object + #$NewObject = Initialize-WebhookRedriveResult -WebhookResultId "TEST_VALUE" -Success "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookRedriveResult + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookResultDto.Tests.ps1 b/tests/Model/WebhookResultDto.Tests.ps1 new file mode 100644 index 00000000..441b1302 --- /dev/null +++ b/tests/Model/WebhookResultDto.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookResultDto' { + Context 'WebhookResultDto' { + It 'Initialize-WebhookResultDto' { + # a simple test to create an object + #$NewObject = Initialize-WebhookResultDto -Id "TEST_VALUE" -UserId "TEST_VALUE" -WebhookId "TEST_VALUE" -WebhookUrl "TEST_VALUE" -MessageId "TEST_VALUE" -RedriveId "TEST_VALUE" -HttpMethod "TEST_VALUE" -WebhookEvent "TEST_VALUE" -ResponseStatus "TEST_VALUE" -ResponseTimeMillis "TEST_VALUE" -ResponseBodyExtract "TEST_VALUE" -ResultType "TEST_VALUE" -CreatedAt "TEST_VALUE" -UpdatedAt "TEST_VALUE" -Seen "TEST_VALUE" -InboxId "TEST_VALUE" -EmailId "TEST_VALUE" -AttachmentId "TEST_VALUE" -PhoneId "TEST_VALUE" -SmsId "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookResultDto + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookTestRequest.Tests.ps1 b/tests/Model/WebhookTestRequest.Tests.ps1 new file mode 100644 index 00000000..a8a81036 --- /dev/null +++ b/tests/Model/WebhookTestRequest.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookTestRequest' { + Context 'WebhookTestRequest' { + It 'Initialize-WebhookTestRequest' { + # a simple test to create an object + #$NewObject = Initialize-WebhookTestRequest -Url "TEST_VALUE" -Method "TEST_VALUE" -Headers "TEST_VALUE" -Payload "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookTestRequest + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookTestResponse.Tests.ps1 b/tests/Model/WebhookTestResponse.Tests.ps1 new file mode 100644 index 00000000..37469141 --- /dev/null +++ b/tests/Model/WebhookTestResponse.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookTestResponse' { + Context 'WebhookTestResponse' { + It 'Initialize-WebhookTestResponse' { + # a simple test to create an object + #$NewObject = Initialize-WebhookTestResponse -StatusCode "TEST_VALUE" -Message "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookTestResponse + #$NewObject.property | Should -Be 0 + } + } +} diff --git a/tests/Model/WebhookTestResult.Tests.ps1 b/tests/Model/WebhookTestResult.Tests.ps1 new file mode 100644 index 00000000..02fab796 --- /dev/null +++ b/tests/Model/WebhookTestResult.Tests.ps1 @@ -0,0 +1,18 @@ +# +# MailSlurp API +# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository +# Version: 6.5.2 +# Contact: contact@mailslurp.dev +# Generated by OpenAPI Generator: https://openapi-generator.tech +# + +Describe -tag 'maislurp-client-powershell' -name 'WebhookTestResult' { + Context 'WebhookTestResult' { + It 'Initialize-WebhookTestResult' { + # a simple test to create an object + #$NewObject = Initialize-WebhookTestResult -Message "TEST_VALUE" -Response "TEST_VALUE" -Request "TEST_VALUE" + #$NewObject | Should -BeOfType WebhookTestResult + #$NewObject.property | Should -Be 0 + } + } +}