├── .DS_Store ├── .gitignore ├── .swagger-codegen-ignore ├── .swagger-codegen └── VERSION ├── .travis.yml ├── LICENSE.md ├── README.md ├── build.gradle ├── build.sbt ├── docs ├── AbTestCampaignResult.md ├── AbTestCampaignResultClickedLinks.md ├── AbTestCampaignResultStatistics.md ├── AbTestVersionClicks.md ├── AbTestVersionClicksInner.md ├── AbTestVersionStats.md ├── AccountApi.md ├── AddChildDomain.md ├── AddContactToList.md ├── AddCredits.md ├── BlockDomain.md ├── Body.md ├── Body1.md ├── Body10.md ├── Body11.md ├── Body12.md ├── Body2.md ├── Body3.md ├── Body4.md ├── Body5.md ├── Body6.md ├── Body7.md ├── Body8.md ├── Body9.md ├── BodyVariablesItems.md ├── CompaniesApi.md ├── CompaniesList.md ├── Company.md ├── CompanyAttributes.md ├── CompanyAttributesInner.md ├── ComponentItems.md ├── ContactsApi.md ├── ConversationsApi.md ├── ConversationsMessage.md ├── ConversationsMessageFile.md ├── ConversationsMessageFileImageInfo.md ├── CreateApiKeyRequest.md ├── CreateApiKeyResponse.md ├── CreateAttribute.md ├── CreateAttributeEnumeration.md ├── CreateCategoryModel.md ├── CreateChild.md ├── CreateContact.md ├── CreateDoiContact.md ├── CreateEmailCampaign.md ├── CreateEmailCampaignRecipients.md ├── CreateEmailCampaignSender.md ├── CreateList.md ├── CreateModel.md ├── CreateProductModel.md ├── CreateReseller.md ├── CreateSender.md ├── CreateSenderIps.md ├── CreateSenderModel.md ├── CreateSmsCampaign.md ├── CreateSmsCampaignRecipients.md ├── CreateSmtpEmail.md ├── CreateSmtpTemplate.md ├── CreateSmtpTemplateSender.md ├── CreateSubAccount.md ├── CreateSubAccountResponse.md ├── CreateUpdateBatchCategory.md ├── CreateUpdateBatchCategoryModel.md ├── CreateUpdateBatchProducts.md ├── CreateUpdateBatchProductsModel.md ├── CreateUpdateCategories.md ├── CreateUpdateCategory.md ├── CreateUpdateContactModel.md ├── CreateUpdateFolder.md ├── CreateUpdateProduct.md ├── CreateUpdateProducts.md ├── CreateWebhook.md ├── CreatedBatchId.md ├── CreatedProcessId.md ├── Deal.md ├── DealAttributes.md ├── DealAttributesInner.md ├── DealsApi.md ├── DealsList.md ├── DeleteHardbounces.md ├── EcommerceApi.md ├── EmailCampaignsApi.md ├── EmailExportRecipients.md ├── ErrorModel.md ├── FileData.md ├── FileDownloadableLink.md ├── FileList.md ├── FilesApi.md ├── GetAccount.md ├── GetAccountMarketingAutomation.md ├── GetAccountPlan.md ├── GetAccountRelay.md ├── GetAccountRelayData.md ├── GetAggregatedReport.md ├── GetAttributes.md ├── GetAttributesAttributes.md ├── GetAttributesEnumeration.md ├── GetBlockedDomains.md ├── GetCampaignOverview.md ├── GetCampaignRecipients.md ├── GetCampaignStats.md ├── GetCategories.md ├── GetCategoryDetails.md ├── GetChildAccountCreationStatus.md ├── GetChildDomain.md ├── GetChildDomains.md ├── GetChildInfo.md ├── GetChildInfoApiKeys.md ├── GetChildInfoApiKeysV2.md ├── GetChildInfoApiKeysV3.md ├── GetChildInfoCredits.md ├── GetChildInfoStatistics.md ├── GetChildrenList.md ├── GetClient.md ├── GetContactCampaignStats.md ├── GetContactCampaignStatsClicked.md ├── GetContactCampaignStatsOpened.md ├── GetContactCampaignStatsTransacAttributes.md ├── GetContactCampaignStatsUnsubscriptions.md ├── GetContactDetails.md ├── GetContacts.md ├── GetDeviceBrowserStats.md ├── GetEmailCampaign.md ├── GetEmailCampaigns.md ├── GetEmailEventReport.md ├── GetEmailEventReportEvents.md ├── GetExtendedCampaignOverview.md ├── GetExtendedCampaignOverviewSender.md ├── GetExtendedCampaignStats.md ├── GetExtendedClient.md ├── GetExtendedClientAddress.md ├── GetExtendedContactDetails.md ├── GetExtendedContactDetailsStatistics.md ├── GetExtendedContactDetailsStatisticsClicked.md ├── GetExtendedContactDetailsStatisticsDelivered.md ├── GetExtendedContactDetailsStatisticsLinks.md ├── GetExtendedContactDetailsStatisticsMessagesSent.md ├── GetExtendedContactDetailsStatisticsOpened.md ├── GetExtendedContactDetailsStatisticsUnsubscriptions.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md ├── GetExtendedList.md ├── GetExtendedListCampaignStats.md ├── GetFolder.md ├── GetFolderLists.md ├── GetFolders.md ├── GetInboundEmailEvents.md ├── GetInboundEmailEventsByUuid.md ├── GetInboundEmailEventsByUuidAttachments.md ├── GetInboundEmailEventsByUuidLogs.md ├── GetInboundEmailEventsEvents.md ├── GetIp.md ├── GetIpFromSender.md ├── GetIps.md ├── GetIpsFromSender.md ├── GetList.md ├── GetLists.md ├── GetProcess.md ├── GetProcesses.md ├── GetProductDetails.md ├── GetProducts.md ├── GetReports.md ├── GetReportsReports.md ├── GetScheduledEmailByBatchId.md ├── GetScheduledEmailByBatchIdBatches.md ├── GetScheduledEmailByMessageId.md ├── GetSendersList.md ├── GetSendersListIps.md ├── GetSendersListSenders.md ├── GetSharedTemplateUrl.md ├── GetSmsCampaign.md ├── GetSmsCampaignOverview.md ├── GetSmsCampaignStats.md ├── GetSmsCampaigns.md ├── GetSmsEventReport.md ├── GetSmsEventReportEvents.md ├── GetSmtpTemplateOverview.md ├── GetSmtpTemplateOverviewSender.md ├── GetSmtpTemplates.md ├── GetSsoToken.md ├── GetStatsByBrowser.md ├── GetStatsByDevice.md ├── GetStatsByDomain.md ├── GetTransacAggregatedSmsReport.md ├── GetTransacBlockedContacts.md ├── GetTransacBlockedContactsContacts.md ├── GetTransacBlockedContactsReason.md ├── GetTransacEmailContent.md ├── GetTransacEmailContentEvents.md ├── GetTransacEmailsList.md ├── GetTransacEmailsListTransactionalEmails.md ├── GetTransacSmsReport.md ├── GetTransacSmsReportReports.md ├── GetWebhook.md ├── GetWebhooks.md ├── GetWhatsappCampaignOverview.md ├── InboundParsingApi.md ├── InlineResponse200.md ├── InlineResponse201.md ├── InlineResponse2011.md ├── ManageIp.md ├── MasterAccountApi.md ├── MasterDetailsResponse.md ├── MasterDetailsResponseBillingInfo.md ├── MasterDetailsResponseBillingInfoAddress.md ├── MasterDetailsResponseBillingInfoName.md ├── MasterDetailsResponsePlanInfo.md ├── MasterDetailsResponsePlanInfoFeatures.md ├── Note.md ├── NoteData.md ├── NoteId.md ├── NoteList.md ├── NotesApi.md ├── Order.md ├── OrderBatch.md ├── OrderBilling.md ├── OrderProducts.md ├── Pipeline.md ├── PipelineStage.md ├── PostContactInfo.md ├── PostContactInfoContacts.md ├── PostSendFailed.md ├── PostSendSmsTestFailed.md ├── ProcessApi.md ├── RemainingCreditModel.md ├── RemainingCreditModelChild.md ├── RemainingCreditModelReseller.md ├── RemoveContactFromList.md ├── RemoveCredits.md ├── RequestContactExport.md ├── RequestContactExportCustomContactFilter.md ├── RequestContactImport.md ├── RequestContactImportNewList.md ├── RequestSmsRecipientExport.md ├── ResellerApi.md ├── ScheduleSmtpEmail.md ├── SendReport.md ├── SendReportEmail.md ├── SendSms.md ├── SendSmtpEmail.md ├── SendSmtpEmailAttachment.md ├── SendSmtpEmailBcc.md ├── SendSmtpEmailCc.md ├── SendSmtpEmailMessageVersions.md ├── SendSmtpEmailReplyTo.md ├── SendSmtpEmailReplyTo1.md ├── SendSmtpEmailSender.md ├── SendSmtpEmailTo.md ├── SendSmtpEmailTo1.md ├── SendTestEmail.md ├── SendTestSms.md ├── SendTransacSms.md ├── SendersApi.md ├── SmsCampaignsApi.md ├── SsoTokenRequest.md ├── SubAccountDetailsResponse.md ├── SubAccountDetailsResponsePlanInfo.md ├── SubAccountDetailsResponsePlanInfoCredits.md ├── SubAccountDetailsResponsePlanInfoCreditsEmails.md ├── SubAccountDetailsResponsePlanInfoFeatures.md ├── SubAccountDetailsResponsePlanInfoFeaturesInbox.md ├── SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md ├── SubAccountDetailsResponsePlanInfoFeaturesUsers.md ├── SubAccountUpdatePlanRequest.md ├── SubAccountUpdatePlanRequestCredits.md ├── SubAccountUpdatePlanRequestFeatures.md ├── SubAccountsResponse.md ├── SubAccountsResponseSubAccounts.md ├── Task.md ├── TaskList.md ├── TaskReminder.md ├── TaskTypes.md ├── TasksApi.md ├── TransactionalEmailsApi.md ├── TransactionalSmsApi.md ├── UpdateAttribute.md ├── UpdateAttributeEnumeration.md ├── UpdateBatchContacts.md ├── UpdateBatchContactsContacts.md ├── UpdateBatchContactsModel.md ├── UpdateCampaignStatus.md ├── UpdateChild.md ├── UpdateChildAccountStatus.md ├── UpdateChildDomain.md ├── UpdateContact.md ├── UpdateEmailCampaign.md ├── UpdateEmailCampaignRecipients.md ├── UpdateEmailCampaignSender.md ├── UpdateList.md ├── UpdateSender.md ├── UpdateSmsCampaign.md ├── UpdateSmtpTemplate.md ├── UpdateSmtpTemplateSender.md ├── UpdateWebhook.md ├── UploadImageModel.md ├── UploadImageToGallery.md ├── VariablesItems.md ├── WebhooksApi.md ├── WhatsappCampStats.md ├── WhatsappCampTemplate.md └── WhatsappCampaignsApi.md ├── git_push.sh ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── pom.xml ├── settings.gradle └── src ├── main ├── AndroidManifest.xml └── java │ ├── sendinblue │ ├── ApiCallback.java │ ├── ApiClient.java │ ├── ApiException.java │ ├── ApiResponse.java │ ├── Configuration.java │ ├── GzipRequestInterceptor.java │ ├── Json.java │ ├── Pair.java │ ├── ProgressRequestBody.java │ ├── ProgressResponseBody.java │ ├── StringUtil.java │ └── auth │ │ ├── ApiKeyAuth.java │ │ ├── Authentication.java │ │ ├── HttpBasicAuth.java │ │ ├── OAuth.java │ │ └── OAuthFlow.java │ ├── sibApi │ ├── AccountApi.java │ ├── CompaniesApi.java │ ├── ContactsApi.java │ ├── ConversationsApi.java │ ├── CrmApi.java │ ├── DealsApi.java │ ├── EcommerceApi.java │ ├── EmailCampaignsApi.java │ ├── FilesApi.java │ ├── InboundParsingApi.java │ ├── MasterAccountApi.java │ ├── NotesApi.java │ ├── ProcessApi.java │ ├── ResellerApi.java │ ├── SendersApi.java │ ├── SmsCampaignsApi.java │ ├── TasksApi.java │ ├── TransactionalEmailsApi.java │ ├── TransactionalSmsApi.java │ ├── WebhooksApi.java │ └── WhatsappCampaignsApi.java │ └── sibModel │ ├── AbTestCampaignResult.java │ ├── AbTestCampaignResultClickedLinks.java │ ├── AbTestCampaignResultStatistics.java │ ├── AbTestVersionClicks.java │ ├── AbTestVersionClicksInner.java │ ├── AbTestVersionStats.java │ ├── AddChildDomain.java │ ├── AddContactToList.java │ ├── AddCredits.java │ ├── BlockDomain.java │ ├── Body.java │ ├── Body1.java │ ├── Body10.java │ ├── Body11.java │ ├── Body12.java │ ├── Body2.java │ ├── Body3.java │ ├── Body4.java │ ├── Body5.java │ ├── Body6.java │ ├── Body7.java │ ├── Body8.java │ ├── Body9.java │ ├── BodyVariablesItems.java │ ├── CompaniesList.java │ ├── Company.java │ ├── CompanyAttributes.java │ ├── CompanyAttributesInner.java │ ├── ComponentItems.java │ ├── ConversationsMessage.java │ ├── ConversationsMessageFile.java │ ├── ConversationsMessageFileImageInfo.java │ ├── CreateApiKeyRequest.java │ ├── CreateApiKeyResponse.java │ ├── CreateAttribute.java │ ├── CreateAttributeEnumeration.java │ ├── CreateCategoryModel.java │ ├── CreateChild.java │ ├── CreateContact.java │ ├── CreateDoiContact.java │ ├── CreateEmailCampaign.java │ ├── CreateEmailCampaignRecipients.java │ ├── CreateEmailCampaignSender.java │ ├── CreateList.java │ ├── CreateModel.java │ ├── CreateProductModel.java │ ├── CreateReseller.java │ ├── CreateSender.java │ ├── CreateSenderIps.java │ ├── CreateSenderModel.java │ ├── CreateSmsCampaign.java │ ├── CreateSmsCampaignRecipients.java │ ├── CreateSmtpEmail.java │ ├── CreateSmtpTemplate.java │ ├── CreateSmtpTemplateSender.java │ ├── CreateSubAccount.java │ ├── CreateSubAccountResponse.java │ ├── CreateUpdateBatchCategory.java │ ├── CreateUpdateBatchCategoryModel.java │ ├── CreateUpdateBatchProducts.java │ ├── CreateUpdateBatchProductsModel.java │ ├── CreateUpdateCategories.java │ ├── CreateUpdateCategory.java │ ├── CreateUpdateContactModel.java │ ├── CreateUpdateFolder.java │ ├── CreateUpdateProduct.java │ ├── CreateUpdateProducts.java │ ├── CreateWebhook.java │ ├── CreatedBatchId.java │ ├── CreatedProcessId.java │ ├── Deal.java │ ├── DealAttributes.java │ ├── DealAttributesInner.java │ ├── DealsList.java │ ├── DeleteHardbounces.java │ ├── EmailExportRecipients.java │ ├── ErrorModel.java │ ├── FileData.java │ ├── FileDownloadableLink.java │ ├── FileList.java │ ├── GetAccount.java │ ├── GetAccountMarketingAutomation.java │ ├── GetAccountPlan.java │ ├── GetAccountRelay.java │ ├── GetAccountRelayData.java │ ├── GetAggregatedReport.java │ ├── GetAttributes.java │ ├── GetAttributesAttributes.java │ ├── GetAttributesEnumeration.java │ ├── GetBlockedDomains.java │ ├── GetCampaignOverview.java │ ├── GetCampaignRecipients.java │ ├── GetCampaignStats.java │ ├── GetCategories.java │ ├── GetCategoryDetails.java │ ├── GetChildAccountCreationStatus.java │ ├── GetChildDomain.java │ ├── GetChildDomains.java │ ├── GetChildInfo.java │ ├── GetChildInfoApiKeys.java │ ├── GetChildInfoApiKeysV2.java │ ├── GetChildInfoApiKeysV3.java │ ├── GetChildInfoCredits.java │ ├── GetChildInfoStatistics.java │ ├── GetChildrenList.java │ ├── GetClient.java │ ├── GetContactCampaignStats.java │ ├── GetContactCampaignStatsClicked.java │ ├── GetContactCampaignStatsOpened.java │ ├── GetContactCampaignStatsTransacAttributes.java │ ├── GetContactCampaignStatsUnsubscriptions.java │ ├── GetContactDetails.java │ ├── GetContacts.java │ ├── GetDeviceBrowserStats.java │ ├── GetEmailCampaign.java │ ├── GetEmailCampaigns.java │ ├── GetEmailEventReport.java │ ├── GetEmailEventReportEvents.java │ ├── GetExtendedCampaignOverview.java │ ├── GetExtendedCampaignOverviewSender.java │ ├── GetExtendedCampaignStats.java │ ├── GetExtendedClient.java │ ├── GetExtendedClientAddress.java │ ├── GetExtendedContactDetails.java │ ├── GetExtendedContactDetailsStatistics.java │ ├── GetExtendedContactDetailsStatisticsClicked.java │ ├── GetExtendedContactDetailsStatisticsDelivered.java │ ├── GetExtendedContactDetailsStatisticsLinks.java │ ├── GetExtendedContactDetailsStatisticsMessagesSent.java │ ├── GetExtendedContactDetailsStatisticsOpened.java │ ├── GetExtendedContactDetailsStatisticsUnsubscriptions.java │ ├── GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.java │ ├── GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.java │ ├── GetExtendedList.java │ ├── GetExtendedListCampaignStats.java │ ├── GetFolder.java │ ├── GetFolderLists.java │ ├── GetFolders.java │ ├── GetInboundEmailEvents.java │ ├── GetInboundEmailEventsByUuid.java │ ├── GetInboundEmailEventsByUuidAttachments.java │ ├── GetInboundEmailEventsByUuidLogs.java │ ├── GetInboundEmailEventsEvents.java │ ├── GetIp.java │ ├── GetIpFromSender.java │ ├── GetIps.java │ ├── GetIpsFromSender.java │ ├── GetList.java │ ├── GetLists.java │ ├── GetProcess.java │ ├── GetProcesses.java │ ├── GetProductDetails.java │ ├── GetProducts.java │ ├── GetReports.java │ ├── GetReportsReports.java │ ├── GetScheduledEmailByBatchId.java │ ├── GetScheduledEmailByBatchIdBatches.java │ ├── GetScheduledEmailByMessageId.java │ ├── GetSendersList.java │ ├── GetSendersListIps.java │ ├── GetSendersListSenders.java │ ├── GetSharedTemplateUrl.java │ ├── GetSmsCampaign.java │ ├── GetSmsCampaignOverview.java │ ├── GetSmsCampaignStats.java │ ├── GetSmsCampaigns.java │ ├── GetSmsEventReport.java │ ├── GetSmsEventReportEvents.java │ ├── GetSmtpTemplateOverview.java │ ├── GetSmtpTemplateOverviewSender.java │ ├── GetSmtpTemplates.java │ ├── GetSsoToken.java │ ├── GetStatsByBrowser.java │ ├── GetStatsByDevice.java │ ├── GetStatsByDomain.java │ ├── GetTransacAggregatedSmsReport.java │ ├── GetTransacBlockedContacts.java │ ├── GetTransacBlockedContactsContacts.java │ ├── GetTransacBlockedContactsReason.java │ ├── GetTransacEmailContent.java │ ├── GetTransacEmailContentEvents.java │ ├── GetTransacEmailsList.java │ ├── GetTransacEmailsListTransactionalEmails.java │ ├── GetTransacSmsReport.java │ ├── GetTransacSmsReportReports.java │ ├── GetWebhook.java │ ├── GetWebhooks.java │ ├── GetWhatsappCampaignOverview.java │ ├── InlineResponse200.java │ ├── InlineResponse201.java │ ├── InlineResponse2011.java │ ├── ManageIp.java │ ├── MasterDetailsResponse.java │ ├── MasterDetailsResponseBillingInfo.java │ ├── MasterDetailsResponseBillingInfoAddress.java │ ├── MasterDetailsResponseBillingInfoName.java │ ├── MasterDetailsResponsePlanInfo.java │ ├── MasterDetailsResponsePlanInfoFeatures.java │ ├── Note.java │ ├── NoteData.java │ ├── NoteId.java │ ├── NoteList.java │ ├── Order.java │ ├── OrderBatch.java │ ├── OrderBilling.java │ ├── OrderProducts.java │ ├── Pipeline.java │ ├── PipelineStage.java │ ├── PostContactInfo.java │ ├── PostContactInfoContacts.java │ ├── PostSendFailed.java │ ├── PostSendSmsTestFailed.java │ ├── RemainingCreditModel.java │ ├── RemainingCreditModelChild.java │ ├── RemainingCreditModelReseller.java │ ├── RemoveContactFromList.java │ ├── RemoveCredits.java │ ├── RequestContactExport.java │ ├── RequestContactExportCustomContactFilter.java │ ├── RequestContactImport.java │ ├── RequestContactImportNewList.java │ ├── RequestSmsRecipientExport.java │ ├── ScheduleSmtpEmail.java │ ├── SendReport.java │ ├── SendReportEmail.java │ ├── SendSms.java │ ├── SendSmtpEmail.java │ ├── SendSmtpEmailAttachment.java │ ├── SendSmtpEmailBcc.java │ ├── SendSmtpEmailCc.java │ ├── SendSmtpEmailMessageVersions.java │ ├── SendSmtpEmailReplyTo.java │ ├── SendSmtpEmailReplyTo1.java │ ├── SendSmtpEmailSender.java │ ├── SendSmtpEmailTo.java │ ├── SendSmtpEmailTo1.java │ ├── SendTestEmail.java │ ├── SendTestSms.java │ ├── SendTransacSms.java │ ├── SsoTokenRequest.java │ ├── SubAccountDetailsResponse.java │ ├── SubAccountDetailsResponsePlanInfo.java │ ├── SubAccountDetailsResponsePlanInfoCredits.java │ ├── SubAccountDetailsResponsePlanInfoCreditsEmails.java │ ├── SubAccountDetailsResponsePlanInfoFeatures.java │ ├── SubAccountDetailsResponsePlanInfoFeaturesInbox.java │ ├── SubAccountDetailsResponsePlanInfoFeaturesLandingPage.java │ ├── SubAccountDetailsResponsePlanInfoFeaturesUsers.java │ ├── SubAccountUpdatePlanRequest.java │ ├── SubAccountUpdatePlanRequestCredits.java │ ├── SubAccountUpdatePlanRequestFeatures.java │ ├── SubAccountsResponse.java │ ├── SubAccountsResponseSubAccounts.java │ ├── Task.java │ ├── TaskList.java │ ├── TaskReminder.java │ ├── TaskTypes.java │ ├── UpdateAttribute.java │ ├── UpdateAttributeEnumeration.java │ ├── UpdateBatchContacts.java │ ├── UpdateBatchContactsContacts.java │ ├── UpdateBatchContactsModel.java │ ├── UpdateCampaignStatus.java │ ├── UpdateChild.java │ ├── UpdateChildAccountStatus.java │ ├── UpdateChildDomain.java │ ├── UpdateContact.java │ ├── UpdateEmailCampaign.java │ ├── UpdateEmailCampaignRecipients.java │ ├── UpdateEmailCampaignSender.java │ ├── UpdateList.java │ ├── UpdateSender.java │ ├── UpdateSmsCampaign.java │ ├── UpdateSmtpTemplate.java │ ├── UpdateSmtpTemplateSender.java │ ├── UpdateWebhook.java │ ├── UploadImageModel.java │ ├── UploadImageToGallery.java │ ├── VariablesItems.java │ ├── WhatsappCampStats.java │ └── WhatsappCampTemplate.java └── test ├── java └── sibApi │ ├── AccountApiTest.java │ ├── CompaniesApiTest.java │ ├── ContactsApiTest.java │ ├── ConversationsApiTest.java │ ├── DealsApiTest.java │ ├── EcommerceApiTest.java │ ├── EmailCampaignsApiTest.java │ ├── FilesApiTest.java │ ├── InboundParsingApiTest.java │ ├── MasterAccountApiTest.java │ ├── NotesApiTest.java │ ├── ProcessApiTest.java │ ├── ResellerApiTest.java │ ├── SendersApiTest.java │ ├── SmsCampaignsApiTest.java │ ├── TasksApiTest.java │ ├── TransactionalEmailsApiTest.java │ ├── TransactionalSmsApiTest.java │ ├── WebhooksApiTest.java │ └── WhatsappCampaignsApiTest.java └── resources └── xyz.pdf /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sendinblue/APIv3-java-library/69a1f311c9902378ff39f17060edc8dfe5d5fdc4/.DS_Store -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.jar 8 | *.war 9 | *.ear 10 | 11 | # exclude jar for gradle wrapper 12 | !gradle/wrapper/*.jar 13 | 14 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 15 | hs_err_pid* 16 | 17 | # build files 18 | **/target 19 | target 20 | .gradle 21 | build 22 | .idea/ 23 | target/ 24 | Out/ 25 | sib-api-v3-sdk.iml 26 | APIv3-java-library.iml 27 | -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | 2.4.9 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # 2 | # Generated by: https://github.com/swagger-api/swagger-codegen.git 3 | # 4 | language: java 5 | jdk: 6 | - oraclejdk8 7 | - oraclejdk7 8 | before_install: 9 | # ensure gradlew has proper permission 10 | - chmod a+x ./gradlew 11 | script: 12 | # test using maven 13 | - mvn test 14 | # uncomment below to test using gradle 15 | # - gradle test 16 | # uncomment below to test using sbt 17 | # - sbt test 18 | dist: trusty 19 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2023 SendinBlue 4 | 5 | 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: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | 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. 10 | -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | lazy val root = (project in file(".")). 2 | settings( 3 | organization := "com.sendinblue", 4 | name := "sib-api-v3-sdk", 5 | version := "7.0.0", 6 | scalaVersion := "2.11.4", 7 | scalacOptions ++= Seq("-feature"), 8 | javacOptions in compile ++= Seq("-Xlint:deprecation"), 9 | publishArtifact in (Compile, packageDoc) := false, 10 | resolvers += Resolver.mavenLocal, 11 | libraryDependencies ++= Seq( 12 | "io.swagger" % "swagger-annotations" % "1.5.17", 13 | "okhttp3" % "okhttp" % "2.7.5", 14 | "okhttp3" % "logging-interceptor" % "2.7.5", 15 | "com.google.code.gson" % "gson" % "2.8.1", 16 | "org.threeten" % "threetenbp" % "1.3.5" % "compile", 17 | "io.gsonfire" % "gson-fire" % "1.8.0" % "compile", 18 | "junit" % "junit" % "4.12" % "test", 19 | "com.novocode" % "junit-interface" % "0.10" % "test" 20 | ) 21 | ) 22 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResult.md: -------------------------------------------------------------------------------- 1 | # AbTestCampaignResult 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **winningVersion** | [** 8 | WinningVersionEnum**](#WinningVersionEnum) | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional] 9 | **winningCriteria** | [** 10 | WinningCriteriaEnum**](#WinningCriteriaEnum) | Criteria choosen for winning version (Open/Click) | [optional] 11 | **winningSubjectLine** | **String** | Subject Line of current winning version | [optional] 12 | **openRate** | **String** | Open rate for current winning version | [optional] 13 | **clickRate** | **String** | Click rate for current winning version | [optional] 14 | **winningVersionRate** | **String** | Open/Click rate for the winner version | [optional] 15 | **statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional] 16 | **clickedLinks** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional] 17 | 18 | 19 | 20 | ## Enum: WinningVersionEnum 21 | 22 | Name | Value 23 | ---- | ----- 24 | NOTAVAILABLE | "notAvailable" 25 | PENDING | "pending" 26 | TIE | "tie" 27 | A | "A" 28 | B | "B" 29 | 30 | 31 | 32 | ## Enum: WinningCriteriaEnum 33 | 34 | Name | Value 35 | ---- | ----- 36 | OPEN | "Open" 37 | CLICK | "Click" 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResultClickedLinks.md: -------------------------------------------------------------------------------- 1 | 2 | # AbTestCampaignResultClickedLinks 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **versionA** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | 8 | **versionB** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResultStatistics.md: -------------------------------------------------------------------------------- 1 | 2 | # AbTestCampaignResultStatistics 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 8 | **clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 9 | **unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 10 | **hardBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 11 | **softBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 12 | **complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/AbTestVersionClicks.md: -------------------------------------------------------------------------------- 1 | 2 | # AbTestVersionClicks 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AbTestVersionClicksInner.md: -------------------------------------------------------------------------------- 1 | 2 | # AbTestVersionClicksInner 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **link** | **String** | URL of the link | 8 | **clicksCount** | [**BigDecimal**](BigDecimal.md) | Number of times a link is clicked | 9 | **clickRate** | **String** | Percentage of clicks of link with respect to total clicks | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AbTestVersionStats.md: -------------------------------------------------------------------------------- 1 | 2 | # AbTestVersionStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **versionA** | **String** | percentage of an event for version A | 8 | **versionB** | **String** | percentage of an event for version B | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AccountApi.md: -------------------------------------------------------------------------------- 1 | # AccountApi 2 | 3 | All URIs are relative to *https://api.sendinblue.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**getAccount**](AccountApi.md#getAccount) | **GET** /account | Get your account information, plan and credits details 8 | 9 | 10 | 11 | # **getAccount** 12 | > GetAccount getAccount() 13 | 14 | Get your account information, plan and credits details 15 | 16 | ### Example 17 | ```java 18 | // Import classes: 19 | //import sendinblue.ApiClient; 20 | //import sendinblue.ApiException; 21 | //import sendinblue.Configuration; 22 | //import sendinblue.auth.*; 23 | //import sibApi.AccountApi; 24 | 25 | ApiClient defaultClient = Configuration.getDefaultApiClient(); 26 | 27 | // Configure API key authorization: api-key 28 | ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key"); 29 | apiKey.setApiKey("YOUR API KEY"); 30 | // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 31 | //apiKey.setApiKeyPrefix("Token"); 32 | 33 | // Configure API key authorization: partner-key 34 | ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key"); 35 | partnerKey.setApiKey("YOUR PARTNER KEY"); 36 | // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 37 | //partnerKey.setApiKeyPrefix("Token"); 38 | 39 | AccountApi apiInstance = new AccountApi(); 40 | try { 41 | GetAccount result = apiInstance.getAccount(); 42 | System.out.println(result); 43 | } catch (ApiException e) { 44 | System.err.println("Exception when calling AccountApi#getAccount"); 45 | e.printStackTrace(); 46 | } 47 | ``` 48 | 49 | ### Parameters 50 | This endpoint does not need any parameter. 51 | 52 | ### Return type 53 | 54 | [**GetAccount**](GetAccount.md) 55 | 56 | ### Authorization 57 | 58 | [api-key](../README.md#api-key), [partner-key](../README.md#partner-key) 59 | 60 | ### HTTP request headers 61 | 62 | - **Content-Type**: application/json 63 | - **Accept**: application/json 64 | 65 | -------------------------------------------------------------------------------- /docs/AddChildDomain.md: -------------------------------------------------------------------------------- 1 | 2 | # AddChildDomain 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **domain** | **String** | Sender domain to add for a specific child account | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AddContactToList.md: -------------------------------------------------------------------------------- 1 | 2 | # AddContactToList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **emails** | **List<String>** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 8 | **ids** | **List<Long>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AddCredits.md: -------------------------------------------------------------------------------- 1 | 2 | # AddCredits 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sms** | **Long** | Required if email credits are empty. SMS credits to be added to the child account | [optional] 8 | **email** | **Long** | Required if sms credits are empty. Email credits to be added to the child account | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/BlockDomain.md: -------------------------------------------------------------------------------- 1 | 2 | # BlockDomain 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **domain** | **String** | name of the domain to be blocked | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Body.md: -------------------------------------------------------------------------------- 1 | 2 | # Body 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of company | 8 | **attributes** | **Object** | Attributes for company creation | [optional] 9 | **countryCode** | **Long** | Country code if phone_number is passed in attributes. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Body1.md: -------------------------------------------------------------------------------- 1 | 2 | # Body1 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of company | [optional] 8 | **attributes** | **Object** | Attributes for company update | [optional] 9 | **countryCode** | **Long** | Country code if phone_number is passed in attributes. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Body10.md: -------------------------------------------------------------------------------- 1 | 2 | # Body10 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **visitorId** | **String** | visitor’s ID received <a href="https://developers.sendinblue.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users">bind existing user account to Conversations</a> | 8 | **text** | **String** | message text | 9 | **agentId** | **String** | agent ID. It can be found on agent’s page or received <a href="https://developers.sendinblue.com/docs/conversations-webhooks">from a webhook</a>. Optional if `groupId` is set. | [optional] 10 | **groupId** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body11.md: -------------------------------------------------------------------------------- 1 | 2 | # Body11 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **text** | **String** | edited message text | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Body12.md: -------------------------------------------------------------------------------- 1 | 2 | # Body12 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **agentId** | **String** | agent ID. It can be found on agent’s page or received <a href="https://developers.sendinblue.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional] 8 | **receivedFrom** | **String** | mark your messages to distinguish messages created by you from the others. | [optional] 9 | **agentEmail** | **String** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Sendinblue organization, a dummy agent will be created automatically. | [optional] 10 | **agentName** | **String** | agent name. | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body2.md: -------------------------------------------------------------------------------- 1 | 2 | # Body2 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **linkContactIds** | **List<Long>** | Contact ids for contacts to be linked with company | [optional] 8 | **unlinkContactIds** | **List<Long>** | Contact ids for contacts to be unlinked from company | [optional] 9 | **linkDealsIds** | **List<String>** | Deals ids for deals to be linked with company | [optional] 10 | **unlinkDealsIds** | **List<String>** | Deals ids for deals to be unlinked from company | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body3.md: -------------------------------------------------------------------------------- 1 | 2 | # Body3 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of deal | 8 | **attributes** | **Object** | Attributes fo\\r deal creation | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Body4.md: -------------------------------------------------------------------------------- 1 | 2 | # Body4 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of deal | [optional] 8 | **attributes** | **Object** | Attributes for deal update | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Body5.md: -------------------------------------------------------------------------------- 1 | 2 | # Body5 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **linkContactIds** | **List<Long>** | Contact ids for contacts to be linked with deal | [optional] 8 | **unlinkContactIds** | **List<Long>** | Contact ids for contacts to be unlinked from deal | [optional] 9 | **linkCompanyIds** | **List<String>** | Company ids to be linked with deal | [optional] 10 | **unlinkCompanyIds** | **List<String>** | Company ids to be unlinked from deal | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body6.md: -------------------------------------------------------------------------------- 1 | 2 | # Body6 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of task | 8 | **duration** | **Long** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 9 | **taskTypeId** | **String** | Id for type of task e.g Call / Email / Meeting etc. | 10 | **date** | [**OffsetDateTime**] | Task due date and time | 11 | **notes** | **String** | Notes added to a task | [optional] 12 | **done** | **Boolean** | Task marked as done | [optional] 13 | **assignToId** | **String** | User id to whom task is assigned | [optional] 14 | **contactsIds** | **List<Integer>** | Contact ids for contacts linked to this task | [optional] 15 | **dealsIds** | **List<String>** | Deal ids for deals a task is linked to | [optional] 16 | **companiesIds** | **List<String>** | Companies ids for companies a task is linked to | [optional] 17 | **reminder** | [**TaskReminder**](TaskReminder.md) | | [optional] 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/Body7.md: -------------------------------------------------------------------------------- 1 | 2 | # Body7 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of task | [optional] 8 | **duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 9 | **taskTypeId** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional] 10 | **date** | [**OffsetDateTime**] | Task date/time | [optional] 11 | **notes** | **String** | Notes added to a task | [optional] 12 | **done** | **Boolean** | Task marked as done | [optional] 13 | **assignToId** | **String** | User id to whom task is assigned | [optional] 14 | **contactsIds** | **List<Integer>** | Contact ids for contacts linked to this task | [optional] 15 | **dealsIds** | **List<String>** | Deal ids for deals a task is linked to | [optional] 16 | **companiesIds** | **List<String>** | Companies ids for companies a task is linked to | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/Body8.md: -------------------------------------------------------------------------------- 1 | 2 | # Body8 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **visitorId** | **String** | visitor’s ID received <a href="https://developers.sendinblue.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users">bind existing user account to Conversations</a> | 8 | **text** | **String** | message text | 9 | **agentId** | **String** | agent ID. It can be found on agent’s page or received <a href="https://developers.sendinblue.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional] 10 | **receivedFrom** | **String** | mark your messages to distinguish messages created by you from the others. | [optional] 11 | **agentEmail** | **String** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional] 12 | **agentName** | **String** | agent name | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Body9.md: -------------------------------------------------------------------------------- 1 | 2 | # Body9 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **text** | **String** | edited message text | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/BodyVariablesItems.md: -------------------------------------------------------------------------------- 1 | 2 | # BodyVariablesItems 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CompaniesList.md: -------------------------------------------------------------------------------- 1 | 2 | # CompaniesList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **items** | [**List<Company>**](Company.md) | List of compaies | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Company.md: -------------------------------------------------------------------------------- 1 | 2 | # Company 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique company id | [optional] 8 | **attributes** | **Object** | Company attributes with values | [optional] 9 | **linkedContactsIds** | **List<Integer>** | Contact ids for contacts linked to this company | [optional] 10 | **linkedDealsIds** | **List<String>** | Deals ids for companies linked to this company | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CompanyAttributes.md: -------------------------------------------------------------------------------- 1 | 2 | # CompanyAttributes 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CompanyAttributesInner.md: -------------------------------------------------------------------------------- 1 | 2 | # CompanyAttributesInner 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **internalName** | **String** | | [optional] 8 | **label** | **String** | | [optional] 9 | **attributeTypeName** | **String** | | [optional] 10 | **attributeOptions** | **List<Object>** | | [optional] 11 | **isRequired** | **Boolean** | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ComponentItems.md: -------------------------------------------------------------------------------- 1 | 2 | # ComponentItems 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **String** | | [optional] 8 | **text** | **String** | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ConversationsMessage.md: -------------------------------------------------------------------------------- 1 | 2 | # ConversationsMessage 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Message ID. It can be used for further manipulations with the message. | [optional] 8 | **type** | [**TypeEnum**](#TypeEnum) | `"agent"` for agents’ messages, `"visitor"` for visitors’ messages. | [optional] 9 | **text** | **String** | Message text or name of the attached file | [optional] 10 | **visitorId** | **String** | visitor’s ID | [optional] 11 | **agentId** | **String** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] 12 | **agentName** | **String** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] 13 | **createdAt** | **Long** | Timestamp in milliseconds. | [optional] 14 | **isPushed** | **Boolean** | `true` for pushed messages | [optional] 15 | **receivedFrom** | **String** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional] 16 | **file** | [**ConversationsMessageFile**](ConversationsMessageFile.md) | | [optional] 17 | 18 | 19 | 20 | ## Enum: TypeEnum 21 | Name | Value 22 | ---- | ----- 23 | AGENT | "agent" 24 | VISITOR | "visitor" 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ConversationsMessageFile.md: -------------------------------------------------------------------------------- 1 | 2 | # ConversationsMessageFile 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **filename** | **String** | Name of the file | [optional] 8 | **size** | **Long** | Size in bytes | [optional] 9 | **isImage** | **Boolean** | Whether the file is an image | [optional] 10 | **url** | **String** | URL of the file | [optional] 11 | **imageInfo** | [**ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ConversationsMessageFileImageInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # ConversationsMessageFileImageInfo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **width** | **Long** | Width of the image | [optional] 8 | **height** | **Long** | height of the image | [optional] 9 | **previewUrl** | **String** | URL of the preview | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateApiKeyRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateApiKeyRequest 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | Id of the sub-account organization | 8 | **name** | **String** | Name of the API key | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateApiKeyResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateApiKeyResponse 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **String** | Status of the API operation. | [optional] 8 | **key** | **String** | API Key | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateAttribute.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateAttribute 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 8 | **isRecurring** | **Boolean** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 9 | **enumeration** | [**List<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is "category". For example, [{"value":1, "label":"male"}, {"value":2, "label":"female"}] | [optional] 10 | **type** | [**TypeEnum**](#TypeEnum) | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] 11 | 12 | 13 | 14 | ## Enum: TypeEnum 15 | Name | Value 16 | ---- | ----- 17 | TEXT | "text" 18 | DATE | "date" 19 | FLOAT | "float" 20 | BOOLEAN | "boolean" 21 | ID | "id" 22 | CATEGORY | "category" 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/CreateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateAttributeEnumeration 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **Integer** | Id of the value | 8 | **label** | **String** | Label of the value | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateCategoryModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateCategoryModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the category when a new category is created | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateChild.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateChild 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address to create the child account | 8 | **firstName** | **String** | First name to use to create the child account | 9 | **lastName** | **String** | Last name to use to create the child account | 10 | **companyName** | **String** | Company name to use to create the child account | 11 | **password** | **String** | Password for the child account to login | 12 | **language** | [**LanguageEnum**](#LanguageEnum) | Language of the child account | [optional] 13 | 14 | 15 | 16 | ## Enum: LanguageEnum 17 | Name | Value 18 | ---- | ----- 19 | FR | "fr" 20 | ES | "es" 21 | PT | "pt" 22 | IT | "it" 23 | DE | "de" 24 | EN | "en" 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/CreateContact.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateContact 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the user. Mandatory if "SMS" field is not passed in "attributes" parameter. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} | [optional] 8 | **attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {"FNAME":"Elly", "LNAME":"Roger"} | [optional] 9 | **emailBlacklisted** | **Boolean** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 10 | **smsBlacklisted** | **Boolean** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 11 | **listIds** | **List<Long>** | Ids of the lists to add the contact to | [optional] 12 | **updateEnabled** | **Boolean** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] 13 | **smtpBlacklistSender** | **List<String>** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateDoiContact.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateDoiContact 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | 8 | **attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional] 9 | **includeListIds** | **List<Long>** | Lists under user account where contact should be added | 10 | **excludeListIds** | **List<Long>** | Lists under user account where contact should not be added | [optional] 11 | **templateId** | **Long** | Id of the Double opt-in (DOI) template | 12 | **redirectionUrl** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateEmailCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateEmailCampaignRecipients 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **exclusionListIds** | **List<Long>** | List ids to exclude from the campaign | [optional] 8 | **listIds** | **List<Long>** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 9 | **segmentIds** | **List<Long>** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateEmailCampaignSender.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateEmailCampaignSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Sender Name | [optional] 8 | **email** | **String** | Sender email | 9 | **id** | **Long** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateList.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the list | 8 | **folderId** | **Long** | Id of the parent folder in which this list is to be created | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the object created | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateProductModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateProductModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the Product when a new product is created | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateReseller.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateReseller 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **authKey** | **String** | AuthKey of Reseller child created | 8 | **id** | **Long** | Id of Reseller child created | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSender.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | From Name to use for the sender | 8 | **email** | **String** | From email to use for the sender. A verification email will be sent to this address. | 9 | **ips** | [**List<CreateSenderIps>**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSenderIps.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSenderIps 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ip** | **String** | Dedicated IP available in your account | 8 | **domain** | **String** | Domain of the IP | 9 | **weight** | **Long** | Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSenderModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSenderModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the Sender created | 8 | **spfError** | **Boolean** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] 9 | **dkimError** | **Boolean** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSmsCampaign.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSmsCampaign 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the campaign | 8 | **sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | 9 | **content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | 10 | **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] 11 | **scheduledAt** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 12 | **unicodeEnabled** | **Boolean** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] 13 | **organisationPrefix** | **String** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] 14 | **unsubscribeInstruction** | **String** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CreateSmsCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSmsCampaignRecipients 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **listIds** | **List<Long>** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 8 | **exclusionListIds** | **List<Long>** | List ids which have to be excluded from a campaign | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSmtpEmail.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSmtpEmail 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messageId** | **String** | Message ID of the transactional email sent | [optional] 8 | **messageIds** | **List<String>** | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSmtpTemplate.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSmtpTemplate 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tag** | **String** | Tag of the template | [optional] 8 | **sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | | 9 | **templateName** | **String** | Name of the template | 10 | **htmlContent** | **String** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional] 11 | **htmlUrl** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 12 | **subject** | **String** | Subject of the template | 13 | **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 14 | **toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 15 | **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 16 | **isActive** | **Boolean** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/CreateSmtpTemplateSender.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSmtpTemplateSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the sender. If not passed, will be set to default | [optional] 8 | **email** | **String** | Email of the sender | [optional] 9 | **id** | **Long** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSubAccount.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSubAccount 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **companyName** | **String** | Set the name of the sub-account company | 8 | **email** | **String** | Email address for the organization | 9 | **language** | [**LanguageEnum**](#LanguageEnum) | Set the language of the sub-account | [optional] 10 | **timezone** | **String** | Set the timezone of the sub-account | [optional] 11 | 12 | 13 | 14 | ## Enum: LanguageEnum 15 | Name | Value 16 | ---- | ----- 17 | EN | "en" 18 | FR | "fr" 19 | IT | "it" 20 | ES | "es" 21 | PT | "pt" 22 | DE | "de" 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/CreateSubAccountResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateSubAccountResponse 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the sub-account created | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchCategory.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateBatchCategory 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **categories** | [**List<CreateUpdateCategories>**](CreateUpdateCategories.md) | array of categories objects | 8 | **updateEnabled** | **Boolean** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchCategoryModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateBatchCategoryModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **createdCount** | **Long** | Number of the new created categories | [optional] 8 | **updatedCount** | **Long** | Number of the existing categories updated | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchProducts.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateBatchProducts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **products** | [**List<CreateUpdateProducts>**](CreateUpdateProducts.md) | array of products objects | 8 | **updateEnabled** | **Boolean** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchProductsModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateBatchProductsModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **createdCount** | **Long** | Number of the new created products | [optional] 8 | **updatedCount** | **Long** | Number of the existing products updated | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateCategories.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateCategories 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique Category ID as saved in the shop | 8 | **name** | **String** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] 9 | **url** | **String** | URL to the category | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateUpdateCategory.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateCategory 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique Category ID as saved in the shop | 8 | **name** | **String** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] 9 | **url** | **String** | URL to the category | [optional] 10 | **updateEnabled** | **Boolean** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CreateUpdateContactModel.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateContactModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the contact when a new contact is created | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateUpdateFolder.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateFolder 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the folder | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateUpdateProduct.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateProduct 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Product ID for which you requested the details | 8 | **name** | **String** | Mandatory in case of creation**. Name of the product for which you requested the details | 9 | **url** | **String** | URL to the product | [optional] 10 | **imageUrl** | **String** | Absolute URL to the cover image of the product | [optional] 11 | **sku** | **String** | Product identifier from the shop | [optional] 12 | **price** | **Float** | Price of the product | [optional] 13 | **categories** | **List<String>** | Category ID-s of the product | [optional] 14 | **parentId** | **String** | Parent product id of the product | [optional] 15 | **metaInfo** | **Map<String, Object>** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] 16 | **updateEnabled** | **Boolean** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/CreateUpdateProducts.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateUpdateProducts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Product ID for which you requested the details | 8 | **name** | **String** | Mandatory in case of creation**. Name of the product for which you requested the details | 9 | **url** | **String** | URL to the product | [optional] 10 | **imageUrl** | **String** | Absolute URL to the cover image of the product | [optional] 11 | **sku** | **String** | Product identifier from the shop | [optional] 12 | **price** | **Float** | Price of the product | [optional] 13 | **categories** | **List<String>** | Category ID-s of the product | [optional] 14 | **parentId** | **String** | Parent product id of the product | [optional] 15 | **metaInfo** | **Map<String, Object>** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/CreateWebhook.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateWebhook 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **String** | URL of the webhook | 8 | **description** | **String** | Description of the webhook | [optional] 9 | **events** | [**List<EventsEnum>**](#List<EventsEnum>) | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` | 10 | **type** | [**TypeEnum**](#TypeEnum) | Type of the webhook | [optional] 11 | **domain** | **String** | Inbound domain of webhook, required in case of event type `inbound` | [optional] 12 | 13 | 14 | 15 | ## Enum: List<EventsEnum> 16 | Name | Value 17 | ---- | ----- 18 | SENT | "sent" 19 | HARDBOUNCE | "hardBounce" 20 | SOFTBOUNCE | "softBounce" 21 | BLOCKED | "blocked" 22 | SPAM | "spam" 23 | DELIVERED | "delivered" 24 | REQUEST | "request" 25 | CLICK | "click" 26 | INVALID | "invalid" 27 | DEFERRED | "deferred" 28 | OPENED | "opened" 29 | UNIQUEOPENED | "uniqueOpened" 30 | UNSUBSCRIBED | "unsubscribed" 31 | LISTADDITION | "listAddition" 32 | CONTACTUPDATED | "contactUpdated" 33 | CONTACTDELETED | "contactDeleted" 34 | INBOUNDEMAILPROCESSED | "inboundEmailProcessed" 35 | 36 | 37 | 38 | ## Enum: TypeEnum 39 | Name | Value 40 | ---- | ----- 41 | TRANSACTIONAL | "transactional" 42 | MARKETING | "marketing" 43 | INBOUND | "inbound" 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /docs/CreatedBatchId.md: -------------------------------------------------------------------------------- 1 | 2 | # CreatedBatchId 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **batchId** | [**BigDecimal**](BigDecimal.md) | Batch ID of the request | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreatedProcessId.md: -------------------------------------------------------------------------------- 1 | 2 | # CreatedProcessId 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **processId** | **Long** | Id of the process created | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Deal.md: -------------------------------------------------------------------------------- 1 | 2 | # Deal 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique deal id | [optional] 8 | **attributes** | **Object** | Deal attributes with values | [optional] 9 | **linkedContactsIds** | **List<Integer>** | Contact ids for contacts linked to this deal | [optional] 10 | **linkedCompaniesIds** | **List<String>** | Companies ids for companies linked to this deal | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DealAttributes.md: -------------------------------------------------------------------------------- 1 | 2 | # DealAttributes 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DealAttributesInner.md: -------------------------------------------------------------------------------- 1 | 2 | # DealAttributesInner 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **internalName** | **String** | | [optional] 8 | **label** | **String** | | [optional] 9 | **attributeTypeName** | **String** | | [optional] 10 | **attributeOptions** | **List<Object>** | | [optional] 11 | **isRequired** | **Boolean** | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DealsList.md: -------------------------------------------------------------------------------- 1 | 2 | # DealsList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **items** | [**List<Deal>**](Deal.md) | List of deals | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DeleteHardbounces.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteHardbounces 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **startDate** | **String** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional] 8 | **endDate** | **String** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional] 9 | **contactEmail** | **String** | Target a specific email address | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/EmailExportRecipients.md: -------------------------------------------------------------------------------- 1 | 2 | # EmailExportRecipients 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **notifyURL** | **String** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 8 | **recipientsType** | [**RecipientsTypeEnum**](#RecipientsTypeEnum) | Type of recipients to export for a campaign | 9 | 10 | 11 | 12 | ## Enum: RecipientsTypeEnum 13 | Name | Value 14 | ---- | ----- 15 | ALL | "all" 16 | NONCLICKERS | "nonClickers" 17 | NONOPENERS | "nonOpeners" 18 | CLICKERS | "clickers" 19 | OPENERS | "openers" 20 | SOFTBOUNCES | "softBounces" 21 | HARDBOUNCES | "hardBounces" 22 | UNSUBSCRIBED | "unsubscribed" 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ErrorModel.md: -------------------------------------------------------------------------------- 1 | 2 | # ErrorModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | [**CodeEnum**](#CodeEnum) | Error code displayed in case of a failure | 8 | **message** | **String** | Readable message associated to the failure | 9 | 10 | 11 | 12 | ## Enum: CodeEnum 13 | Name | Value 14 | ---- | ----- 15 | INVALID_PARAMETER | "invalid_parameter" 16 | MISSING_PARAMETER | "missing_parameter" 17 | OUT_OF_RANGE | "out_of_range" 18 | CAMPAIGN_PROCESSING | "campaign_processing" 19 | CAMPAIGN_SENT | "campaign_sent" 20 | DOCUMENT_NOT_FOUND | "document_not_found" 21 | RESELLER_PERMISSION_DENIED | "reseller_permission_denied" 22 | NOT_ENOUGH_CREDITS | "not_enough_credits" 23 | PERMISSION_DENIED | "permission_denied" 24 | DUPLICATE_PARAMETER | "duplicate_parameter" 25 | DUPLICATE_REQUEST | "duplicate_request" 26 | METHOD_NOT_ALLOWED | "method_not_allowed" 27 | UNAUTHORIZED | "unauthorized" 28 | ACCOUNT_UNDER_VALIDATION | "account_under_validation" 29 | NOT_ACCEPTABLE | "not_acceptable" 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/FileData.md: -------------------------------------------------------------------------------- 1 | 2 | # FileData 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of uploaded file | [optional] 8 | **authorId** | **String** | Account id of user which created the file | [optional] 9 | **contactId** | **Long** | Contact id of contact on which file is uploaded | [optional] 10 | **dealId** | **String** | Deal id linked to a file | [optional] 11 | **companyId** | **String** | Company id linked to a file | [optional] 12 | **size** | **Long** | Size of file in bytes | [optional] 13 | **createdAt** | [**OffsetDateTime**] | File created date/time | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/FileDownloadableLink.md: -------------------------------------------------------------------------------- 1 | 2 | # FileDownloadableLink 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **fileUrl** | **String** | A unique link to download the requested file. | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/FileList.md: -------------------------------------------------------------------------------- 1 | 2 | # FileList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAccount.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAccount 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Login Email | 8 | **firstName** | **String** | First Name | 9 | **lastName** | **String** | Last Name | 10 | **companyName** | **String** | Name of the company | 11 | **address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | 12 | **plan** | [**List<GetAccountPlan>**](GetAccountPlan.md) | Information about your plans and credits | 13 | **relay** | [**GetAccountRelay**](GetAccountRelay.md) | | 14 | **marketingAutomation** | [**GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetAccountMarketingAutomation.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAccountMarketingAutomation 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **key** | **String** | Marketing Automation Tracker ID | [optional] 8 | **enabled** | **Boolean** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetAccountPlan.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAccountPlan 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | [**TypeEnum**](#TypeEnum) | Displays the plan type of the user | 8 | **creditsType** | [**CreditsTypeEnum**](#CreditsTypeEnum) | This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. | 9 | **credits** | **Float** | Remaining credits of the user | 10 | **startDate** | [**LocalDate**] | Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type) | [optional] 11 | **endDate** | [**LocalDate**] | Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type) | [optional] 12 | **userLimit** | **Integer** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional] 13 | 14 | 15 | 16 | ## Enum: TypeEnum 17 | Name | Value 18 | ---- | ----- 19 | PAYASYOUGO | "payAsYouGo" 20 | FREE | "free" 21 | SUBSCRIPTION | "subscription" 22 | SMS | "sms" 23 | RESELLER | "reseller" 24 | 25 | 26 | 27 | ## Enum: CreditsTypeEnum 28 | Name | Value 29 | ---- | ----- 30 | SENDLIMIT | "sendLimit" 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/GetAccountRelay.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAccountRelay 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **enabled** | **Boolean** | Status of your transactional email Account (true=Enabled, false=Disabled) | 8 | **data** | [**GetAccountRelayData**](GetAccountRelayData.md) | | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetAccountRelayData.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAccountRelayData 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **userName** | **String** | Email to use as login on transactional platform | 8 | **relay** | **String** | URL of the SMTP Relay | 9 | **port** | **Integer** | Port used for SMTP Relay | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetAggregatedReport.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAggregatedReport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **range** | **String** | Time frame of the report | [optional] 8 | **requests** | **Long** | Number of requests for the timeframe | [optional] 9 | **delivered** | **Long** | Number of delivered emails for the timeframe | [optional] 10 | **hardBounces** | **Long** | Number of hardbounces for the timeframe | [optional] 11 | **softBounces** | **Long** | Number of softbounces for the timeframe | [optional] 12 | **clicks** | **Long** | Number of clicks for the timeframe | [optional] 13 | **uniqueClicks** | **Long** | Number of unique clicks for the timeframe | [optional] 14 | **opens** | **Long** | Number of openings for the timeframe | [optional] 15 | **uniqueOpens** | **Long** | Number of unique openings for the timeframe | [optional] 16 | **spamReports** | **Long** | Number of complaint (spam report) for the timeframe | [optional] 17 | **blocked** | **Long** | Number of blocked contact emails for the timeframe | [optional] 18 | **invalid** | **Long** | Number of invalid emails for the timeframe | [optional] 19 | **unsubscribed** | **Long** | Number of unsubscribed emails for the timeframe | [optional] 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetAttributes.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAttributes 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **attributes** | [**List<GetAttributesAttributes>**](GetAttributesAttributes.md) | Listing of available contact attributes in your account | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetAttributesAttributes.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAttributesAttributes 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the attribute | 8 | **category** | [**CategoryEnum**](#CategoryEnum) | Category of the attribute | 9 | **type** | [**TypeEnum**](#TypeEnum) | Type of the attribute | [optional] 10 | **enumeration** | [**List<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for "category" type attributes. | [optional] 11 | **calculatedValue** | **String** | Calculated value formula | [optional] 12 | 13 | 14 | 15 | ## Enum: CategoryEnum 16 | Name | Value 17 | ---- | ----- 18 | NORMAL | "normal" 19 | TRANSACTIONAL | "transactional" 20 | CATEGORY | "category" 21 | CALCULATED | "calculated" 22 | GLOBAL | "global" 23 | 24 | 25 | 26 | ## Enum: TypeEnum 27 | Name | Value 28 | ---- | ----- 29 | TEXT | "text" 30 | DATE | "date" 31 | FLOAT | "float" 32 | ID | "id" 33 | BOOLEAN | "boolean" 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/GetAttributesEnumeration.md: -------------------------------------------------------------------------------- 1 | 2 | # GetAttributesEnumeration 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **Long** | ID of Value of the "category" type attribute | 8 | **label** | **String** | Label of the "category" type attribute | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetBlockedDomains.md: -------------------------------------------------------------------------------- 1 | 2 | # GetBlockedDomains 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **domains** | **List<String>** | List of all blocked domains | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetCampaignOverview.md: -------------------------------------------------------------------------------- 1 | 2 | # GetCampaignOverview 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the campaign | 8 | **name** | **String** | Name of the campaign | 9 | **subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] 10 | **type** | [**TypeEnum**](#TypeEnum) | Type of campaign | 11 | **status** | [**StatusEnum**](#StatusEnum) | Status of the campaign | 12 | **scheduledAt** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] 13 | **abTesting** | **Boolean** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] 14 | **subjectA** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] 15 | **subjectB** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] 16 | **splitRule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] 17 | **winnerCriteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] 18 | **winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] 19 | **sendAtBestTime** | **Boolean** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] 20 | 21 | 22 | 23 | ## Enum: TypeEnum 24 | Name | Value 25 | ---- | ----- 26 | CLASSIC | "classic" 27 | TRIGGER | "trigger" 28 | 29 | 30 | 31 | ## Enum: StatusEnum 32 | Name | Value 33 | ---- | ----- 34 | DRAFT | "draft" 35 | SENT | "sent" 36 | ARCHIVE | "archive" 37 | QUEUED | "queued" 38 | SUSPENDED | "suspended" 39 | IN_PROCESS | "in_process" 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /docs/GetCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | 2 | # GetCampaignRecipients 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **lists** | **List<Long>** | | 8 | **exclusionLists** | **List<Long>** | | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetCampaignStats.md: -------------------------------------------------------------------------------- 1 | 2 | # GetCampaignStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **listId** | **Long** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional] 8 | **uniqueClicks** | **Long** | Number of unique clicks for the campaign | 9 | **clickers** | **Long** | Number of total clicks for the campaign | 10 | **complaints** | **Long** | Number of complaints (Spam reports) for the campaign | 11 | **delivered** | **Long** | Number of delivered emails for the campaign | 12 | **sent** | **Long** | Number of sent emails for the campaign | 13 | **softBounces** | **Long** | Number of softbounce for the campaign | 14 | **hardBounces** | **Long** | Number of harbounce for the campaign | 15 | **uniqueViews** | **Long** | Number of unique openings for the campaign | 16 | **trackableViews** | **Long** | Recipients without any privacy protection option enabled in their email client | 17 | **trackableViewsRate** | **Float** | Rate of recipients without any privacy protection option enabled in their email client | [optional] 18 | **estimatedViews** | **Long** | Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails | [optional] 19 | **unsubscriptions** | **Long** | Number of unsubscription for the campaign | 20 | **viewed** | **Long** | Number of openings for the campaign | 21 | **deferred** | **Long** | Number of deferred emails for the campaign | [optional] 22 | **returnBounce** | **Long** | Total number of non-delivered campaigns for a particular campaign id. | [optional] 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/GetCategories.md: -------------------------------------------------------------------------------- 1 | 2 | # GetCategories 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **categories** | **List<Object>** | | 8 | **count** | **Long** | Number of categories | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetCategoryDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # GetCategoryDetails 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Category ID for which you requested the details | 8 | **name** | **String** | Name of the category for which you requested the details | 9 | **createdAt** | **String** | Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | 10 | **modifiedAt** | **String** | Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | 11 | **url** | **String** | URL to the category | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetChildAccountCreationStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildAccountCreationStatus 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **childAccountCreated** | **Boolean** | Status of child account creation whether it is successfully created (exists) or not. | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetChildDomain.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildDomain 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **domain** | **String** | Sender domain | [optional] 8 | **active** | **Boolean** | indicates whether a domain is verified or not | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildDomains.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildDomains 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildInfo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Login Email | 8 | **firstName** | **String** | First Name | 9 | **lastName** | **String** | Last Name | 10 | **companyName** | **String** | Name of the company | 11 | **credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional] 12 | **statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional] 13 | **password** | **String** | The encrypted password of child account | 14 | **ips** | **List<String>** | IP(s) associated to a child account user | [optional] 15 | **apiKeys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeys.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildInfoApiKeys 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **v2** | [**List<GetChildInfoApiKeysV2>**](GetChildInfoApiKeysV2.md) | | 8 | **v3** | [**List<GetChildInfoApiKeysV3>**](GetChildInfoApiKeysV3.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeysV2.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildInfoApiKeysV2 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the key for version 2 | 8 | **key** | **String** | API Key for version 2 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeysV3.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildInfoApiKeysV3 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the key for version 3 | 8 | **key** | **String** | API Key for version 3 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoCredits.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildInfoCredits 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **emailCredits** | **Long** | Email credits available for your child | [optional] 8 | **smsCredits** | **Long** | SMS credits available for your child | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoStatistics.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildInfoStatistics 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **previousMonthTotalSent** | **Long** | Overall emails sent for the previous month | [optional] 8 | **currentMonthTotalSent** | **Long** | Overall emails sent for current month | [optional] 9 | **totalSent** | **Long** | Overall emails sent for since the account exists | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetChildrenList.md: -------------------------------------------------------------------------------- 1 | 2 | # GetChildrenList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **children** | **List<Object>** | Your children's account information | [optional] 8 | **count** | **Long** | Number of child accounts | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetClient.md: -------------------------------------------------------------------------------- 1 | 2 | # GetClient 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Login Email | 8 | **firstName** | **String** | First Name | 9 | **lastName** | **String** | Last Name | 10 | **companyName** | **String** | Name of the company | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStats.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContactCampaignStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messagesSent** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 8 | **hardBounces** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 9 | **softBounces** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 10 | **complaints** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 11 | **unsubscriptions** | [**GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) | | [optional] 12 | **opened** | [**List<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) | | [optional] 13 | **clicked** | [**List<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) | | [optional] 14 | **transacAttributes** | [**List<GetContactCampaignStatsTransacAttributes>**](GetContactCampaignStatsTransacAttributes.md) | | [optional] 15 | **delivered** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsClicked.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContactCampaignStatsClicked 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **links** | [**List<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsOpened.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContactCampaignStatsOpened 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **count** | **Long** | Number of openings of the campaign | 9 | **eventTime** | **String** | UTC date-time of the event | 10 | **ip** | **String** | IP from which the user has opened the campaign | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsTransacAttributes.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContactCampaignStatsTransacAttributes 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **orderDate** | [**LocalDate**] | Date of the order | 8 | **orderPrice** | **Float** | Price of the order | 9 | **orderId** | **Long** | ID of the order | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsUnsubscriptions.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContactCampaignStatsUnsubscriptions 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **userUnsubscription** | [**List<GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email | 8 | **adminUnsubscription** | [**List<GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetContactDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContactDetails 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the contact for which you requested the details | 8 | **id** | **Long** | ID of the contact for which you requested the details | 9 | **emailBlacklisted** | **Boolean** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 10 | **smsBlacklisted** | **Boolean** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 11 | **createdAt** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **modifiedAt** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **listIds** | **List<Long>** | | 14 | **listUnsubscribed** | **List<Long>** | | [optional] 15 | **attributes** | **Object** | Set of attributes of the contact | 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetContacts.md: -------------------------------------------------------------------------------- 1 | 2 | # GetContacts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contacts** | **List<Object>** | | 8 | **count** | **Long** | Number of contacts | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetDeviceBrowserStats.md: -------------------------------------------------------------------------------- 1 | 2 | # GetDeviceBrowserStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **clickers** | **Long** | Number of total clicks for the campaign using the particular browser | 8 | **uniqueClicks** | **Long** | Number of unique clicks for the campaign using the particular browser | 9 | **viewed** | **Long** | Number of openings for the campaign using the particular browser | 10 | **uniqueViews** | **Long** | Number of unique openings for the campaign using the particular browser | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetEmailCampaigns.md: -------------------------------------------------------------------------------- 1 | 2 | # GetEmailCampaigns 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaigns** | **List<Object>** | | [optional] 8 | **count** | **Long** | Number of Email campaigns retrieved | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetEmailEventReport.md: -------------------------------------------------------------------------------- 1 | 2 | # GetEmailEventReport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **events** | [**List<GetEmailEventReportEvents>**](GetEmailEventReportEvents.md) | | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetEmailEventReportEvents.md: -------------------------------------------------------------------------------- 1 | 2 | # GetEmailEventReportEvents 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address which generates the event | 8 | **date** | **String** | UTC date-time on which the event has been generated | 9 | **subject** | **String** | Subject of the event | [optional] 10 | **messageId** | **String** | Message ID which generated the event | 11 | **event** | [**EventEnum**](#EventEnum) | Event which occurred | 12 | **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 13 | **tag** | **String** | Tag of the email which generated the event | [optional] 14 | **ip** | **String** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional] 15 | **link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional] 16 | **from** | **String** | Sender email from which the emails are sent | [optional] 17 | **templateId** | **Long** | ID of the template (only available if the email is template based) | [optional] 18 | 19 | 20 | 21 | ## Enum: EventEnum 22 | Name | Value 23 | ---- | ----- 24 | BOUNCES | "bounces" 25 | HARDBOUNCES | "hardBounces" 26 | SOFTBOUNCES | "softBounces" 27 | DELIVERED | "delivered" 28 | SPAM | "spam" 29 | REQUESTS | "requests" 30 | OPENED | "opened" 31 | CLICKS | "clicks" 32 | INVALID | "invalid" 33 | DEFERRED | "deferred" 34 | BLOCKED | "blocked" 35 | UNSUBSCRIBED | "unsubscribed" 36 | ERROR | "error" 37 | LOADEDBYPROXY | "loadedByProxy" 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignOverviewSender.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedCampaignOverviewSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Sender name of the campaign | [optional] 8 | **email** | **String** | Sender email of the campaign | [optional] 9 | **id** | **String** | Sender id of the campaign | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignStats.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedCampaignStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **globalStats** | **Object** | Overall statistics of the campaign | 8 | **campaignStats** | **List<Object>** | List-wise statistics of the campaign. | 9 | **mirrorClick** | **Long** | Number of clicks on mirror link | 10 | **remaining** | **Long** | Number of remaning emails to send | 11 | **linksStats** | **Object** | Statistics about the number of clicks for the links | 12 | **statsByDomain** | [**GetStatsByDomain**](GetStatsByDomain.md) | | 13 | **statsByDevice** | [**GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices | 14 | **statsByBrowser** | [**GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetExtendedClient.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedClient 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Login Email | 8 | **firstName** | **String** | First Name | 9 | **lastName** | **String** | Last Name | 10 | **companyName** | **String** | Name of the company | 11 | **address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetExtendedClientAddress.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedClientAddress 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **street** | **String** | Street information | 8 | **city** | **String** | City information | 9 | **zipCode** | **String** | Zip Code information | 10 | **country** | **String** | Country information | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetails 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the contact for which you requested the details | 8 | **id** | **Long** | ID of the contact for which you requested the details | 9 | **emailBlacklisted** | **Boolean** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 10 | **smsBlacklisted** | **Boolean** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 11 | **createdAt** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **modifiedAt** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **listIds** | **List<Long>** | | 14 | **listUnsubscribed** | **List<Long>** | | [optional] 15 | **attributes** | **Object** | Set of attributes of the contact | 16 | **statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatistics.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatistics 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messagesSent** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the sent campaign for the contact | [optional] 8 | **hardBounces** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the hardbounes generated by the contact | [optional] 9 | **softBounces** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the softbounes generated by the contact | [optional] 10 | **complaints** | [**List<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the complaints generated by the contact | [optional] 11 | **unsubscriptions** | [**GetExtendedContactDetailsStatisticsUnsubscriptions**](GetExtendedContactDetailsStatisticsUnsubscriptions.md) | | [optional] 12 | **opened** | [**List<GetExtendedContactDetailsStatisticsOpened>**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional] 13 | **clicked** | [**List<GetExtendedContactDetailsStatisticsClicked>**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional] 14 | **transacAttributes** | **List<Object>** | Listing of the transactional attributes for the contact | [optional] 15 | **delivered** | [**List<GetExtendedContactDetailsStatisticsDelivered>**](GetExtendedContactDetailsStatisticsDelivered.md) | Listing of the delivered campaign for the contact | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsClicked.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsClicked 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **links** | [**List<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsDelivered.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsDelivered 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **eventTime** | **String** | UTC date-time of the event | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsLinks.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsLinks 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **Long** | Number of clicks on this link for the campaign | 8 | **eventTime** | **String** | UTC date-time of the event | 9 | **ip** | **String** | IP from which the user has clicked on the link | 10 | **url** | **String** | URL of the clicked link | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsMessagesSent.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsMessagesSent 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **eventTime** | **String** | UTC date-time of the event | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsOpened.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsOpened 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **count** | **Long** | Number of openings for the campaign | 9 | **eventTime** | **String** | UTC date-time of the event | 10 | **ip** | **String** | IP from which the user has opened the email | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsUnsubscriptions 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **userUnsubscription** | [**List<GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign | 8 | **adminUnsubscription** | [**List<GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **eventTime** | **String** | UTC date-time of the event | 8 | **ip** | **String** | IP from which the user has been unsubscribed | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign which generated the event | 8 | **eventTime** | **String** | UTC date-time of the event | 9 | **ip** | **String** | IP from which the user has unsubscribed | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetExtendedList.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the list | 8 | **name** | **String** | Name of the list | 9 | **totalBlacklisted** | **Long** | Number of blacklisted contacts in the list | 10 | **totalSubscribers** | **Long** | Number of contacts in the list | 11 | **uniqueSubscribers** | **Long** | Number of unique contacts in the list | 12 | **folderId** | **Long** | ID of the folder | 13 | **createdAt** | **String** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | **campaignStats** | [**List<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional] 15 | **dynamicList** | **Boolean** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetExtendedListCampaignStats.md: -------------------------------------------------------------------------------- 1 | 2 | # GetExtendedListCampaignStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaignId** | **Long** | ID of the campaign | 8 | **stats** | [**GetCampaignStats**](GetCampaignStats.md) | | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetFolder.md: -------------------------------------------------------------------------------- 1 | 2 | # GetFolder 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the folder | 8 | **name** | **String** | Name of the folder | 9 | **totalBlacklisted** | **Long** | Number of blacklisted contacts in the folder | 10 | **totalSubscribers** | **Long** | Number of contacts in the folder | 11 | **uniqueSubscribers** | **Long** | Number of unique contacts in the folder | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetFolderLists.md: -------------------------------------------------------------------------------- 1 | 2 | # GetFolderLists 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **lists** | **List<Object>** | | [optional] 8 | **count** | **Long** | Number of lists in the folder | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetFolders.md: -------------------------------------------------------------------------------- 1 | 2 | # GetFolders 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **folders** | **List<Object>** | | [optional] 8 | **count** | **Long** | Number of folders available in your account | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEvents.md: -------------------------------------------------------------------------------- 1 | 2 | # GetInboundEmailEvents 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **events** | [**List<GetInboundEmailEventsEvents>**](GetInboundEmailEventsEvents.md) | | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuid.md: -------------------------------------------------------------------------------- 1 | 2 | # GetInboundEmailEventsByUuid 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **receivedAt** | [**OffsetDateTime**] | Date when email was received on SMTP relay | [optional] 8 | **deliveredAt** | [**OffsetDateTime**] | Date when email was delivered successfully to client’s webhook | [optional] 9 | **recipient** | **String** | Recipient’s email address | [optional] 10 | **sender** | **String** | Sender’s email address | [optional] 11 | **messageId** | **String** | Value of the Message-ID header. This will be present only after the processing is done. | [optional] 12 | **subject** | **String** | Value of the Subject header. This will be present only after the processing is done. | [optional] 13 | **attachments** | [**List<GetInboundEmailEventsByUuidAttachments>**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional] 14 | **logs** | [**List<GetInboundEmailEventsByUuidLogs>**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuidAttachments.md: -------------------------------------------------------------------------------- 1 | 2 | # GetInboundEmailEventsByUuidAttachments 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | filename specified in the Content-Disposition header of the attachment | [optional] 8 | **contentType** | **String** | value of the Content-Type header of the attachment | [optional] 9 | **contentId** | **String** | value of the Content-ID header of the attachment. | [optional] 10 | **contentLength** | **Integer** | size of the attachment in bytes | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuidLogs.md: -------------------------------------------------------------------------------- 1 | 2 | # GetInboundEmailEventsByUuidLogs 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **date** | [**OffsetDateTime**] | Date of the event | [optional] 8 | **type** | [**TypeEnum**](#TypeEnum) | Type of the event | [optional] 9 | 10 | 11 | 12 | ## Enum: TypeEnum 13 | Name | Value 14 | ---- | ----- 15 | RECEIVED | "received" 16 | PROCESSED | "processed" 17 | WEBHOOKFAILED | "webhookFailed" 18 | WEBHOOKDELIVERED | "webhookDelivered" 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsEvents.md: -------------------------------------------------------------------------------- 1 | 2 | # GetInboundEmailEventsEvents 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | [**UUID**](UUID.md) | UUID that can be used to fetch additional data | 8 | **date** | [**OffsetDateTime**] | Date when email was received on SMTP relay | 9 | **sender** | **String** | Sender’s email address | 10 | **recipient** | **String** | Recipient’s email address | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetIp.md: -------------------------------------------------------------------------------- 1 | 2 | # GetIp 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the dedicated IP | 8 | **ip** | **String** | Dedicated IP | 9 | **active** | **Boolean** | Status of the IP (true=active, false=inactive) | 10 | **domain** | **String** | Domain associated to the IP | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetIpFromSender.md: -------------------------------------------------------------------------------- 1 | 2 | # GetIpFromSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the dedicated IP | 8 | **ip** | **String** | Dedicated IP | 9 | **domain** | **String** | Domain associated to the IP | 10 | **weight** | **Long** | Weight of the IP | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetIps.md: -------------------------------------------------------------------------------- 1 | 2 | # GetIps 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ips** | [**List<GetIp>**](GetIp.md) | Dedicated IP(s) available on your account | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetIpsFromSender.md: -------------------------------------------------------------------------------- 1 | 2 | # GetIpsFromSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ips** | [**List<GetIpFromSender>**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetList.md: -------------------------------------------------------------------------------- 1 | 2 | # GetList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the list | 8 | **name** | **String** | Name of the list | 9 | **totalBlacklisted** | **Long** | Number of blacklisted contacts in the list | 10 | **totalSubscribers** | **Long** | Number of contacts in the list | 11 | **uniqueSubscribers** | **Long** | Number of unique contacts in the list | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetLists.md: -------------------------------------------------------------------------------- 1 | 2 | # GetLists 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **lists** | **List<Object>** | Listing of all the lists available in your account | [optional] 8 | **count** | **Long** | Number of lists in your account | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetProcess.md: -------------------------------------------------------------------------------- 1 | 2 | # GetProcess 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | Id of the process | 8 | **status** | [**StatusEnum**](#StatusEnum) | Status of the process | 9 | **name** | **String** | Process name | 10 | **exportUrl** | **String** | URL on which send export the of contacts once the process is completed | [optional] 11 | 12 | 13 | 14 | ## Enum: StatusEnum 15 | Name | Value 16 | ---- | ----- 17 | QUEUED | "queued" 18 | IN_PROCESS | "in_process" 19 | COMPLETED | "completed" 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetProcesses.md: -------------------------------------------------------------------------------- 1 | 2 | # GetProcesses 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **processes** | [**List<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional] 8 | **count** | **Long** | Number of processes available on your account | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetProductDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # GetProductDetails 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Product ID for which you requested the details | 8 | **name** | **String** | Name of the product for which you requested the details | 9 | **createdAt** | **String** | Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) | 10 | **modifiedAt** | **String** | Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) | 11 | **url** | **String** | URL to the product | [optional] 12 | **imageUrl** | **String** | Absolute URL to the cover image of the product | [optional] 13 | **sku** | **String** | Product identifier from the shop | [optional] 14 | **price** | **Float** | Price of the product | [optional] 15 | **categories** | **List<String>** | Category ID-s of the product | [optional] 16 | **parentId** | **String** | Parent product id of the product | [optional] 17 | **s3Original** | **String** | S3 url of original image | [optional] 18 | **s3ThumbAnalytics** | **String** | S3 thumbnail url of original image in 120x120 dimension for analytics section | 19 | **metaInfo** | **Object** | Meta data of product such as description, vendor, producer, stock level, etc. | [optional] 20 | **s3ThumbEditor** | **String** | S3 thumbnail url of original image in 600x400 dimension for editor section | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/GetProducts.md: -------------------------------------------------------------------------------- 1 | 2 | # GetProducts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **products** | **List<Object>** | | 8 | **count** | **Long** | Number of products | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetReports.md: -------------------------------------------------------------------------------- 1 | 2 | # GetReports 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **reports** | [**List<GetReportsReports>**](GetReportsReports.md) | | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetReportsReports.md: -------------------------------------------------------------------------------- 1 | 2 | # GetReportsReports 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **date** | [**LocalDate**] | Date of the statistics | 8 | **requests** | **Long** | Number of requests for the date | 9 | **delivered** | **Long** | Number of delivered emails for the date | 10 | **hardBounces** | **Long** | Number of hardbounces for the date | 11 | **softBounces** | **Long** | Number of softbounces for the date | 12 | **clicks** | **Long** | Number of clicks for the date | 13 | **uniqueClicks** | **Long** | Number of unique clicks for the date | 14 | **opens** | **Long** | Number of openings for the date | 15 | **uniqueOpens** | **Long** | Number of unique openings for the date | 16 | **spamReports** | **Long** | Number of complaints (spam reports) for the date | 17 | **blocked** | **Long** | Number of blocked emails for the date | 18 | **invalid** | **Long** | Number of invalid emails for the date | 19 | **unsubscribed** | **Long** | Number of unsubscribed emails for the date | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByBatchId.md: -------------------------------------------------------------------------------- 1 | 2 | # GetScheduledEmailByBatchId 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **Integer** | Total number of batches | [optional] 8 | **batches** | [**List<GetScheduledEmailByBatchIdBatches>**](GetScheduledEmailByBatchIdBatches.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByBatchIdBatches.md: -------------------------------------------------------------------------------- 1 | 2 | # GetScheduledEmailByBatchIdBatches 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **scheduledAt** | [**OffsetDateTime**] | Datetime for which the batch was scheduled | 8 | **createdAt** | [**OffsetDateTime**] | Datetime on which the batch was scheduled | 9 | **status** | [**StatusEnum**](#StatusEnum) | Current status of the scheduled batch | 10 | 11 | 12 | 13 | ## Enum: StatusEnum 14 | Name | Value 15 | ---- | ----- 16 | INPROGRESS | "inProgress" 17 | QUEUED | "queued" 18 | PROCESSED | "processed" 19 | ERROR | "error" 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByMessageId.md: -------------------------------------------------------------------------------- 1 | 2 | # GetScheduledEmailByMessageId 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **scheduledAt** | [**OffsetDateTime**] | Datetime for which the email was scheduled | 8 | **createdAt** | [**OffsetDateTime**] | Datetime on which the email was scheduled | 9 | **status** | [**StatusEnum**](#StatusEnum) | Current status of the scheduled email | 10 | 11 | 12 | 13 | ## Enum: StatusEnum 14 | Name | Value 15 | ---- | ----- 16 | INPROGRESS | "inProgress" 17 | QUEUED | "queued" 18 | PROCESSED | "processed" 19 | ERROR | "error" 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetSendersList.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSendersList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **senders** | [**List<GetSendersListSenders>**](GetSendersListSenders.md) | List of the senders available in your account | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSendersListIps.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSendersListIps 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ip** | **String** | Dedicated IP available in your account | 8 | **domain** | **String** | Domain of the IP | 9 | **weight** | **Long** | Weight of the IP for this sender | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetSendersListSenders.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSendersListSenders 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | Id of the sender | 8 | **name** | **String** | From Name associated to the sender | 9 | **email** | **String** | From Email associated to the sender | 10 | **active** | **Boolean** | Status of sender (true=activated, false=deactivated) | 11 | **ips** | [**List<GetSendersListIps>**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetSharedTemplateUrl.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSharedTemplateUrl 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sharedUrl** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSmsCampaign.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmsCampaign 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the SMS Campaign | 8 | **name** | **String** | Name of the SMS Campaign | 9 | **status** | [**StatusEnum**](#StatusEnum) | Status of the SMS Campaign | 10 | **content** | **String** | Content of the SMS Campaign | 11 | **scheduledAt** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 12 | **sender** | **String** | Sender of the SMS Campaign | 13 | **createdAt** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | **modifiedAt** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 15 | **recipients** | **Object** | | 16 | **statistics** | **Object** | | 17 | 18 | 19 | 20 | ## Enum: StatusEnum 21 | Name | Value 22 | ---- | ----- 23 | DRAFT | "draft" 24 | SENT | "sent" 25 | ARCHIVE | "archive" 26 | QUEUED | "queued" 27 | SUSPENDED | "suspended" 28 | INPROCESS | "inProcess" 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignOverview.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmsCampaignOverview 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the SMS Campaign | 8 | **name** | **String** | Name of the SMS Campaign | 9 | **status** | [**StatusEnum**](#StatusEnum) | Status of the SMS Campaign | 10 | **content** | **String** | Content of the SMS Campaign | 11 | **scheduledAt** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 12 | **sender** | **String** | Sender of the SMS Campaign | 13 | **createdAt** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | **modifiedAt** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 15 | 16 | 17 | 18 | ## Enum: StatusEnum 19 | Name | Value 20 | ---- | ----- 21 | DRAFT | "draft" 22 | SENT | "sent" 23 | ARCHIVE | "archive" 24 | QUEUED | "queued" 25 | SUSPENDED | "suspended" 26 | INPROCESS | "inProcess" 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignStats.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmsCampaignStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **delivered** | **Long** | Number of delivered SMS | 8 | **sent** | **Long** | Number of sent SMS | 9 | **processing** | **Long** | Number of processing SMS | 10 | **softBounces** | **Long** | Number of softbounced SMS | 11 | **hardBounces** | **Long** | Number of hardbounced SMS | 12 | **unsubscriptions** | **Long** | Number of unsubscription SMS | 13 | **answered** | **Long** | Number of replies to the SMS | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetSmsCampaigns.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmsCampaigns 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **campaigns** | **List<Object>** | | [optional] 8 | **count** | **Long** | Number of SMS campaigns retrieved | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetSmsEventReport.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmsEventReport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **events** | [**List<GetSmsEventReportEvents>**](GetSmsEventReportEvents.md) | | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSmsEventReportEvents.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmsEventReportEvents 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phoneNumber** | **String** | Phone number which has generated the event | [optional] 8 | **date** | **String** | UTC date-time on which the event has been generated | [optional] 9 | **messageId** | **String** | Message ID which generated the event | [optional] 10 | **event** | [**EventEnum**](#EventEnum) | Event which occurred | [optional] 11 | **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 12 | **reply** | **String** | | [optional] 13 | **tag** | **String** | Tag of the SMS which generated the event | [optional] 14 | 15 | 16 | 17 | ## Enum: EventEnum 18 | Name | Value 19 | ---- | ----- 20 | BOUNCES | "bounces" 21 | HARDBOUNCES | "hardBounces" 22 | SOFTBOUNCES | "softBounces" 23 | DELIVERED | "delivered" 24 | SENT | "sent" 25 | ACCEPTED | "accepted" 26 | UNSUBSCRIPTION | "unsubscription" 27 | REPLIES | "replies" 28 | BLOCKED | "blocked" 29 | REJECTED | "rejected" 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplateOverview.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmtpTemplateOverview 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the template | 8 | **name** | **String** | Name of the template | 9 | **subject** | **String** | Subject of the template | 10 | **isActive** | **Boolean** | Status of template (true=active, false=inactive) | 11 | **testSent** | **Boolean** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) | 12 | **sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | | 13 | **replyTo** | **String** | Email defined as the "Reply to" for the template | 14 | **toField** | **String** | Customisation of the "to" field for the template | 15 | **tag** | **String** | Tag of the template | 16 | **htmlContent** | **String** | HTML content of the template | 17 | **createdAt** | **String** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 18 | **modifiedAt** | **String** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 19 | **doiTemplate** | **Boolean** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplateOverviewSender.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmtpTemplateOverviewSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | From email for the template | [optional] 8 | **email** | **String** | From email for the template | [optional] 9 | **id** | **String** | Sender id of the template | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplates.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSmtpTemplates 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **Long** | Count of transactional email templates | [optional] 8 | **templates** | [**List<GetSmtpTemplateOverview>**](GetSmtpTemplateOverview.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetSsoToken.md: -------------------------------------------------------------------------------- 1 | 2 | # GetSsoToken 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **token** | **String** | Session token, it will remain valid for 15 days. | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetStatsByBrowser.md: -------------------------------------------------------------------------------- 1 | 2 | # GetStatsByBrowser 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetStatsByDevice.md: -------------------------------------------------------------------------------- 1 | 2 | # GetStatsByDevice 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **desktop** | [**Map<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] 8 | **mobile** | [**Map<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] 9 | **tablet** | [**Map<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] 10 | **unknown** | [**Map<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetStatsByDomain.md: -------------------------------------------------------------------------------- 1 | 2 | # GetStatsByDomain 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetTransacAggregatedSmsReport.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacAggregatedSmsReport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **range** | **String** | Time frame of the report | [optional] 8 | **requests** | **Long** | Number of requests for the timeframe | [optional] 9 | **delivered** | **Long** | Number of delivered SMS for the timeframe | [optional] 10 | **hardBounces** | **Long** | Number of hardbounces for the timeframe | [optional] 11 | **softBounces** | **Long** | Number of softbounces for the timeframe | [optional] 12 | **blocked** | **Long** | Number of blocked contact for the timeframe | [optional] 13 | **unsubscribed** | **Long** | Number of unsubscription for the timeframe | [optional] 14 | **replied** | **Long** | Number of answered SMS for the timeframe | [optional] 15 | **accepted** | **Long** | Number of accepted for the timeframe | [optional] 16 | **rejected** | **Long** | Number of rejected for the timeframe | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContacts.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacBlockedContacts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **Long** | Count of blocked or unsubscribed contact | [optional] 8 | **contacts** | [**List<GetTransacBlockedContactsContacts>**](GetTransacBlockedContactsContacts.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContactsContacts.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacBlockedContactsContacts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the blocked or unsubscribed contact | 8 | **senderEmail** | **String** | Sender email address of the blocked or unsubscribed contact | 9 | **reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | | 10 | **blockedAt** | **String** | Date when the contact was blocked or unsubscribed on | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContactsReason.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacBlockedContactsReason 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | [**CodeEnum**](#CodeEnum) | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional] 8 | **message** | **String** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional] 9 | 10 | 11 | 12 | ## Enum: CodeEnum 13 | Name | Value 14 | ---- | ----- 15 | UNSUBSCRIBEDVIAMA | "unsubscribedViaMA" 16 | UNSUBSCRIBEDVIAEMAIL | "unsubscribedViaEmail" 17 | ADMINBLOCKED | "adminBlocked" 18 | UNSUBSCRIBEDVIAAPI | "unsubscribedViaApi" 19 | HARDBOUNCE | "hardBounce" 20 | CONTACTFLAGGEDASSPAM | "contactFlaggedAsSpam" 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/GetTransacEmailContent.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacEmailContent 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address to which transactional email has been sent | 8 | **subject** | **String** | Subject of the sent email | 9 | **templateId** | **Long** | Id of the template | [optional] 10 | **date** | **String** | Date on which transactional email was sent | 11 | **events** | [**List<GetTransacEmailContentEvents>**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email | 12 | **body** | **String** | Actual content of the transactional email that has been sent | 13 | **attachmentCount** | **Long** | Count of the attachments that were sent in the email | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetTransacEmailContentEvents.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacEmailContentEvents 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the event that occurred on the sent email | 8 | **time** | **String** | Time at which the event occurred | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacEmailsList.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacEmailsList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **Long** | Total number of transactional emails available on your account according to the passed filter | [optional] 8 | **transactionalEmails** | [**List<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacEmailsListTransactionalEmails.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacEmailsListTransactionalEmails 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address to which transactional email has been sent | 8 | **subject** | **String** | Subject of the sent email | 9 | **templateId** | **Long** | Id of the template | [optional] 10 | **messageId** | **String** | Message Id of the sent email | 11 | **uuid** | **String** | Unique id of the email sent to a particular contact | 12 | **date** | **String** | Date on which transactional email was sent | 13 | **from** | **String** | Email address of the sender from which the email was sent | [optional] 14 | **tags** | **List<String>** | Tags used for your email | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetTransacSmsReport.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacSmsReport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **reports** | [**List<GetTransacSmsReportReports>**](GetTransacSmsReportReports.md) | | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetTransacSmsReportReports.md: -------------------------------------------------------------------------------- 1 | 2 | # GetTransacSmsReportReports 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **date** | [**LocalDate**] | Date for which statistics are retrieved | [optional] 8 | **requests** | **Long** | Number of requests for the date | [optional] 9 | **delivered** | **Long** | Number of delivered SMS for the date | [optional] 10 | **hardBounces** | **Long** | Number of hardbounces for the date | [optional] 11 | **softBounces** | **Long** | Number of softbounces for the date | [optional] 12 | **blocked** | **Long** | Number of blocked contact for the date | [optional] 13 | **unsubscribed** | **Long** | Number of unsubscription for the date | [optional] 14 | **replied** | **Long** | Number of answered SMS for the date | [optional] 15 | **accepted** | **Long** | Number of accepted for the date | [optional] 16 | **rejected** | **Long** | Number of rejected for the date | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetWebhook.md: -------------------------------------------------------------------------------- 1 | 2 | # GetWebhook 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **String** | URL of the webhook | 8 | **id** | **Long** | ID of the webhook | 9 | **description** | **String** | Description of the webhook | 10 | **events** | **List<String>** | | 11 | **type** | [**TypeEnum**](#TypeEnum) | Type of webhook (marketing or transactional) | 12 | **createdAt** | **String** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **modifiedAt** | **String** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | 15 | 16 | 17 | ## Enum: TypeEnum 18 | Name | Value 19 | ---- | ----- 20 | MARKETING | "marketing" 21 | TRANSACTIONAL | "transactional" 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/GetWebhooks.md: -------------------------------------------------------------------------------- 1 | 2 | # GetWebhooks 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **webhooks** | **List<Object>** | | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetWhatsappCampaignOverview.md: -------------------------------------------------------------------------------- 1 | 2 | # GetWhatsappCampaignOverview 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | ID of the Whatsapp Campaign | 8 | **campaignName** | **String** | Name of the Whatsapp Campaign | 9 | **campaignStatus** | [**CampaignStatusEnum**](#CampaignStatusEnum) | Status of the Whatsapp Campaign | 10 | **scheduledAt** | **String** | UTC date-time on which Whatsapp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 11 | **senderNumber** | **String** | Sender of the Whatsapp Campaign | 12 | **stats** | [**WhatsappCampStats**](WhatsappCampStats.md) | | [optional] 13 | **template** | [**WhatsappCampTemplate**](WhatsappCampTemplate.md) | | 14 | **createdAt** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 15 | **modifiedAt** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 16 | 17 | 18 | 19 | ## Enum: CampaignStatusEnum 20 | Name | Value 21 | ---- | ----- 22 | DRAFT | "draft" 23 | SCHEDULED | "scheduled" 24 | PENDING | "pending" 25 | APPROVED | "approved" 26 | RUNNING | "running" 27 | SUSPENDED | "suspended" 28 | REJECTED | "rejected" 29 | SENT | "sent" 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | 2 | # InlineResponse200 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique company id | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InlineResponse201.md: -------------------------------------------------------------------------------- 1 | 2 | # InlineResponse201 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique deal id | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InlineResponse2011.md: -------------------------------------------------------------------------------- 1 | 2 | # InlineResponse2011 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique task id | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ManageIp.md: -------------------------------------------------------------------------------- 1 | 2 | # ManageIp 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ip** | **String** | Dedicated ID | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # MasterDetailsResponse 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email id of master account | [optional] 8 | **companyName** | **String** | Company name of master account organization | [optional] 9 | **id** | **Long** | Unique identifier of the master account organization | [optional] 10 | **currencyCode** | **String** | Currency code of the master account organization | [optional] 11 | **timezone** | **String** | Timezone of the master account organization | [optional] 12 | **billingInfo** | [**MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) | | [optional] 13 | **planInfo** | [**MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) | | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # MasterDetailsResponseBillingInfo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Billing email id of master account | [optional] 8 | **companyName** | **String** | Company name of master account | [optional] 9 | **name** | [**MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) | | [optional] 10 | **address** | [**MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) | | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfoAddress.md: -------------------------------------------------------------------------------- 1 | 2 | # MasterDetailsResponseBillingInfoAddress 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **streetAddress** | **String** | Street address | [optional] 8 | **locality** | **String** | Locality | [optional] 9 | **postalCode** | **String** | Postal code | [optional] 10 | **stateCode** | **String** | State code | [optional] 11 | **countryCode** | **String** | Country code | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfoName.md: -------------------------------------------------------------------------------- 1 | 2 | # MasterDetailsResponseBillingInfoName 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **givenName** | **String** | First name for billing | [optional] 8 | **familyName** | **String** | Last name for billing | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponsePlanInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # MasterDetailsResponsePlanInfo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **currencyCode** | **String** | Plan currency | [optional] 8 | **nextBillingAt** | **Long** | Timestamp of next billing date | [optional] 9 | **price** | [**BigDecimal**](BigDecimal.md) | Plan amount | [optional] 10 | **planPeriod** | [**PlanPeriodEnum**](#PlanPeriodEnum) | Plan period type | [optional] 11 | **subAccounts** | **Integer** | Number of sub-accounts | [optional] 12 | **features** | [**List<MasterDetailsResponsePlanInfoFeatures>**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional] 13 | 14 | 15 | 16 | ## Enum: PlanPeriodEnum 17 | Name | Value 18 | ---- | ----- 19 | MONTH | "month" 20 | YEAR | "year" 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponsePlanInfoFeatures.md: -------------------------------------------------------------------------------- 1 | 2 | # MasterDetailsResponsePlanInfoFeatures 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the feature | [optional] 8 | **unitValue** | **String** | Unit value of the feature | [optional] 9 | **quantity** | **Long** | Quantity provided in the plan | [optional] 10 | **used** | **Long** | Quantity consumed by master | [optional] 11 | **remaining** | **Long** | Quantity remaining in the plan | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Note.md: -------------------------------------------------------------------------------- 1 | 2 | # Note 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique note Id | [optional] 8 | **text** | **String** | Text content of a note | 9 | **contactIds** | **List<Integer>** | Contact ids linked to a note | [optional] 10 | **dealIds** | **List<String>** | Deal ids linked to a note | [optional] 11 | **authorId** | **Object** | Account details of user which created the note | [optional] 12 | **createdAt** | [**OffsetDateTime**] | Note created date/time | [optional] 13 | **updatedAt** | [**OffsetDateTime**] | Note updated date/time | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/NoteData.md: -------------------------------------------------------------------------------- 1 | 2 | # NoteData 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **text** | **String** | Text content of a note | 8 | **contactIds** | **List<Integer>** | Contact Ids linked to a note | [optional] 9 | **dealIds** | **List<String>** | Deal Ids linked to a note | [optional] 10 | **companyIds** | **List<String>** | Company Ids linked to a note | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/NoteId.md: -------------------------------------------------------------------------------- 1 | 2 | # NoteId 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique note Id | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/NoteList.md: -------------------------------------------------------------------------------- 1 | 2 | # NoteList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Order.md: -------------------------------------------------------------------------------- 1 | 2 | # Order 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique ID of the order. | 8 | **createdAt** | **String** | Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. | 9 | **updatedAt** | **String** | Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. | 10 | **status** | **String** | State of the order. | 11 | **amount** | [**BigDecimal**](BigDecimal.md) | Total amount of the order, including all shipping expenses, tax and the price of items. | 12 | **products** | [**List<OrderProducts>**](OrderProducts.md) | | 13 | **email** | **String** | Email of the contact, Mandatory if "phone" field is not passed in "billing" parameter. | [optional] 14 | **billing** | [**OrderBilling**](OrderBilling.md) | | [optional] 15 | **coupons** | **List<String>** | Coupons applied to the order. Stored case insensitive. | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/OrderBatch.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderBatch 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **orders** | [**List<Order>**](Order.md) | array of order objects | 8 | **notifyUrl** | **String** | Notify Url provided by client to get the status of batch request | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/OrderBilling.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderBilling 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | **String** | Full billing address. | [optional] 8 | **city** | **String** | Exact city of the address. | [optional] 9 | **countryCode** | **String** | Billing country 2-letter ISO code. | [optional] 10 | **phone** | **String** | Phone number to contact for further details about the order, Mandatory if "email" field is not passed. | [optional] 11 | **postCode** | **String** | Postcode for delivery and billing. | [optional] 12 | **paymentMethod** | **String** | How the visitor will pay for the item(s), e.g. paypal, check, etc. | [optional] 13 | **region** | **String** | Exact region (state/province) for delivery and billing. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderProducts.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderProducts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **productId** | **String** | ID of the product. | 8 | **quantity** | [**BigDecimal**](BigDecimal.md) | How many pieces of the product the visitor has added to the cart. | 9 | **variantId** | **String** | Product ID of the red color shirts. | [optional] 10 | **price** | [**BigDecimal**](BigDecimal.md) | The price of a unit of product | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Pipeline.md: -------------------------------------------------------------------------------- 1 | 2 | # Pipeline 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **stages** | [**List<PipelineStage>**](PipelineStage.md) | List of stages | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PipelineStage.md: -------------------------------------------------------------------------------- 1 | 2 | # PipelineStage 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Stage id | [optional] 8 | **name** | **String** | Stage name | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PostContactInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # PostContactInfo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) | | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PostContactInfoContacts.md: -------------------------------------------------------------------------------- 1 | 2 | # PostContactInfoContacts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **success** | **List<String>** | | [optional] 8 | **failure** | **List<String>** | | [optional] 9 | **total** | **Long** | Displays the count of total number of contacts removed from list when user opts for "all" option. | [optional] 10 | **processId** | **Long** | Id of the process created to remove contacts from list when user opts for "all" option. | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PostSendFailed.md: -------------------------------------------------------------------------------- 1 | 2 | # PostSendFailed 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **Long** | Response code | 8 | **message** | **String** | Response message | 9 | **unexistingEmails** | **List<String>** | | [optional] 10 | **withoutListEmails** | **List<String>** | | [optional] 11 | **blackListedEmails** | **List<String>** | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/PostSendSmsTestFailed.md: -------------------------------------------------------------------------------- 1 | 2 | # PostSendSmsTestFailed 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **Long** | Response code | 8 | **message** | **String** | Response message | 9 | **unexistingSms** | **List<String>** | | [optional] 10 | **withoutListSms** | **List<String>** | | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RemainingCreditModel.md: -------------------------------------------------------------------------------- 1 | 2 | # RemainingCreditModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) | | 8 | **reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemainingCreditModelChild.md: -------------------------------------------------------------------------------- 1 | 2 | # RemainingCreditModelChild 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sms** | **Double** | SMS Credits remaining for child account | 8 | **email** | **Double** | Email Credits remaining for child account | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemainingCreditModelReseller.md: -------------------------------------------------------------------------------- 1 | 2 | # RemainingCreditModelReseller 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sms** | **Double** | SMS Credits remaining for reseller account | 8 | **email** | **Double** | Email Credits remaining for reseller account | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemoveContactFromList.md: -------------------------------------------------------------------------------- 1 | 2 | # RemoveContactFromList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **emails** | **List<String>** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] 8 | **ids** | **List<Long>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 9 | **all** | **Boolean** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RemoveCredits.md: -------------------------------------------------------------------------------- 1 | 2 | # RemoveCredits 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sms** | **Long** | Required if email credits are empty. SMS credits to be removed from the child account | [optional] 8 | **email** | **Long** | Required if sms credits are empty. Email credits to be removed from the child account | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RequestContactExport.md: -------------------------------------------------------------------------------- 1 | 2 | # RequestContactExport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **exportAttributes** | **List<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] 8 | **customContactFilter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | 9 | **notifyUrl** | **String** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RequestContactImport.md: -------------------------------------------------------------------------------- 1 | 2 | # RequestContactImport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **fileUrl** | **String** | Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json | [optional] 8 | **fileBody** | **String** | Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] 9 | **jsonBody** | [**List<Map<String, Object>>**](Map.md) | **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. | [optional] 10 | **listIds** | **List<Long>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] 11 | **notifyUrl** | **String** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 12 | **newList** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] 13 | **emailBlacklist** | **Boolean** | To blacklist all the contacts for email | [optional] 14 | **smsBlacklist** | **Boolean** | To blacklist all the contacts for sms | [optional] 15 | **updateExistingContacts** | **Boolean** | To facilitate the choice to update the existing contacts | [optional] 16 | **emptyContactsAttributes** | **Boolean** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/RequestContactImportNewList.md: -------------------------------------------------------------------------------- 1 | 2 | # RequestContactImportNewList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **listName** | **String** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] 8 | **folderId** | **Long** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RequestSmsRecipientExport.md: -------------------------------------------------------------------------------- 1 | 2 | # RequestSmsRecipientExport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **notifyURL** | **String** | URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 8 | **recipientsType** | [**RecipientsTypeEnum**](#RecipientsTypeEnum) | Filter the recipients based on how they interacted with the campaign | 9 | 10 | 11 | 12 | ## Enum: RecipientsTypeEnum 13 | Name | Value 14 | ---- | ----- 15 | ALL | "all" 16 | DELIVERED | "delivered" 17 | ANSWERED | "answered" 18 | SOFTBOUNCES | "softBounces" 19 | HARDBOUNCES | "hardBounces" 20 | UNSUBSCRIBED | "unsubscribed" 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ScheduleSmtpEmail.md: -------------------------------------------------------------------------------- 1 | 2 | # ScheduleSmtpEmail 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **messageId** | **String** | Message ID of the transactional email scheduled | [optional] 8 | **messageIds** | **List<String>** | | [optional] 9 | **batchId** | **String** | Batch ID of the batch transactional email scheduled | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SendReport.md: -------------------------------------------------------------------------------- 1 | 2 | # SendReport 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **language** | [**LanguageEnum**](#LanguageEnum) | Language of email content for campaign report sending. | [optional] 8 | **email** | [**SendReportEmail**](SendReportEmail.md) | | 9 | 10 | 11 | 12 | ## Enum: LanguageEnum 13 | Name | Value 14 | ---- | ----- 15 | FR | "fr" 16 | ES | "es" 17 | PT | "pt" 18 | IT | "it" 19 | DE | "de" 20 | EN | "en" 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/SendReportEmail.md: -------------------------------------------------------------------------------- 1 | 2 | # SendReportEmail 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **to** | **List<String>** | Email addresses of the recipients | 8 | **body** | **String** | Custom text message to be presented in the report email. | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSms.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSms 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **reference** | **String** | | 8 | **messageId** | **Long** | | 9 | **smsCount** | **Long** | Count of SMS's to send multiple text messages | [optional] 10 | **usedCredits** | **Float** | SMS credits used per text message | [optional] 11 | **remainingCredits** | **Float** | Remaining SMS credits of the user | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailAttachment.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailAttachment 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **String** | Absolute url of the attachment (no local file). | [optional] 8 | **content** | **byte[]** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 9 | **name** | **String** | Required if content is passed. Name of the attachment | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailBcc.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailBcc 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the recipient in bcc | 8 | **name** | **String** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailCc.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailCc 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the recipient in cc | 8 | **name** | **String** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailMessageVersions.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailMessageVersions 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **to** | [**List<SendSmtpEmailTo1>**](SendSmtpEmailTo1.md) | List of email addresses and names (_optional_) of the recipients. For example, [{"name":"Jimmy", "email":"jimmy98@example.com"}, {"name":"Joe", "email":"joe@example.com"}] | 8 | **params** | **Map<String, Object>** | Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. It's considered only if template is in New Template Language format. | [optional] 9 | **bcc** | [**List<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] 10 | **cc** | [**List<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] 11 | **replyTo** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional] 12 | **subject** | **String** | Custom subject specific to message version | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailReplyTo.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailReplyTo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address in reply to | 8 | **name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailReplyTo1.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailReplyTo1 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address in reply to | 8 | **name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailSender.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. | [optional] 8 | **email** | **String** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional] 9 | **id** | **Long** | Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailTo.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailTo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the recipient | 8 | **name** | **String** | Name of the recipient. Maximum allowed characters are 70. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailTo1.md: -------------------------------------------------------------------------------- 1 | 2 | # SendSmtpEmailTo1 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the recipient | 8 | **name** | **String** | Name of the recipient. **Maximum allowed characters are 70**. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendTestEmail.md: -------------------------------------------------------------------------------- 1 | 2 | # SendTestEmail 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **emailTo** | **List<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SendTestSms.md: -------------------------------------------------------------------------------- 1 | 2 | # SendTestSms 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phoneNumber** | **String** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SendTransacSms.md: -------------------------------------------------------------------------------- 1 | 2 | # SendTransacSms 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | 8 | **recipient** | **String** | Mobile number to send SMS with the country code | 9 | **content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages | 10 | **type** | [**TypeEnum**](#TypeEnum) | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] 11 | **tag** | **String** | Tag of the message | [optional] 12 | **webUrl** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] 13 | **unicodeEnabled** | **Boolean** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] 14 | **organisationPrefix** | **String** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] 15 | 16 | 17 | 18 | ## Enum: TypeEnum 19 | Name | Value 20 | ---- | ----- 21 | TRANSACTIONAL | "transactional" 22 | MARKETING | "marketing" 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/SsoTokenRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # SsoTokenRequest 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | Id of the sub-account organization | 8 | **email** | **String** | User email of sub-account organization | [optional] 9 | **target** | [**TargetEnum**](#TargetEnum) | Set target after login success * automation - Redirect to Automation after login * email_campaign - Redirect to Email Campaign after login * contacts - Redirect to Contacts after login * landing_pages - Redirect to Landing Pages after login * email_transactional - Redirect to Email Transactional after login * senders - Redirect to Contacts after login * sms_campaign - Redirect to Sms Campaign after login * sms_transactional - Redirect to Sms Transactional after login | [optional] 10 | 11 | 12 | 13 | ## Enum: TargetEnum 14 | Name | Value 15 | ---- | ----- 16 | AUTOMATION | "automation" 17 | EMAIL_CAMPAIGN | "email_campaign" 18 | CONTACTS | "contacts" 19 | LANDING_PAGES | "landing_pages" 20 | EMAIL_TRANSACTIONAL | "email_transactional" 21 | SENDERS | "senders" 22 | SMS_CAMPAIGN | "sms_campaign" 23 | SMS_TRANSACTIONAL | "sms_transactional" 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponse 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the sub-account user | [optional] 8 | **email** | **String** | Email id of the sub-account organization | [optional] 9 | **companyName** | **String** | Sub-account company name | [optional] 10 | **planInfo** | [**SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) | | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfo 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **credits** | [**SubAccountDetailsResponsePlanInfoCredits**](SubAccountDetailsResponsePlanInfoCredits.md) | | [optional] 8 | **features** | [**SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) | | [optional] 9 | **planType** | **String** | type of the plan | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoCredits.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfoCredits 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sms** | **Long** | SMS credits remaining on the sub-account | [optional] 8 | **emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfoCreditsEmails 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **quantity** | **Long** | Quantity of email messaging limits provided | [optional] 8 | **remaining** | **Long** | Available email messaging limits for use | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeatures.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfoFeatures 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **inbox** | [**SubAccountDetailsResponsePlanInfoFeaturesInbox**](SubAccountDetailsResponsePlanInfoFeaturesInbox.md) | | [optional] 8 | **landingPage** | [**SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) | | [optional] 9 | **users** | [**SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesUsers.md) | | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfoFeaturesInbox 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **quantity** | **Long** | Quantity of inbox provided | [optional] 8 | **remaining** | **Long** | Available inboxes for use | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfoFeaturesLandingPage 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **quantity** | **Long** | Quantity of landing pages provided | [optional] 8 | **remaining** | **Long** | Available landing pages for use | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountDetailsResponsePlanInfoFeaturesUsers 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **quantity** | **Long** | Quantity of multi-account's provided | [optional] 8 | **remaining** | **Long** | Available multi-accounts for use | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountUpdatePlanRequest 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **credits** | [**SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) | | [optional] 8 | **features** | [**SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequestCredits.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountUpdatePlanRequestCredits 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **Long** | Number of email credits | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequestFeatures.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountUpdatePlanRequestFeatures 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **users** | **Long** | Number of multi-users | [optional] 8 | **landingPage** | **Long** | Number of landing pages | [optional] 9 | **inbox** | **Long** | Number of inboxes | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountsResponse 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **Integer** | Total number of subaccounts | [optional] 8 | **subAccounts** | [**List<SubAccountsResponseSubAccounts>**](SubAccountsResponseSubAccounts.md) | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountsResponseSubAccounts.md: -------------------------------------------------------------------------------- 1 | 2 | # SubAccountsResponseSubAccounts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **Long** | id of the sub-account | 8 | **companyName** | **String** | Name of the sub-account company | 9 | **active** | **Boolean** | Whether the sub-account is active or not | 10 | **createdAt** | **Long** | Timestamp when the sub-account was created | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Task.md: -------------------------------------------------------------------------------- 1 | 2 | # Task 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Unique task id | [optional] 8 | **taskTypeId** | **String** | Id for type of task e.g Call / Email / Meeting etc. | 9 | **name** | **String** | Name of task | 10 | **contactsIds** | **List<Integer>** | Contact ids for contacts linked to this task | [optional] 11 | **dealsIds** | **List<String>** | Deal ids for deals a task is linked to | [optional] 12 | **companiesIds** | **List<String>** | Companies ids for companies a task is linked to | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TaskList.md: -------------------------------------------------------------------------------- 1 | 2 | # TaskList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **items** | [**List<Task>**](Task.md) | List of tasks | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/TaskReminder.md: -------------------------------------------------------------------------------- 1 | 2 | # TaskReminder 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **Integer** | Value of time unit before reminder is to be sent | 8 | **unit** | [**UnitEnum**](#UnitEnum) | Unit of time before reminder is to be sent | 9 | **types** | **List<String>** | Type of task reminder e.g email, push | 10 | 11 | 12 | 13 | ## Enum: UnitEnum 14 | Name | Value 15 | ---- | ----- 16 | MINUTES | "minutes" 17 | HOURS | "hours" 18 | WEEKS | "weeks" 19 | DAYS | "days" 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/TaskTypes.md: -------------------------------------------------------------------------------- 1 | 2 | # TaskTypes 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **String** | Id of task type | [optional] 8 | **title** | **String** | Title of task type | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateAttribute.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateAttribute 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **String** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] 8 | **enumeration** | [**List<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is "category". For example, [{"value":1, "label":"male"}, {"value":2, "label":"female"}] | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateAttributeEnumeration 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **Integer** | Id of the value | 8 | **label** | **String** | Label of the value | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateBatchContacts.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateBatchContacts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contacts** | [**List<UpdateBatchContactsContacts>**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateBatchContactsContacts.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateBatchContactsContacts 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 8 | **id** | **Long** | id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 9 | **sms** | **String** | SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 10 | **attributes** | **Map<String, Object>** | Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}** | [optional] 11 | **emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] 12 | **smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 13 | **listIds** | **List<Long>** | Ids of the lists to add the contact to | [optional] 14 | **unlinkListIds** | **List<Long>** | Ids of the lists to remove the contact from | [optional] 15 | **smtpBlacklistSender** | **List<String>** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/UpdateBatchContactsModel.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateBatchContactsModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **successIds** | **List<Long>** | | [optional] 8 | **failureIds** | **List<Long>** | | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateCampaignStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateCampaignStatus 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | [**StatusEnum**](#StatusEnum) | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] 8 | 9 | 10 | 11 | ## Enum: StatusEnum 12 | Name | Value 13 | ---- | ----- 14 | SUSPENDED | "suspended" 15 | ARCHIVE | "archive" 16 | DARCHIVE | "darchive" 17 | SENT | "sent" 18 | QUEUED | "queued" 19 | REPLICATE | "replicate" 20 | REPLICATETEMPLATE | "replicateTemplate" 21 | DRAFT | "draft" 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/UpdateChild.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateChild 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **String** | New Email address to update the child account | [optional] 8 | **firstName** | **String** | New First name to use to update the child account | [optional] 9 | **lastName** | **String** | New Last name to use to update the child account | [optional] 10 | **companyName** | **String** | New Company name to use to update the child account | [optional] 11 | **password** | **String** | New password for the child account to login | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UpdateChildAccountStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateChildAccountStatus 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **transactionalEmail** | **Boolean** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] 8 | **transactionalSms** | **Boolean** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] 9 | **marketingAutomation** | **Boolean** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] 10 | **smsCampaign** | **Boolean** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional] 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UpdateChildDomain.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateChildDomain 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **domain** | **String** | Value for the sender domain that will replace the existing domain | [optional] 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateContact.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateContact 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} | [optional] 8 | **emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] 9 | **smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 10 | **listIds** | **List<Long>** | Ids of the lists to add the contact to | [optional] 11 | **unlinkListIds** | **List<Long>** | Ids of the lists to remove the contact from | [optional] 12 | **smtpBlacklistSender** | **List<String>** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateEmailCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateEmailCampaignRecipients 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **exclusionListIds** | **List<Long>** | List ids which have to be excluded from a campaign | [optional] 8 | **listIds** | **List<Long>** | Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] 9 | **segmentIds** | **List<Long>** | Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateEmailCampaignSender.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateEmailCampaignSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Sender Name from which the campaign emails are sent | [optional] 8 | **email** | **String** | Sender email from which the campaign emails are sent | [optional] 9 | **id** | **Long** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateList.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateList 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional] 8 | **folderId** | **Long** | Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateSender.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | From Name to update the sender | [optional] 8 | **email** | **String** | From Email to update the sender | [optional] 9 | **ips** | [**List<CreateSenderIps>**](CreateSenderIps.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateSmsCampaign.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateSmsCampaign 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the campaign | [optional] 8 | **sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional] 9 | **content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] 10 | **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] 11 | **scheduledAt** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 12 | **unicodeEnabled** | **Boolean** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] 13 | **organisationPrefix** | **String** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] 14 | **unsubscribeInstruction** | **String** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UpdateSmtpTemplate.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateSmtpTemplate 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tag** | **String** | Tag of the template | [optional] 8 | **sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional] 9 | **templateName** | **String** | Name of the template | [optional] 10 | **htmlContent** | **String** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional] 11 | **htmlUrl** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 12 | **subject** | **String** | Subject of the email | [optional] 13 | **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 14 | **toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 15 | **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 16 | **isActive** | **Boolean** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/UpdateSmtpTemplateSender.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateSmtpTemplateSender 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | Name of the sender | [optional] 8 | **email** | **String** | Email of the sender | [optional] 9 | **id** | **Long** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateWebhook.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateWebhook 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **String** | URL of the webhook | [optional] 8 | **description** | **String** | Description of the webhook | [optional] 9 | **events** | [**List<EventsEnum>**](#List<EventsEnum>) | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` | [optional] 10 | **domain** | **String** | Inbound domain of webhook, used in case of event type `inbound` | [optional] 11 | 12 | 13 | 14 | ## Enum: List<EventsEnum> 15 | Name | Value 16 | ---- | ----- 17 | SENT | "sent" 18 | HARDBOUNCE | "hardBounce" 19 | SOFTBOUNCE | "softBounce" 20 | BLOCKED | "blocked" 21 | SPAM | "spam" 22 | DELIVERED | "delivered" 23 | REQUEST | "request" 24 | CLICK | "click" 25 | INVALID | "invalid" 26 | DEFERRED | "deferred" 27 | OPENED | "opened" 28 | UNIQUEOPENED | "uniqueOpened" 29 | UNSUBSCRIBED | "unsubscribed" 30 | LISTADDITION | "listAddition" 31 | CONTACTUPDATED | "contactUpdated" 32 | CONTACTDELETED | "contactDeleted" 33 | INBOUNDEMAILPROCESSED | "inboundEmailProcessed" 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/UploadImageModel.md: -------------------------------------------------------------------------------- 1 | 2 | # UploadImageModel 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **String** | URL of the image uploaded | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UploadImageToGallery.md: -------------------------------------------------------------------------------- 1 | 2 | # UploadImageToGallery 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **imageUrl** | **String** | The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. | 8 | **name** | **String** | Name of the image. | [optional] 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/VariablesItems.md: -------------------------------------------------------------------------------- 1 | 2 | # VariablesItems 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | | [optional] 8 | **_default** | **String** | | [optional] 9 | **datatype** | **String** | | [optional] 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/WhatsappCampStats.md: -------------------------------------------------------------------------------- 1 | 2 | # WhatsappCampStats 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sent** | **Integer** | | 8 | **delivered** | **Integer** | | 9 | **read** | **Integer** | | 10 | **unsubscribe** | **Integer** | | 11 | **notSent** | **Integer** | | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/WhatsappCampTemplate.md: -------------------------------------------------------------------------------- 1 | 2 | # WhatsappCampTemplate 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **String** | name of the template | [optional] 8 | **category** | **String** | description of the template | [optional] 9 | **language** | **String** | language of the template | [optional] 10 | **containsButton** | **Boolean** | | [optional] 11 | **displayHeader** | **Boolean** | | [optional] 12 | **headerType** | **String** | type of header | [optional] 13 | **components** | [**List<ComponentItems>**](ComponentItems.md) | array of component item objects | [optional] 14 | **headerVariables** | [**List<VariablesItems>**](VariablesItems.md) | array of variables item object | [optional] 15 | **bodyVariables** | [**List<VariablesItems>**](VariablesItems.md) | array of variables item variables | [optional] 16 | **buttonType** | **String** | | [optional] 17 | **hideFooter** | **Boolean** | | [optional] 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /git_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ 3 | # 4 | # Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update" 5 | 6 | git_user_id=$1 7 | git_repo_id=$2 8 | release_note=$3 9 | 10 | if [ "$git_user_id" = "" ]; then 11 | git_user_id="GIT_USER_ID" 12 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" 13 | fi 14 | 15 | if [ "$git_repo_id" = "" ]; then 16 | git_repo_id="GIT_REPO_ID" 17 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" 18 | fi 19 | 20 | if [ "$release_note" = "" ]; then 21 | release_note="Minor update" 22 | echo "[INFO] No command line input provided. Set \$release_note to $release_note" 23 | fi 24 | 25 | # Initialize the local directory as a Git repository 26 | git init 27 | 28 | # Adds the files in the local repository and stages them for commit. 29 | git add . 30 | 31 | # Commits the tracked changes and prepares them to be pushed to a remote repository. 32 | git commit -m "$release_note" 33 | 34 | # Sets the new remote 35 | git_remote=`git remote` 36 | if [ "$git_remote" = "" ]; then # git remote not defined 37 | 38 | if [ "$GIT_TOKEN" = "" ]; then 39 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." 40 | git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git 41 | else 42 | git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git 43 | fi 44 | 45 | fi 46 | 47 | git pull origin master 48 | 49 | # Pushes (Forces) the changes in the local repository up to the remote repository 50 | echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git" 51 | git push origin master 2>&1 | grep -v 'To https' 52 | 53 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Uncomment to build for Android 2 | #target = android -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sendinblue/APIv3-java-library/69a1f311c9902378ff39f17060edc8dfe5d5fdc4/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue May 17 23:08:05 CST 2016 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.6-bin.zip 7 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = "sib-api-v3-sdk" -------------------------------------------------------------------------------- /src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /src/main/java/sendinblue/Configuration.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 4 | * 5 | * OpenAPI spec version: 3.0.0 6 | * Contact: contact@sendinblue.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package sendinblue; 15 | 16 | @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2023-02-28T15:16:18.937+05:30") 17 | public class Configuration { 18 | private static ApiClient defaultApiClient = new ApiClient(); 19 | 20 | /** 21 | * Get the default API client, which would be used when creating API 22 | * instances without providing an API client. 23 | * 24 | * @return Default API client 25 | */ 26 | public static ApiClient getDefaultApiClient() { 27 | return defaultApiClient; 28 | } 29 | 30 | /** 31 | * Set the default API client, which would be used when creating API 32 | * instances without providing an API client. 33 | * 34 | * @param apiClient API client 35 | */ 36 | public static void setDefaultApiClient(ApiClient apiClient) { 37 | defaultApiClient = apiClient; 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/sendinblue/Pair.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 4 | * 5 | * OpenAPI spec version: 3.0.0 6 | * Contact: contact@sendinblue.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package sendinblue; 15 | 16 | @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2023-02-28T15:16:18.937+05:30") 17 | public class Pair { 18 | private String name = ""; 19 | private String value = ""; 20 | 21 | public Pair (String name, String value) { 22 | setName(name); 23 | setValue(value); 24 | } 25 | 26 | private void setName(String name) { 27 | if (!isValidString(name)) return; 28 | 29 | this.name = name; 30 | } 31 | 32 | private void setValue(String value) { 33 | if (!isValidString(value)) return; 34 | 35 | this.value = value; 36 | } 37 | 38 | public String getName() { 39 | return this.name; 40 | } 41 | 42 | public String getValue() { 43 | return this.value; 44 | } 45 | 46 | private boolean isValidString(String arg) { 47 | if (arg == null) return false; 48 | if (arg.trim().isEmpty()) return false; 49 | 50 | return true; 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/main/java/sendinblue/auth/Authentication.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 4 | * 5 | * OpenAPI spec version: 3.0.0 6 | * Contact: contact@sendinblue.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package sendinblue.auth; 15 | 16 | import sendinblue.Pair; 17 | 18 | import java.util.Map; 19 | import java.util.List; 20 | 21 | public interface Authentication { 22 | /** 23 | * Apply authentication settings to header and query params. 24 | * 25 | * @param queryParams List of query parameters 26 | * @param headerParams Map of header parameters 27 | */ 28 | void applyToParams(List queryParams, Map headerParams); 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/sendinblue/auth/HttpBasicAuth.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 4 | * 5 | * OpenAPI spec version: 3.0.0 6 | * Contact: contact@sendinblue.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package sendinblue.auth; 15 | 16 | import okhttp3.Credentials; 17 | import sendinblue.Pair; 18 | 19 | import java.util.Map; 20 | import java.util.List; 21 | 22 | import java.io.UnsupportedEncodingException; 23 | 24 | public class HttpBasicAuth implements Authentication { 25 | private String username; 26 | private String password; 27 | 28 | public String getUsername() { 29 | return username; 30 | } 31 | 32 | public void setUsername(String username) { 33 | this.username = username; 34 | } 35 | 36 | public String getPassword() { 37 | return password; 38 | } 39 | 40 | public void setPassword(String password) { 41 | this.password = password; 42 | } 43 | 44 | @Override 45 | public void applyToParams(List queryParams, Map headerParams) { 46 | if (username == null && password == null) { 47 | return; 48 | } 49 | headerParams.put("Authorization", Credentials.basic( 50 | username == null ? "" : username, 51 | password == null ? "" : password)); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/main/java/sendinblue/auth/OAuth.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 4 | * 5 | * OpenAPI spec version: 3.0.0 6 | * Contact: contact@sendinblue.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package sendinblue.auth; 15 | 16 | import sendinblue.Pair; 17 | 18 | import java.util.Map; 19 | import java.util.List; 20 | 21 | @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2023-02-28T15:16:18.937+05:30") 22 | public class OAuth implements Authentication { 23 | private String accessToken; 24 | 25 | public String getAccessToken() { 26 | return accessToken; 27 | } 28 | 29 | public void setAccessToken(String accessToken) { 30 | this.accessToken = accessToken; 31 | } 32 | 33 | @Override 34 | public void applyToParams(List queryParams, Map headerParams) { 35 | if (accessToken != null) { 36 | headerParams.put("Authorization", "Bearer " + accessToken); 37 | } 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/sendinblue/auth/OAuthFlow.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 4 | * 5 | * OpenAPI spec version: 3.0.0 6 | * Contact: contact@sendinblue.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package sendinblue.auth; 15 | 16 | public enum OAuthFlow { 17 | accessCode, implicit, password, application 18 | } 19 | -------------------------------------------------------------------------------- /src/test/resources/xyz.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sendinblue/APIv3-java-library/69a1f311c9902378ff39f17060edc8dfe5d5fdc4/src/test/resources/xyz.pdf --------------------------------------------------------------------------------