Version Description
Download this release
Release Info
Developer | wpexpertsio |
Plugin | Post SMTP Mailer/Email Log |
Version | 2.1-beta.1 |
Comparing to | |
See all releases |
Code changes from version 2.0.27 to 2.1-beta.1
- Postman/Postman-Configuration/PostmanConfigurationController.php +228 -117
- Postman/Postman-Configuration/PostmanImportableConfiguration.php +68 -1
- Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php +2 -2
- Postman/Postman-Configuration/postman_manual_config.js +9 -1
- Postman/Postman-Configuration/postman_wizard.js +117 -21
- Postman/Postman-Connectivity-Test/PostmanConnectivityTestController.php +30 -20
- Postman/Postman-Controller/PostmanManageConfigurationAjaxHandler.php +9 -0
- Postman/Postman-Email-Log/PostmanEmailLogController.php +13 -8
- Postman/Postman-Mail/PostmanGmailApiModuleTransport.php +14 -0
- Postman/Postman-Mail/PostmanMailgunTransport.php +16 -2
- Postman/Postman-Mail/PostmanMandrillTransport.php +15 -1
- Postman/Postman-Mail/PostmanModuleTransport.php +37 -2
- Postman/Postman-Mail/PostmanSendGridTransport.php +15 -1
- Postman/Postman-Mail/PostmanSendinblueMailEngine.php +297 -0
- Postman/Postman-Mail/PostmanSendinblueTransport.php +276 -0
- Postman/Postman-Mail/PostmanSmtpModuleTransport.php +22 -9
- Postman/Postman-Mail/postman-sendinblue.js +40 -0
- Postman/Postman-Mail/sendinblue/.travis.yml +7 -0
- Postman/Postman-Mail/sendinblue/LICENSE.md +21 -0
- Postman/Postman-Mail/sendinblue/README.md +480 -0
- Postman/Postman-Mail/sendinblue/composer.json +43 -0
- Postman/Postman-Mail/sendinblue/composer.lock +2107 -0
- Postman/Postman-Mail/sendinblue/docs/Api/AccountApi.md +62 -0
- Postman/Postman-Mail/sendinblue/docs/Api/AttributesApi.md +243 -0
- Postman/Postman-Mail/sendinblue/docs/Api/CRMApi.md +760 -0
- Postman/Postman-Mail/sendinblue/docs/Api/ContactsApi.md +1675 -0
- Postman/Postman-Mail/sendinblue/docs/Api/EmailCampaignsApi.md +783 -0
- Postman/Postman-Mail/sendinblue/docs/Api/FoldersApi.md +366 -0
- Postman/Postman-Mail/sendinblue/docs/Api/InboundParsingApi.md +138 -0
- Postman/Postman-Mail/sendinblue/docs/Api/ListsApi.md +552 -0
- Postman/Postman-Mail/sendinblue/docs/Api/MasterAccountApi.md +424 -0
- Postman/Postman-Mail/sendinblue/docs/Api/ProcessApi.md +128 -0
- Postman/Postman-Mail/sendinblue/docs/Api/ResellerApi.md +952 -0
- Postman/Postman-Mail/sendinblue/docs/Api/SMSCampaignsApi.md +606 -0
- Postman/Postman-Mail/sendinblue/docs/Api/SendersApi.md +354 -0
- Postman/Postman-Mail/sendinblue/docs/Api/TransactionalEmailsApi.md +1379 -0
- Postman/Postman-Mail/sendinblue/docs/Api/TransactionalSMSApi.md +270 -0
- Postman/Postman-Mail/sendinblue/docs/Api/WebhooksApi.md +300 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AbTestCampaignResult.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AbTestCampaignResultClickedLinks.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AbTestCampaignResultStatistics.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AbTestVersionClicks.md +9 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AbTestVersionClicksInner.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AbTestVersionStats.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AddChildDomain.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AddContactToList.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/AddCredits.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/BlockDomain.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/Body.md +20 -0
- Postman/Postman-Mail/sendinblue/docs/Model/Body1.md +20 -0
- Postman/Postman-Mail/sendinblue/docs/Model/Contact.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateAttribute.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateAttributeEnumeration.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateChild.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateContact.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateDoiContact.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateEmailCampaign.md +37 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateEmailCampaignRecipients.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateEmailCampaignSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateList.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateModel.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateReseller.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSenderIps.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSenderModel.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSmsCampaign.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSmsCampaignRecipients.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSmtpEmail.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSmtpTemplate.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSmtpTemplateSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSubAccount.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateSubAccountResponse.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateUpdateContactModel.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateUpdateFolder.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreateWebhook.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/CreatedProcessId.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/DeleteHardbounces.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/EmailExportRecipients.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/ErrorModel.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/FileData.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAccount.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAccountMarketingAutomation.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAccountPlan.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAccountRelay.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAccountRelayData.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAggregatedReport.md +22 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAttributes.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAttributesAttributes.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetAttributesEnumeration.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetBlockedDomains.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetCampaignOverview.md +22 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetCampaignRecipients.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetCampaignStats.md +23 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildAccountCreationStatus.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildDomain.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildDomains.md +9 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfo.md +18 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoApiKeys.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoApiKeysV2.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoApiKeysV3.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoCredits.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoStatistics.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetChildrenList.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetClient.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStats.md +18 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsClicked.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsOpened.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsTransacAttributes.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsUnsubscriptions.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContactDetails.md +18 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetContacts.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetDeviceBrowserStats.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetEmailCampaign.md +40 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetEmailCampaigns.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetEmailEventReport.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetEmailEventReportEvents.md +20 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedCampaignOverview.md +38 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedCampaignOverviewSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedCampaignStats.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedClient.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedClientAddress.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetails.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatistics.md +18 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsClicked.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsDelivered.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsLinks.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsOpened.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedList.md +18 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedListCampaignStats.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetFolder.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetFolderLists.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetFolders.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEvents.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsByUuid.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsByUuidAttachments.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsByUuidLogs.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsEvents.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetIp.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetIpFromSender.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetIps.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetIpsFromSender.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetList.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetLists.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetProcess.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetProcesses.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetReports.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetReportsReports.md +22 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetScheduledEmailByBatchId.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetScheduledEmailByBatchIdBatches.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetScheduledEmailByMessageId.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSendersList.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSendersListIps.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSendersListSenders.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSharedTemplateUrl.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaign.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaignOverview.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaignStats.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaigns.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmsEventReport.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmsEventReportEvents.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmtpTemplateOverview.md +22 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmtpTemplateOverviewSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSmtpTemplates.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetSsoToken.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetStatsByBrowser.md +9 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetStatsByDevice.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetStatsByDomain.md +9 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacAggregatedSmsReport.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacBlockedContacts.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacBlockedContactsContacts.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacBlockedContactsReason.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailContent.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailContentEvents.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailsList.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailsListTransactionalEmails.md +17 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacSmsReport.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetTransacSmsReportReports.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetWebhook.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/GetWebhooks.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/InlineResponse201.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/ManageIp.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponse.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponseBillingInfo.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponseBillingInfoAddress.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponseBillingInfoName.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponsePlanInfo.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponsePlanInfoFeatures.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/Note.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/NoteData.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/PostContactInfo.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/PostContactInfoContacts.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/PostSendFailed.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/PostSendSmsTestFailed.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RemainingCreditModel.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RemainingCreditModelChild.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RemainingCreditModelReseller.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RemoveContactFromList.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RemoveCredits.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RequestContactExport.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RequestContactExportCustomContactFilter.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RequestContactImport.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RequestContactImportNewList.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/RequestSmsRecipientExport.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendReport.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendReportEmail.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSms.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmail.md +24 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailAttachment.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailBcc.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailCc.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailMessageVersions.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailReplyTo.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailReplyTo1.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailTo.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailTo1.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendTestEmail.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendTestSms.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SendTransacSms.md +16 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SsoTokenRequest.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponse.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfo.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoCredits.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountUpdatePlanRequest.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountUpdatePlanRequestCredits.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountUpdatePlanRequestFeatures.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountsResponse.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/SubAccountsResponseSubAccounts.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/Task.md +26 -0
- Postman/Postman-Mail/sendinblue/docs/Model/TaskReminder.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/TaskTypes.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateAttribute.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateAttributeEnumeration.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateBatchContacts.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateBatchContactsContacts.md +18 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateBatchContactsModel.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateCampaignStatus.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateChild.md +14 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateChildAccountStatus.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateChildDomain.md +10 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateContact.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateEmailCampaign.md +37 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateEmailCampaignRecipients.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateEmailCampaignSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateList.md +11 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateSmsCampaign.md +15 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateSmtpTemplate.md +19 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateSmtpTemplateSender.md +12 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UpdateWebhook.md +13 -0
- Postman/Postman-Mail/sendinblue/docs/Model/UploadImageToGallery.md +11 -0
- Postman/Postman-Mail/sendinblue/lib/Api/AccountApi.php +368 -0
- Postman/Postman-Mail/sendinblue/lib/Api/AttributesApi.php +1219 -0
- Postman/Postman-Mail/sendinblue/lib/Api/CRMApi.php +3768 -0
- Postman/Postman-Mail/sendinblue/lib/Api/ContactsApi.php +117 -0
Postman/Postman-Configuration/PostmanConfigurationController.php
CHANGED
@@ -24,6 +24,7 @@ class PostmanConfigurationController {
|
|
24 |
* @param mixed $rootPluginFilenameAndPath
|
25 |
*/
|
26 |
public function __construct( $rootPluginFilenameAndPath ) {
|
|
|
27 |
assert( ! empty( $rootPluginFilenameAndPath ) );
|
28 |
assert( PostmanUtils::isAdmin() );
|
29 |
assert( is_admin() );
|
@@ -33,7 +34,6 @@ class PostmanConfigurationController {
|
|
33 |
$this->options = PostmanOptions::getInstance();
|
34 |
$this->settingsRegistry = new PostmanSettingsRegistry();
|
35 |
|
36 |
-
PostmanUtils::registerAdminMenu( $this, 'addConfigurationSubmenu' );
|
37 |
PostmanUtils::registerAdminMenu( $this, 'addSetupWizardSubmenu' );
|
38 |
|
39 |
// hook on the init event
|
@@ -47,6 +47,9 @@ class PostmanConfigurationController {
|
|
47 |
$this,
|
48 |
'on_admin_init',
|
49 |
) );
|
|
|
|
|
|
|
50 |
}
|
51 |
|
52 |
/**
|
@@ -112,26 +115,42 @@ class PostmanConfigurationController {
|
|
112 |
}
|
113 |
|
114 |
/**
|
115 |
-
*
|
|
|
|
|
|
|
116 |
*/
|
117 |
-
public function
|
118 |
-
|
119 |
-
|
120 |
-
|
121 |
-
|
122 |
-
|
123 |
-
|
124 |
-
|
125 |
-
|
126 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
127 |
}
|
128 |
|
129 |
/**
|
130 |
*/
|
131 |
function enqueueConfigurationResources() {
|
132 |
$this->addLocalizeScriptsToPage();
|
133 |
-
wp_enqueue_style( PostmanViewController::POSTMAN_STYLE );
|
134 |
wp_enqueue_style( 'jquery_ui_style' );
|
|
|
135 |
wp_enqueue_script( 'postman_manual_config_script' );
|
136 |
}
|
137 |
|
@@ -165,11 +184,18 @@ class PostmanConfigurationController {
|
|
165 |
wp_enqueue_style( 'jquery_steps_style' );
|
166 |
wp_enqueue_style( PostmanViewController::POSTMAN_STYLE );
|
167 |
wp_enqueue_script( 'postman_wizard_script' );
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
168 |
//wp_localize_script( PostmanViewController::POSTMAN_SCRIPT, '$jq', 'jQuery.noConflict(true)' );
|
169 |
$shortLocale = substr( get_locale(), 0, 2 );
|
170 |
if ( $shortLocale != 'en' ) {
|
171 |
$url = plugins_url( sprintf( 'script/jquery-validate/localization/messages_%s.js', $shortLocale ), $this->rootPluginFilenameAndPath );
|
172 |
-
wp_enqueue_script( sprintf( 'jquery-validation-locale-%s', $shortLocale ), $url );
|
173 |
}
|
174 |
}
|
175 |
|
@@ -191,7 +217,7 @@ class PostmanConfigurationController {
|
|
191 |
print '<div id="config_tabs"><ul>';
|
192 |
|
193 |
foreach ( $config_tabs as $slug => $tab ) :
|
194 |
-
printf( '<li><a href="#%s">%s</a></li>', $slug, $tab );
|
195 |
endforeach;
|
196 |
|
197 |
print '</ul>';
|
@@ -207,8 +233,14 @@ class PostmanConfigurationController {
|
|
207 |
print '<section id="account_config">';
|
208 |
if ( sizeof( PostmanTransportRegistry::getInstance()->getTransports() ) > 1 ) {
|
209 |
do_settings_sections( 'transport_options' );
|
210 |
-
}
|
211 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
212 |
}
|
213 |
print '<div id="smtp_config" class="transport_setting">';
|
214 |
do_settings_sections( PostmanAdminController::SMTP_OPTIONS );
|
@@ -228,6 +260,9 @@ class PostmanConfigurationController {
|
|
228 |
print '<div id="mailgun_settings" class="authentication_setting non-basic non-oauth2">';
|
229 |
do_settings_sections( PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS );
|
230 |
print '</div>';
|
|
|
|
|
|
|
231 |
|
232 |
do_action( 'post_smtp_settings_sections' );
|
233 |
|
@@ -241,43 +276,43 @@ class PostmanConfigurationController {
|
|
241 |
<p><?php esc_html_e( 'By enable this option, if your email is fail to send Post SMTP will try to use the SMTP service you define here.', 'post-smtp' ); ?></p>
|
242 |
<table class="form-table">
|
243 |
<tr valign="">
|
244 |
-
<th scope="row"><?php
|
245 |
<td>
|
246 |
<label>
|
247 |
-
<input name="postman_options[<?php
|
248 |
value="no"<?php echo checked( $this->options->getFallbackIsEnabled(), 'no' ); ?>>
|
249 |
-
<?php
|
250 |
</label>
|
251 |
|
252 |
<label>
|
253 |
<?php $checked = checked( $this->options->getFallbackIsEnabled(), 'yes', false ); ?>
|
254 |
-
<input name="postman_options[<?php
|
255 |
value="yes"<?php echo checked( $this->options->getFallbackIsEnabled(), 'yes' ); ?>>
|
256 |
-
<?php
|
257 |
</label>
|
258 |
</td>
|
259 |
</tr>
|
260 |
|
261 |
<tr>
|
262 |
-
<th scope="row"><?php
|
263 |
<?php $host = $this->options->getFallbackHostname(); ?>
|
264 |
<td>
|
265 |
-
<input type="text" id="fallback-smtp-host" name="postman_options[<?php
|
266 |
-
value="<?php
|
267 |
</td>
|
268 |
</tr>
|
269 |
|
270 |
<tr>
|
271 |
-
<th scope="row"><?php
|
272 |
<?php $port = $this->options->getFallbackPort(); ?>
|
273 |
<td>
|
274 |
-
<input type="number" id="fallback-smtp-port" name="postman_options[<?php
|
275 |
-
value="<?php
|
276 |
</td>
|
277 |
</tr>
|
278 |
|
279 |
<tr>
|
280 |
-
<th scope="row"><?php
|
281 |
<?php
|
282 |
$security_options = array(
|
283 |
'none' => __( 'None', 'post-smtp' ),
|
@@ -286,12 +321,12 @@ class PostmanConfigurationController {
|
|
286 |
);
|
287 |
?>
|
288 |
<td>
|
289 |
-
<select id="fallback-smtp-security" name="postman_options[<?php
|
290 |
<?php
|
291 |
foreach ( $security_options as $key => $label ) {
|
292 |
$selected = selected( $this->options->getFallbackSecurity(), $key,false );
|
293 |
?>
|
294 |
-
<option value="<?php
|
295 |
<?php
|
296 |
}
|
297 |
?>
|
@@ -300,50 +335,50 @@ class PostmanConfigurationController {
|
|
300 |
</tr>
|
301 |
|
302 |
<tr>
|
303 |
-
<th scope="row"><?php
|
304 |
<td>
|
305 |
<input type="email" id="fallback-smtp-from-email"
|
306 |
-
value="<?php echo $this->options->getFallbackFromEmail(); ?>"
|
307 |
-
name="postman_options[<?php echo PostmanOptions::FALLBACK_FROM_EMAIL; ?>]"
|
308 |
>
|
309 |
<br>
|
310 |
-
<small><?php
|
311 |
</td>
|
312 |
</tr>
|
313 |
|
314 |
<tr valign="">
|
315 |
-
<th scope="row"><?php
|
316 |
<td>
|
317 |
<label>
|
318 |
-
<input name="postman_options[<?php echo PostmanOptions::FALLBACK_SMTP_USE_AUTH; ?>]"
|
319 |
type="radio" value="none"<?php checked( $this->options->getFallbackAuth(), 'none' ); ?>>
|
320 |
-
<?php
|
321 |
</label>
|
322 |
|
323 |
<label>
|
324 |
-
<input name="postman_options[<?php echo PostmanOptions::FALLBACK_SMTP_USE_AUTH; ?>]"
|
325 |
type="radio" value="login"<?php checked( $this->options->getFallbackAuth(), 'login' ); ?>>
|
326 |
-
<?php
|
327 |
</label>
|
328 |
</td>
|
329 |
</tr>
|
330 |
|
331 |
<tr>
|
332 |
-
<th scope="row"><?php
|
333 |
<td>
|
334 |
<input type="text" id="fallback-smtp-username"
|
335 |
-
value="<?php echo $this->options->getFallbackUsername(); ?>"
|
336 |
-
name="postman_options[<?php echo PostmanOptions::FALLBACK_SMTP_USERNAME; ?>]"
|
337 |
>
|
338 |
</td>
|
339 |
</tr>
|
340 |
|
341 |
<tr>
|
342 |
-
<th scope="row"><?php
|
343 |
<td>
|
344 |
<input type="password" id="fallback-smtp-password"
|
345 |
-
value="<?php echo PostmanUtils::obfuscatePassword( $this->options->getFallbackPassword() ); ?>"
|
346 |
-
name="postman_options[<?php echo PostmanOptions::FALLBACK_SMTP_PASSWORD; ?>]"
|
347 |
>
|
348 |
</td>
|
349 |
</tr>
|
@@ -375,7 +410,7 @@ class PostmanConfigurationController {
|
|
375 |
|
376 |
do_action( 'post_smtp_settings_menu' );
|
377 |
|
378 |
-
submit_button();
|
379 |
print '</form>';
|
380 |
print '</div>';
|
381 |
print '</div>';
|
@@ -397,27 +432,27 @@ class PostmanConfigurationController {
|
|
397 |
|
398 |
// account tab
|
399 |
// message tab
|
400 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::PREVENT_MESSAGE_SENDER_EMAIL_OVERRIDE, $this->options->isPluginSenderEmailEnforced() );
|
401 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::PREVENT_MESSAGE_SENDER_NAME_OVERRIDE, $this->options->isPluginSenderNameEnforced() );
|
402 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::REPLY_TO, $this->options->getReplyTo() );
|
403 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::FORCED_TO_RECIPIENTS, $this->options->getForcedToRecipients() );
|
404 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::FORCED_CC_RECIPIENTS, $this->options->getForcedCcRecipients() );
|
405 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::FORCED_BCC_RECIPIENTS, $this->options->getForcedBccRecipients() );
|
406 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::ADDITIONAL_HEADERS, $this->options->getAdditionalHeaders() );
|
407 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::DISABLE_EMAIL_VALIDAITON, $this->options->isEmailValidationDisabled() );
|
408 |
|
409 |
// logging tab
|
410 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::MAIL_LOG_ENABLED_OPTION, $this->options->getMailLoggingEnabled() );
|
411 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::MAIL_LOG_MAX_ENTRIES, $this->options->getMailLoggingMaxEntries() );
|
412 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::TRANSCRIPT_SIZE, $this->options->getTranscriptSize() );
|
413 |
|
414 |
// advanced tab
|
415 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::CONNECTION_TIMEOUT, $this->options->getConnectionTimeout() );
|
416 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::READ_TIMEOUT, $this->options->getReadTimeout() );
|
417 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::LOG_LEVEL, $this->options->getLogLevel() );
|
418 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::RUN_MODE, $this->options->getRunMode() );
|
419 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::STEALTH_MODE, $this->options->isStealthModeEnabled() );
|
420 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::TEMPORARY_DIRECTORY, $this->options->getTempDirectory() );
|
421 |
|
422 |
wp_nonce_field('post-smtp', 'security' );
|
423 |
|
@@ -425,36 +460,105 @@ class PostmanConfigurationController {
|
|
425 |
settings_fields( PostmanAdminController::SETTINGS_GROUP_NAME );
|
426 |
|
427 |
// Wizard Step 0
|
428 |
-
printf( '<h5>%s</h5>',
|
429 |
print '<fieldset>';
|
430 |
-
printf( '<legend>%s</legend>',
|
431 |
-
printf( '<p>%s</p>',
|
432 |
-
|
433 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
434 |
|
435 |
if ( $this->importableConfiguration->isImportAvailable() ) {
|
436 |
foreach ( $this->importableConfiguration->getAvailableOptions() as $options ) {
|
437 |
-
printf(
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
438 |
}
|
439 |
}
|
440 |
-
|
|
|
|
|
441 |
print '</fieldset>';
|
442 |
|
443 |
// Wizard Step 1
|
444 |
-
printf( '<h5>%s</h5>',
|
445 |
print '<fieldset>';
|
446 |
-
printf( '<legend>%s</legend>',
|
447 |
-
printf( '<p>%s</p>',
|
448 |
-
printf(
|
449 |
-
|
450 |
-
|
451 |
-
|
452 |
-
|
453 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
454 |
print '</fieldset>';
|
455 |
|
456 |
// Wizard Step 2
|
457 |
-
printf( '<h5>%s</h5>',
|
458 |
print '<fieldset>';
|
459 |
foreach ( PostmanTransportRegistry::getInstance()->getTransports() as $transport ) {
|
460 |
$transport->printWizardMailServerHostnameStep();
|
@@ -462,39 +566,43 @@ class PostmanConfigurationController {
|
|
462 |
print '</fieldset>';
|
463 |
|
464 |
// Wizard Step 3
|
465 |
-
printf( '<h5>%s</h5>',
|
466 |
print '<fieldset>';
|
467 |
-
printf( '<legend>%s</legend>',
|
468 |
-
printf( '<p>%s</p>',
|
469 |
-
printf( '<p id="connectivity_test_status">%s: <span id="port_test_status">%s</span></p>',
|
470 |
-
printf( '<p class="ajax-loader" style="display:none"><img src="%s"/></p>', plugins_url( 'post-smtp/style/ajax-loader.gif' ) );
|
471 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::TRANSPORT_TYPE );
|
472 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::PORT );
|
473 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::SECURITY_TYPE );
|
474 |
-
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::AUTHENTICATION_TYPE );
|
475 |
-
print '<
|
476 |
/* Translators: Where %1$s is the socket identifier and %2$s is the authentication type */
|
477 |
-
printf( '<p class="user_override" style="display:none"><label><span>%s:</span></label> <
|
478 |
-
printf( '<p class="user_override" style="display:none"><label><span>%s:</span></label> <
|
479 |
print ('<p><span id="smtp_mitm" style="display:none; background-color:yellow"></span></p>') ;
|
480 |
-
$warning =
|
481 |
-
$clearCredentialsWarning =
|
482 |
-
printf(
|
|
|
|
|
|
|
|
|
483 |
print '</fieldset>';
|
484 |
|
485 |
// Wizard Step 4
|
486 |
-
printf( '<h5>%s</h5>',
|
487 |
print '<fieldset>';
|
488 |
-
printf( '<legend>%s</legend>',
|
489 |
foreach ( PostmanTransportRegistry::getInstance()->getTransports() as $transport ) {
|
490 |
$transport->printWizardAuthenticationStep();
|
491 |
}
|
492 |
print '</fieldset>';
|
493 |
|
494 |
// Wizard Step 5 - Notificiations
|
495 |
-
printf( '<h5>%s</h5>',
|
496 |
print '<fieldset>';
|
497 |
-
printf( '<legend>%s</legend>',
|
498 |
|
499 |
?>
|
500 |
<select id="input_notification_service" class="input_notification_service" name="postman_options[notification_service]">
|
@@ -503,17 +611,17 @@ class PostmanConfigurationController {
|
|
503 |
<option value="slack">Slack</option>
|
504 |
</select>
|
505 |
<div id="pushover_cred" style="display: none;">
|
506 |
-
<h2><?php
|
507 |
<table class="form-table">
|
508 |
<tbody>
|
509 |
<tr>
|
510 |
-
<th scope="row"><?php
|
511 |
<td>
|
512 |
<input type="password" id="pushover_user" name="postman_options[pushover_user]" value="">
|
513 |
</td>
|
514 |
</tr>
|
515 |
<tr>
|
516 |
-
<th scope="row"><?php
|
517 |
<td>
|
518 |
<input type="password" id="pushover_token" name="postman_options[pushover_token]" value="">
|
519 |
</td>
|
@@ -522,15 +630,15 @@ class PostmanConfigurationController {
|
|
522 |
</table>
|
523 |
</div>
|
524 |
<div id="slack_cred" style="display: none;">
|
525 |
-
<h2><?php
|
526 |
<table class="form-table">
|
527 |
<tbody>
|
528 |
<tr>
|
529 |
-
<th scope="row"><?php
|
530 |
<td>
|
531 |
<input type="password" id="slack_token" name="postman_options[slack_token]" value="">
|
532 |
<a target="_blank" class="" href="https://slack.postmansmtp.com/">
|
533 |
-
<?php
|
534 |
</a>
|
535 |
</td>
|
536 |
</tr>
|
@@ -539,20 +647,20 @@ class PostmanConfigurationController {
|
|
539 |
</div>
|
540 |
|
541 |
<div id="use-chrome-extension">
|
542 |
-
<h2><?php
|
543 |
<table class="form-table">
|
544 |
<tbody>
|
545 |
<tr>
|
546 |
-
<th scope="row"><?php
|
547 |
<td>
|
548 |
<input type="checkbox" id="notification_use_chrome" name="postman_options[notification_use_chrome]">
|
549 |
<a target="_blank" class="" href="https://chrome.google.com/webstore/detail/npklmbkpbknkmbohdbpikeidiaekjoch">
|
550 |
-
<?php
|
551 |
</a>
|
552 |
</td>
|
553 |
</tr>
|
554 |
<tr>
|
555 |
-
<th scope="row"><?php
|
556 |
<td>
|
557 |
<input type="password" id="notification_chrome_uid" name="postman_options[notification_chrome_uid]" value="">
|
558 |
</td>
|
@@ -565,21 +673,20 @@ class PostmanConfigurationController {
|
|
565 |
print '</fieldset>';
|
566 |
|
567 |
// Wizard Step 6
|
568 |
-
printf( '<h5>%s</h5>',
|
569 |
print '<fieldset>';
|
570 |
-
printf( '<legend>%s</legend>',
|
571 |
print '<section>';
|
572 |
-
printf( '<p>%s</p>',
|
573 |
print '<ul style="margin-left: 20px">';
|
574 |
-
printf( '<li class="wizard-auth-oauth2">%s</li>',
|
575 |
-
printf( '<li>%s</li>',
|
576 |
print '</ul>';
|
577 |
|
578 |
// Get PHPmailer recommendation
|
579 |
Postman::getMailerTypeRecommend();
|
580 |
|
581 |
$in_wizard = true;
|
582 |
-
//include_once POST_SMTP_PATH . '/Postman/extra/donation.php';
|
583 |
|
584 |
print '</section>';
|
585 |
print '</fieldset>';
|
@@ -682,6 +789,7 @@ class PostmanManageConfigurationAjaxHandler extends PostmanAbstractAjaxHandler {
|
|
682 |
foreach ( $queryHostData as $id => $datum ) {
|
683 |
array_push( $sockets, new PostmanWizardSocket( $datum ) );
|
684 |
}
|
|
|
685 |
$this->logger->error( $sockets );
|
686 |
$userPortOverride = $this->getUserPortOverride();
|
687 |
$userAuthOverride = $this->getUserAuthOverride();
|
@@ -702,7 +810,7 @@ class PostmanManageConfigurationAjaxHandler extends PostmanAbstractAjaxHandler {
|
|
702 |
}
|
703 |
|
704 |
if ( isset( $winningRecommendation ) ) {
|
705 |
-
|
706 |
// create an appropriate (theoretical) transport
|
707 |
$transport = PostmanTransportRegistry::getInstance()->getTransport( $winningRecommendation ['transport'] );
|
708 |
|
@@ -750,10 +858,12 @@ class PostmanManageConfigurationAjaxHandler extends PostmanAbstractAjaxHandler {
|
|
750 |
* @return mixed
|
751 |
*/
|
752 |
private function getWinningRecommendation( $sockets, $userSocketOverride, $userAuthOverride, $originalSmtpServer ) {
|
|
|
753 |
foreach ( $sockets as $socket ) {
|
754 |
$winningRecommendation = $this->getWin( $socket, $userSocketOverride, $userAuthOverride, $originalSmtpServer );
|
755 |
$this->logger->error( $socket->label );
|
756 |
}
|
|
|
757 |
return $winningRecommendation;
|
758 |
}
|
759 |
|
@@ -786,6 +896,7 @@ class PostmanManageConfigurationAjaxHandler extends PostmanAbstractAjaxHandler {
|
|
786 |
}
|
787 |
$socket->label = $recommendation ['label'];
|
788 |
}
|
|
|
789 |
return $winningRecommendation;
|
790 |
}
|
791 |
|
24 |
* @param mixed $rootPluginFilenameAndPath
|
25 |
*/
|
26 |
public function __construct( $rootPluginFilenameAndPath ) {
|
27 |
+
|
28 |
assert( ! empty( $rootPluginFilenameAndPath ) );
|
29 |
assert( PostmanUtils::isAdmin() );
|
30 |
assert( is_admin() );
|
34 |
$this->options = PostmanOptions::getInstance();
|
35 |
$this->settingsRegistry = new PostmanSettingsRegistry();
|
36 |
|
|
|
37 |
PostmanUtils::registerAdminMenu( $this, 'addSetupWizardSubmenu' );
|
38 |
|
39 |
// hook on the init event
|
47 |
$this,
|
48 |
'on_admin_init',
|
49 |
) );
|
50 |
+
|
51 |
+
add_action( 'admin_menu', array( $this, 'add_submenu_page' ), 21 );
|
52 |
+
|
53 |
}
|
54 |
|
55 |
/**
|
115 |
}
|
116 |
|
117 |
/**
|
118 |
+
* Adds sub menu page `Settings`
|
119 |
+
*
|
120 |
+
* @since 2.1
|
121 |
+
* @version 1.0
|
122 |
*/
|
123 |
+
public function add_submenu_page() {
|
124 |
+
|
125 |
+
// only do this for administrators
|
126 |
+
if ( PostmanUtils::isAdmin() ) {
|
127 |
+
|
128 |
+
$this->logger->trace( 'created PostmanSettings admin menu item' );
|
129 |
+
|
130 |
+
$page = add_submenu_page(
|
131 |
+
PostmanViewController::POSTMAN_MENU_SLUG,
|
132 |
+
sprintf( __( '%s Setup', 'post-smtp' ), __( 'Postman SMTP', 'post-smtp' ) ),
|
133 |
+
__( 'Settings', 'post-smtp' ),
|
134 |
+
Postman::MANAGE_POSTMAN_CAPABILITY_NAME,
|
135 |
+
PostmanConfigurationController::CONFIGURATION_SLUG,
|
136 |
+
array(
|
137 |
+
$this,
|
138 |
+
'outputManualConfigurationContent',
|
139 |
+
) );
|
140 |
+
|
141 |
+
// When the plugin options page is loaded, also load the stylesheet
|
142 |
+
add_action( 'admin_print_styles-' . $page, array( $this, 'enqueueConfigurationResources' ) );
|
143 |
+
|
144 |
+
}
|
145 |
+
|
146 |
}
|
147 |
|
148 |
/**
|
149 |
*/
|
150 |
function enqueueConfigurationResources() {
|
151 |
$this->addLocalizeScriptsToPage();
|
|
|
152 |
wp_enqueue_style( 'jquery_ui_style' );
|
153 |
+
wp_enqueue_style( PostmanViewController::POSTMAN_STYLE );
|
154 |
wp_enqueue_script( 'postman_manual_config_script' );
|
155 |
}
|
156 |
|
184 |
wp_enqueue_style( 'jquery_steps_style' );
|
185 |
wp_enqueue_style( PostmanViewController::POSTMAN_STYLE );
|
186 |
wp_enqueue_script( 'postman_wizard_script' );
|
187 |
+
|
188 |
+
wp_localize_script( 'postman_wizard_script', 'postman',
|
189 |
+
array(
|
190 |
+
'assets' => POST_SMTP_ASSETS
|
191 |
+
)
|
192 |
+
);
|
193 |
+
|
194 |
//wp_localize_script( PostmanViewController::POSTMAN_SCRIPT, '$jq', 'jQuery.noConflict(true)' );
|
195 |
$shortLocale = substr( get_locale(), 0, 2 );
|
196 |
if ( $shortLocale != 'en' ) {
|
197 |
$url = plugins_url( sprintf( 'script/jquery-validate/localization/messages_%s.js', $shortLocale ), $this->rootPluginFilenameAndPath );
|
198 |
+
wp_enqueue_script( sprintf( 'jquery-validation-locale-%s', $shortLocale ), $url, array(), POST_SMTP_VER );
|
199 |
}
|
200 |
}
|
201 |
|
217 |
print '<div id="config_tabs"><ul>';
|
218 |
|
219 |
foreach ( $config_tabs as $slug => $tab ) :
|
220 |
+
printf( '<li><a href="#%s">%s</a></li>', esc_attr( $slug ), esc_html( $tab ) );
|
221 |
endforeach;
|
222 |
|
223 |
print '</ul>';
|
233 |
print '<section id="account_config">';
|
234 |
if ( sizeof( PostmanTransportRegistry::getInstance()->getTransports() ) > 1 ) {
|
235 |
do_settings_sections( 'transport_options' );
|
236 |
+
}
|
237 |
+
else {
|
238 |
+
printf(
|
239 |
+
'<input id="input_%2$s" type="hidden" name="%1$s[%2$s]" value="%3$s"/>',
|
240 |
+
esc_attr( PostmanOptions::POSTMAN_OPTIONS ),
|
241 |
+
esc_attr( PostmanOptions::TRANSPORT_TYPE ),
|
242 |
+
esc_attr( PostmanSmtpModuleTransport::SLUG )
|
243 |
+
);
|
244 |
}
|
245 |
print '<div id="smtp_config" class="transport_setting">';
|
246 |
do_settings_sections( PostmanAdminController::SMTP_OPTIONS );
|
260 |
print '<div id="mailgun_settings" class="authentication_setting non-basic non-oauth2">';
|
261 |
do_settings_sections( PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS );
|
262 |
print '</div>';
|
263 |
+
print '<div id="sendinblue_settings" class="authentication_setting non-basic non-oauth2">';
|
264 |
+
do_settings_sections( PostmanSendinblueTransport::SENDINBLUE_AUTH_OPTIONS );
|
265 |
+
print '</div>';
|
266 |
|
267 |
do_action( 'post_smtp_settings_sections' );
|
268 |
|
276 |
<p><?php esc_html_e( 'By enable this option, if your email is fail to send Post SMTP will try to use the SMTP service you define here.', 'post-smtp' ); ?></p>
|
277 |
<table class="form-table">
|
278 |
<tr valign="">
|
279 |
+
<th scope="row"><?php esc_html_e( 'Use Fallback?', 'post-smtp' ); ?></th>
|
280 |
<td>
|
281 |
<label>
|
282 |
+
<input name="postman_options[<?php esc_attr_e( PostmanOptions::FALLBACK_SMTP_ENABLED ); ?>]" type="radio"
|
283 |
value="no"<?php echo checked( $this->options->getFallbackIsEnabled(), 'no' ); ?>>
|
284 |
+
<?php esc_html_e( 'No', 'post-smtp' ); ?>
|
285 |
</label>
|
286 |
|
287 |
<label>
|
288 |
<?php $checked = checked( $this->options->getFallbackIsEnabled(), 'yes', false ); ?>
|
289 |
+
<input name="postman_options[<?php esc_attr_e( PostmanOptions::FALLBACK_SMTP_ENABLED ); ?>]" type="radio"
|
290 |
value="yes"<?php echo checked( $this->options->getFallbackIsEnabled(), 'yes' ); ?>>
|
291 |
+
<?php esc_html_e( 'Yes', 'post-smtp' ); ?>
|
292 |
</label>
|
293 |
</td>
|
294 |
</tr>
|
295 |
|
296 |
<tr>
|
297 |
+
<th scope="row"><?php esc_html_e('Outgoing Mail Server', 'post-smtp' ); ?></th>
|
298 |
<?php $host = $this->options->getFallbackHostname(); ?>
|
299 |
<td>
|
300 |
+
<input type="text" id="fallback-smtp-host" name="postman_options[<?php esc_attr_e( PostmanOptions::FALLBACK_SMTP_HOSTNAME ); ?>]"
|
301 |
+
value="<?php esc_attr_e( $host ); ?>" placeholder="Example: smtp.host.com">
|
302 |
</td>
|
303 |
</tr>
|
304 |
|
305 |
<tr>
|
306 |
+
<th scope="row"><?php esc_html_e('Mail Server Port', 'post-smtp' ); ?></th>
|
307 |
<?php $port = $this->options->getFallbackPort(); ?>
|
308 |
<td>
|
309 |
+
<input type="number" id="fallback-smtp-port" name="postman_options[<?php esc_attr_e( PostmanOptions::FALLBACK_SMTP_PORT ); ?>]"
|
310 |
+
value="<?php esc_attr_e( $port ); ?>" placeholder="Example: 587">
|
311 |
</td>
|
312 |
</tr>
|
313 |
|
314 |
<tr>
|
315 |
+
<th scope="row"><?php esc_html_e( 'Security', 'post-smtp' ); ?></th>
|
316 |
<?php
|
317 |
$security_options = array(
|
318 |
'none' => __( 'None', 'post-smtp' ),
|
321 |
);
|
322 |
?>
|
323 |
<td>
|
324 |
+
<select id="fallback-smtp-security" name="postman_options[<?php esc_attr_e( PostmanOptions::FALLBACK_SMTP_SECURITY ); ?>]">
|
325 |
<?php
|
326 |
foreach ( $security_options as $key => $label ) {
|
327 |
$selected = selected( $this->options->getFallbackSecurity(), $key,false );
|
328 |
?>
|
329 |
+
<option value="<?php esc_attr_e( $key ); ?>"<?php esc_attr_e( $selected ); ?>><?php echo esc_html( $label ); ?></option>
|
330 |
<?php
|
331 |
}
|
332 |
?>
|
335 |
</tr>
|
336 |
|
337 |
<tr>
|
338 |
+
<th scope="row"><?php esc_html_e( 'From Email', 'post-smtp' ); ?></th>
|
339 |
<td>
|
340 |
<input type="email" id="fallback-smtp-from-email"
|
341 |
+
value="<?php echo esc_attr( $this->options->getFallbackFromEmail() ); ?>"
|
342 |
+
name="postman_options[<?php echo esc_attr( PostmanOptions::FALLBACK_FROM_EMAIL ); ?>]"
|
343 |
>
|
344 |
<br>
|
345 |
+
<small><?php esc_html_e( "Use allowed email, for example: If you are using Gmail, type your Gmail adress.", 'post-smtp' ); ?></small>
|
346 |
</td>
|
347 |
</tr>
|
348 |
|
349 |
<tr valign="">
|
350 |
+
<th scope="row"><?php esc_html_e( 'Use SMTP Authentication?', 'post-smtp' ); ?></th>
|
351 |
<td>
|
352 |
<label>
|
353 |
+
<input name="postman_options[<?php echo esc_attr( PostmanOptions::FALLBACK_SMTP_USE_AUTH ); ?>]"
|
354 |
type="radio" value="none"<?php checked( $this->options->getFallbackAuth(), 'none' ); ?>>
|
355 |
+
<?php esc_html_e( 'No', 'post-smtp' ); ?>
|
356 |
</label>
|
357 |
|
358 |
<label>
|
359 |
+
<input name="postman_options[<?php echo esc_attr( PostmanOptions::FALLBACK_SMTP_USE_AUTH ); ?>]"
|
360 |
type="radio" value="login"<?php checked( $this->options->getFallbackAuth(), 'login' ); ?>>
|
361 |
+
<?php esc_html_e( 'Yes', 'post-smtp' ); ?>
|
362 |
</label>
|
363 |
</td>
|
364 |
</tr>
|
365 |
|
366 |
<tr>
|
367 |
+
<th scope="row"><?php esc_html_e('User name', 'post-smtp' ); ?></th>
|
368 |
<td>
|
369 |
<input type="text" id="fallback-smtp-username"
|
370 |
+
value="<?php echo esc_attr( $this->options->getFallbackUsername() ); ?>"
|
371 |
+
name="postman_options[<?php echo esc_attr( PostmanOptions::FALLBACK_SMTP_USERNAME ); ?>]"
|
372 |
>
|
373 |
</td>
|
374 |
</tr>
|
375 |
|
376 |
<tr>
|
377 |
+
<th scope="row"><?php esc_html_e('Password', 'post-smtp' ); ?></th>
|
378 |
<td>
|
379 |
<input type="password" id="fallback-smtp-password"
|
380 |
+
value="<?php echo esc_attr( PostmanUtils::obfuscatePassword( $this->options->getFallbackPassword() ) ); ?>"
|
381 |
+
name="postman_options[<?php echo esc_attr( PostmanOptions::FALLBACK_SMTP_PASSWORD ); ?>]"
|
382 |
>
|
383 |
</td>
|
384 |
</tr>
|
410 |
|
411 |
do_action( 'post_smtp_settings_menu' );
|
412 |
|
413 |
+
submit_button( 'Save Changes', 'ps-btn-orange' );
|
414 |
print '</form>';
|
415 |
print '</div>';
|
416 |
print '</div>';
|
432 |
|
433 |
// account tab
|
434 |
// message tab
|
435 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::PREVENT_MESSAGE_SENDER_EMAIL_OVERRIDE ), esc_attr( $this->options->isPluginSenderEmailEnforced() ) );
|
436 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::PREVENT_MESSAGE_SENDER_NAME_OVERRIDE ), esc_attr( $this->options->isPluginSenderNameEnforced() ) );
|
437 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::REPLY_TO ), esc_attr( $this->options->getReplyTo() ) );
|
438 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::FORCED_TO_RECIPIENTS ), esc_attr( $this->options->getForcedToRecipients() ) );
|
439 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::FORCED_CC_RECIPIENTS ), esc_attr( $this->options->getForcedCcRecipients() ) );
|
440 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::FORCED_BCC_RECIPIENTS ), esc_attr( $this->options->getForcedBccRecipients() ) );
|
441 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::ADDITIONAL_HEADERS ), esc_attr( $this->options->getAdditionalHeaders() ) );
|
442 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::DISABLE_EMAIL_VALIDAITON ), esc_attr( $this->options->isEmailValidationDisabled() ) );
|
443 |
|
444 |
// logging tab
|
445 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::MAIL_LOG_ENABLED_OPTION ), esc_attr( $this->options->getMailLoggingEnabled() ) );
|
446 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::MAIL_LOG_MAX_ENTRIES ), esc_attr( $this->options->getMailLoggingMaxEntries() ) );
|
447 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::TRANSCRIPT_SIZE ), esc_attr( $this->options->getTranscriptSize() ) );
|
448 |
|
449 |
// advanced tab
|
450 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::CONNECTION_TIMEOUT ), esc_attr( $this->options->getConnectionTimeout() ) );
|
451 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::READ_TIMEOUT ), esc_attr( $this->options->getReadTimeout() ) );
|
452 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::LOG_LEVEL ), esc_attr( $this->options->getLogLevel() ) );
|
453 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::RUN_MODE ), esc_attr( $this->options->getRunMode() ) );
|
454 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::STEALTH_MODE ), esc_attr( $this->options->isStealthModeEnabled() ) );
|
455 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]" value="%3$s" />', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::TEMPORARY_DIRECTORY ), esc_attr( $this->options->getTempDirectory() ) );
|
456 |
|
457 |
wp_nonce_field('post-smtp', 'security' );
|
458 |
|
460 |
settings_fields( PostmanAdminController::SETTINGS_GROUP_NAME );
|
461 |
|
462 |
// Wizard Step 0
|
463 |
+
printf( '<h5>%s</h5>', esc_html_x( 'Import Configuration', 'Wizard Step Title', 'post-smtp' ) );
|
464 |
print '<fieldset>';
|
465 |
+
printf( '<legend>%s</legend>', esc_html_x( 'Import configuration from another plugin?', 'Wizard Step Title', 'post-smtp' ) );
|
466 |
+
printf( '<p>%s</p>', esc_html__( 'If you had a working configuration with another Plugin, the Setup Wizard can begin with those settings.', 'post-smtp' ) );
|
467 |
+
|
468 |
+
$style = '';
|
469 |
+
|
470 |
+
if( !$this->importableConfiguration->isImportAvailable() ) {
|
471 |
+
|
472 |
+
$style = 'style="display: none"';
|
473 |
+
|
474 |
+
printf(
|
475 |
+
'<div class="no-configuration ps-config-bar">
|
476 |
+
<div class="ps-right">
|
477 |
+
%s
|
478 |
+
</div>
|
479 |
+
<div class="clear"></div>
|
480 |
+
</div>',
|
481 |
+
esc_html__( 'No other SMTP plugin configuration has been detected in your installation. You can skip this step.', 'post-smtp' )
|
482 |
+
);
|
483 |
+
|
484 |
+
}
|
485 |
+
|
486 |
+
printf(
|
487 |
+
'<div class="input_auth_type">
|
488 |
+
<div class="ps-socket-wizad-row" %s>
|
489 |
+
<label>
|
490 |
+
|
491 |
+
<div class="ps-single-socket-outer">
|
492 |
+
<img src="%s" class="ps-wizard-socket-logo" width="165px">
|
493 |
+
</div>
|
494 |
+
<input type="radio" id="import_none" name="input_plugin" value="%s" checked="checked">
|
495 |
+
<label> %s</label>
|
496 |
+
</label>',
|
497 |
+
wp_kses_post( $style ),
|
498 |
+
esc_url( POST_SMTP_ASSETS . "images/logos/gear.png" ),
|
499 |
+
'none',
|
500 |
+
esc_html__( 'None', 'post-smtp' )
|
501 |
+
);
|
502 |
+
|
503 |
+
$row = 1;
|
504 |
|
505 |
if ( $this->importableConfiguration->isImportAvailable() ) {
|
506 |
foreach ( $this->importableConfiguration->getAvailableOptions() as $options ) {
|
507 |
+
printf(
|
508 |
+
'<label>
|
509 |
+
<div class="ps-single-socket-outer">
|
510 |
+
<img src="%s" class="ps-wizard-socket-logo" width="165px">
|
511 |
+
</div>
|
512 |
+
<input type="radio" id="import_none" name="input_plugin" value="%s" checked="checked">
|
513 |
+
<label> %s</label>
|
514 |
+
</label>',
|
515 |
+
esc_url( $options->getPluginLogo() ),
|
516 |
+
esc_attr( $options->getPluginSlug() ),
|
517 |
+
esc_html( $options->getPluginName() )
|
518 |
+
);
|
519 |
+
|
520 |
+
$row++;
|
521 |
+
|
522 |
+
if( $row == 3 ) {
|
523 |
+
print '</div>';
|
524 |
+
print '<div class="ps-socket-wizad-row">';
|
525 |
+
$row = 0;
|
526 |
+
}
|
527 |
}
|
528 |
}
|
529 |
+
|
530 |
+
print '</div>';
|
531 |
+
print '</div>';
|
532 |
print '</fieldset>';
|
533 |
|
534 |
// Wizard Step 1
|
535 |
+
printf( '<h5>%s</h5>', esc_html_x( 'Sender Details', 'Wizard Step Title', 'post-smtp' ) );
|
536 |
print '<fieldset>';
|
537 |
+
printf( '<legend>%s</legend>', esc_html_x( 'Who is the mail coming from?', 'Wizard Step Title', 'post-smtp' ) );
|
538 |
+
printf( '<p>%s</p>', esc_html__( 'Enter the email address and name you\'d like to send mail as.', 'post-smtp' ) );
|
539 |
+
printf(
|
540 |
+
'<p>%s <em>%s</em> %s</p>',
|
541 |
+
esc_html__( 'Please note that to prevent abuse, many email services will ', 'post-smtp' ),
|
542 |
+
esc_html__( 'not', 'post-smtp' ),
|
543 |
+
esc_html__( 'let you send from an email address other than the one you authenticate with.', 'post-smtp' )
|
544 |
+
);
|
545 |
+
|
546 |
+
print( '<div class="ps-ib ps-w-50">' );
|
547 |
+
printf( '<label for="postman_options[sender_name]">%s</label>', esc_html__( 'Name', 'post-smtp' ) );
|
548 |
+
print wp_kses_post( $this->settingsRegistry->sender_name_callback() );
|
549 |
+
print( '</div>' );
|
550 |
+
|
551 |
+
print( '<div class="ps-ib ps-w-50">' );
|
552 |
+
printf( '<label for="postman_options[sender_email]">%s</label>', esc_html__( 'Email Address', 'post-smtp' ) );
|
553 |
+
print wp_kses_post( $this->settingsRegistry->from_email_callback() );
|
554 |
+
print( '</div>' );
|
555 |
+
|
556 |
+
print( '<div class="clear"></div>' );
|
557 |
+
|
558 |
print '</fieldset>';
|
559 |
|
560 |
// Wizard Step 2
|
561 |
+
printf( '<h5>%s</h5>', esc_html__( 'Outgoing Mail Server Hostname', 'post-smtp' ) );
|
562 |
print '<fieldset>';
|
563 |
foreach ( PostmanTransportRegistry::getInstance()->getTransports() as $transport ) {
|
564 |
$transport->printWizardMailServerHostnameStep();
|
566 |
print '</fieldset>';
|
567 |
|
568 |
// Wizard Step 3
|
569 |
+
printf( '<h5>%s</h5>', esc_html__( 'Connectivity Test', 'post-smtp' ) );
|
570 |
print '<fieldset>';
|
571 |
+
printf( '<legend>%s</legend>', esc_html__( 'How will the connection to the mail server be established?', 'post-smtp' ) );
|
572 |
+
printf( '<p>%s</p>', esc_html__( 'Your connection settings depend on what your email service provider offers, and what your WordPress host allows.', 'post-smtp' ) );
|
573 |
+
printf( '<p id="connectivity_test_status">%s: <span id="port_test_status">%s</span></p>', esc_html__( 'Connectivity Test', 'post-smtp' ), esc_html_x( 'Ready', 'TCP Port Test Status', 'post-smtp' ) );
|
574 |
+
printf( '<p class="ajax-loader" style="display:none"><img src="%s"/></p>', esc_url( plugins_url( 'post-smtp/style/ajax-loader.gif' ) ) );
|
575 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::TRANSPORT_TYPE ) );
|
576 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::PORT ) );
|
577 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::SECURITY_TYPE ) );
|
578 |
+
printf( '<input type="hidden" id="input_%2$s" name="%1$s[%2$s]">', esc_attr( PostmanOptions::POSTMAN_OPTIONS ), esc_attr( PostmanOptions::AUTHENTICATION_TYPE ) );
|
579 |
+
print '<legend id="wizard_recommendation"></legend>';
|
580 |
/* Translators: Where %1$s is the socket identifier and %2$s is the authentication type */
|
581 |
+
printf( '<p class="user_override" style="display:none"><label><span>%s:</span></label> <div id="user_socket_override" class="user_override"></div></p>', esc_html_x( 'Socket', 'A socket is the network term for host and port together', 'post-smtp' ) );
|
582 |
+
printf( '<p class="user_override" style="display:none"><label><span>%s:</span></label> <div id="user_auth_override" class="user_override"></div></p>', esc_html__( 'Authentication', 'post-smtp' ) );
|
583 |
print ('<p><span id="smtp_mitm" style="display:none; background-color:yellow"></span></p>') ;
|
584 |
+
$warning = esc_html__( 'Warning', 'post-smtp' );
|
585 |
+
$clearCredentialsWarning = esc_html__( 'This configuration option will send your authorization credentials in the clear.', 'post-smtp' );
|
586 |
+
printf(
|
587 |
+
'<p id="smtp_not_secure" style="display:none"><span style="background-color:yellow">%s: %s</span></p>',
|
588 |
+
esc_html( $warning ),
|
589 |
+
esc_html( $clearCredentialsWarning )
|
590 |
+
);
|
591 |
print '</fieldset>';
|
592 |
|
593 |
// Wizard Step 4
|
594 |
+
printf( '<h5>%s</h5>', esc_html__( 'Authentication', 'post-smtp' ) );
|
595 |
print '<fieldset>';
|
596 |
+
printf( '<legend>%s</legend>', esc_html__( 'How will you prove your identity to the mail server?', 'post-smtp' ) );
|
597 |
foreach ( PostmanTransportRegistry::getInstance()->getTransports() as $transport ) {
|
598 |
$transport->printWizardAuthenticationStep();
|
599 |
}
|
600 |
print '</fieldset>';
|
601 |
|
602 |
// Wizard Step 5 - Notificiations
|
603 |
+
printf( '<h5>%s</h5>', esc_html__( 'Notifications', 'post-smtp' ) );
|
604 |
print '<fieldset>';
|
605 |
+
printf( '<legend>%s</legend>', esc_html__( 'Select a notify service to notify you when an email is failed to delivered.', 'post-smtp' ) );
|
606 |
|
607 |
?>
|
608 |
<select id="input_notification_service" class="input_notification_service" name="postman_options[notification_service]">
|
611 |
<option value="slack">Slack</option>
|
612 |
</select>
|
613 |
<div id="pushover_cred" style="display: none;">
|
614 |
+
<h2><?php esc_html_e( 'Pushover Credentials', 'post-smtp' ); ?></h2>
|
615 |
<table class="form-table">
|
616 |
<tbody>
|
617 |
<tr>
|
618 |
+
<th scope="row"><?php esc_html_e( 'Pushover User Key', 'post-smtp' ); ?></th>
|
619 |
<td>
|
620 |
<input type="password" id="pushover_user" name="postman_options[pushover_user]" value="">
|
621 |
</td>
|
622 |
</tr>
|
623 |
<tr>
|
624 |
+
<th scope="row"><?php esc_html_e( 'Pushover App Token', 'post-smtp' ); ?></th>
|
625 |
<td>
|
626 |
<input type="password" id="pushover_token" name="postman_options[pushover_token]" value="">
|
627 |
</td>
|
630 |
</table>
|
631 |
</div>
|
632 |
<div id="slack_cred" style="display: none;">
|
633 |
+
<h2><?php esc_html_e( 'Slack Credentials', 'post-smtp' ); ?></h2>
|
634 |
<table class="form-table">
|
635 |
<tbody>
|
636 |
<tr>
|
637 |
+
<th scope="row"><?php esc_html_e( 'Slack webhook', 'post-smtp' ); ?></th>
|
638 |
<td>
|
639 |
<input type="password" id="slack_token" name="postman_options[slack_token]" value="">
|
640 |
<a target="_blank" class="" href="https://slack.postmansmtp.com/">
|
641 |
+
<?php esc_html_e( 'Get your webhook URL here.', 'post-smtp' ); ?>
|
642 |
</a>
|
643 |
</td>
|
644 |
</tr>
|
647 |
</div>
|
648 |
|
649 |
<div id="use-chrome-extension">
|
650 |
+
<h2><?php esc_html_e( 'Push To Chrome Extension', 'post-smtp' ); ?></h2>
|
651 |
<table class="form-table">
|
652 |
<tbody>
|
653 |
<tr>
|
654 |
+
<th scope="row"><?php esc_html_e( 'This is an extra notification to the selection above', 'post-smtp' ); ?></th>
|
655 |
<td>
|
656 |
<input type="checkbox" id="notification_use_chrome" name="postman_options[notification_use_chrome]">
|
657 |
<a target="_blank" class="" href="https://chrome.google.com/webstore/detail/npklmbkpbknkmbohdbpikeidiaekjoch">
|
658 |
+
<?php esc_html_e( 'You can download the chrome extension here (if link not available, check later).', 'post-smtp' ); ?>
|
659 |
</a>
|
660 |
</td>
|
661 |
</tr>
|
662 |
<tr>
|
663 |
+
<th scope="row"><?php esc_html_e( 'Your UID as you see in the extension.', 'post-smtp' ); ?></th>
|
664 |
<td>
|
665 |
<input type="password" id="notification_chrome_uid" name="postman_options[notification_chrome_uid]" value="">
|
666 |
</td>
|
673 |
print '</fieldset>';
|
674 |
|
675 |
// Wizard Step 6
|
676 |
+
printf( '<h5>%s</h5>', esc_html_x( 'Finish', 'The final step of the Wizard', 'post-smtp' ) );
|
677 |
print '<fieldset>';
|
678 |
+
printf( '<legend>%s</legend>', esc_html_x( 'You\'re Done!', 'Wizard Step Title', 'post-smtp' ) );
|
679 |
print '<section>';
|
680 |
+
printf( '<p>%s</p>', esc_html__( 'Click Finish to save these settings, then:', 'post-smtp' ) );
|
681 |
print '<ul style="margin-left: 20px">';
|
682 |
+
printf( '<li class="wizard-auth-oauth2">%s</li>', esc_html__( 'Grant permission with the Email Provider for Postman to send email and', 'post-smtp' ) );
|
683 |
+
printf( '<li>%s</li>', esc_html__( 'Send yourself a Test Email to make sure everything is working!', 'post-smtp' ) );
|
684 |
print '</ul>';
|
685 |
|
686 |
// Get PHPmailer recommendation
|
687 |
Postman::getMailerTypeRecommend();
|
688 |
|
689 |
$in_wizard = true;
|
|
|
690 |
|
691 |
print '</section>';
|
692 |
print '</fieldset>';
|
789 |
foreach ( $queryHostData as $id => $datum ) {
|
790 |
array_push( $sockets, new PostmanWizardSocket( $datum ) );
|
791 |
}
|
792 |
+
|
793 |
$this->logger->error( $sockets );
|
794 |
$userPortOverride = $this->getUserPortOverride();
|
795 |
$userAuthOverride = $this->getUserAuthOverride();
|
810 |
}
|
811 |
|
812 |
if ( isset( $winningRecommendation ) ) {
|
813 |
+
|
814 |
// create an appropriate (theoretical) transport
|
815 |
$transport = PostmanTransportRegistry::getInstance()->getTransport( $winningRecommendation ['transport'] );
|
816 |
|
858 |
* @return mixed
|
859 |
*/
|
860 |
private function getWinningRecommendation( $sockets, $userSocketOverride, $userAuthOverride, $originalSmtpServer ) {
|
861 |
+
|
862 |
foreach ( $sockets as $socket ) {
|
863 |
$winningRecommendation = $this->getWin( $socket, $userSocketOverride, $userAuthOverride, $originalSmtpServer );
|
864 |
$this->logger->error( $socket->label );
|
865 |
}
|
866 |
+
|
867 |
return $winningRecommendation;
|
868 |
}
|
869 |
|
896 |
}
|
897 |
$socket->label = $recommendation ['label'];
|
898 |
}
|
899 |
+
|
900 |
return $winningRecommendation;
|
901 |
}
|
902 |
|
Postman/Postman-Configuration/PostmanImportableConfiguration.php
CHANGED
@@ -16,6 +16,13 @@ if (! interface_exists ( 'PostmanPluginOptions' )) {
|
|
16 |
public function getEncryptionType();
|
17 |
public function getUsername();
|
18 |
public function getPassword();
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
19 |
}
|
20 |
}
|
21 |
if (! class_exists ( 'PostmanImportableConfiguration' )) {
|
@@ -182,6 +189,16 @@ if (! class_exists ( 'PostmanConfigureSmtpOptions' )) {
|
|
182 |
}
|
183 |
}
|
184 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
185 |
}
|
186 |
}
|
187 |
|
@@ -250,6 +267,16 @@ if (! class_exists ( 'PostmanCimySwiftSmtpOptions' )) {
|
|
250 |
}
|
251 |
}
|
252 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
253 |
}
|
254 |
}
|
255 |
|
@@ -307,7 +334,7 @@ if (! class_exists ( 'PostmanEasyWpSmtpOptions' )) {
|
|
307 |
if (isset ( $this->options [self::SMTP_SETTINGS] [self::PASSWORD] )) {
|
308 |
// wpecommerce screwed the pooch
|
309 |
$password = $this->options [self::SMTP_SETTINGS] [self::PASSWORD];
|
310 |
-
if (strlen ( $password )
|
311 |
$decodedPw = base64_decode ( $password, true );
|
312 |
$reencodedPw = base64_encode ( $decodedPw );
|
313 |
if ($reencodedPw === $password) {
|
@@ -342,6 +369,16 @@ if (! class_exists ( 'PostmanEasyWpSmtpOptions' )) {
|
|
342 |
}
|
343 |
}
|
344 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
345 |
}
|
346 |
}
|
347 |
|
@@ -422,6 +459,16 @@ if (! class_exists ( 'PostmanWpMailBankOptions' )) {
|
|
422 |
}
|
423 |
}
|
424 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
425 |
}
|
426 |
}
|
427 |
|
@@ -504,6 +551,16 @@ if (! class_exists ( 'PostmanWpMailSmtpOptions' )) {
|
|
504 |
}
|
505 |
}
|
506 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
507 |
}
|
508 |
}
|
509 |
|
@@ -576,5 +633,15 @@ if (! class_exists ( 'PostmanWpSmtpOptions' )) {
|
|
576 |
}
|
577 |
}
|
578 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
579 |
}
|
580 |
}
|
16 |
public function getEncryptionType();
|
17 |
public function getUsername();
|
18 |
public function getPassword();
|
19 |
+
/**
|
20 |
+
* Get plugin's logo
|
21 |
+
*
|
22 |
+
* @since 2.1
|
23 |
+
* @version 1.0
|
24 |
+
*/
|
25 |
+
public function getPluginLogo();
|
26 |
}
|
27 |
}
|
28 |
if (! class_exists ( 'PostmanImportableConfiguration' )) {
|
189 |
}
|
190 |
}
|
191 |
}
|
192 |
+
|
193 |
+
/**
|
194 |
+
* Get plugin's logo
|
195 |
+
*
|
196 |
+
* @since 2.1
|
197 |
+
* @version 1.0
|
198 |
+
*/
|
199 |
+
public function getPluginLogo() {
|
200 |
+
return POST_SMTP_ASSETS . "images/logos/configure-smtp.png";
|
201 |
+
}
|
202 |
}
|
203 |
}
|
204 |
|
267 |
}
|
268 |
}
|
269 |
}
|
270 |
+
|
271 |
+
/**
|
272 |
+
* Get plugin's logo
|
273 |
+
*
|
274 |
+
* @since 2.1
|
275 |
+
* @version 1.0
|
276 |
+
*/
|
277 |
+
public function getPluginLogo() {
|
278 |
+
return POST_SMTP_ASSETS . "images/logos/php.png";
|
279 |
+
}
|
280 |
}
|
281 |
}
|
282 |
|
334 |
if (isset ( $this->options [self::SMTP_SETTINGS] [self::PASSWORD] )) {
|
335 |
// wpecommerce screwed the pooch
|
336 |
$password = $this->options [self::SMTP_SETTINGS] [self::PASSWORD];
|
337 |
+
if ( strlen ( $password ) ) {
|
338 |
$decodedPw = base64_decode ( $password, true );
|
339 |
$reencodedPw = base64_encode ( $decodedPw );
|
340 |
if ($reencodedPw === $password) {
|
369 |
}
|
370 |
}
|
371 |
}
|
372 |
+
|
373 |
+
/**
|
374 |
+
* Get plugin's logo
|
375 |
+
*
|
376 |
+
* @since 2.1
|
377 |
+
* @version 1.0
|
378 |
+
*/
|
379 |
+
public function getPluginLogo() {
|
380 |
+
return POST_SMTP_ASSETS . "images/logos/easy-wp-smtp.png";
|
381 |
+
}
|
382 |
}
|
383 |
}
|
384 |
|
459 |
}
|
460 |
}
|
461 |
}
|
462 |
+
|
463 |
+
/**
|
464 |
+
* Get plugin's logo
|
465 |
+
*
|
466 |
+
* @since 2.1
|
467 |
+
* @version 1.0
|
468 |
+
*/
|
469 |
+
public function getPluginLogo() {
|
470 |
+
return POST_SMTP_ASSETS . "images/logos/wp-mail-bank.png";
|
471 |
+
}
|
472 |
}
|
473 |
}
|
474 |
|
551 |
}
|
552 |
}
|
553 |
}
|
554 |
+
|
555 |
+
/**
|
556 |
+
* Get plugin's logo
|
557 |
+
*
|
558 |
+
* @since 2.1
|
559 |
+
* @version 1.0
|
560 |
+
*/
|
561 |
+
public function getPluginLogo() {
|
562 |
+
return POST_SMTP_ASSETS . "images/logos/wp-mail-smtp.png";
|
563 |
+
}
|
564 |
}
|
565 |
}
|
566 |
|
633 |
}
|
634 |
}
|
635 |
}
|
636 |
+
|
637 |
+
/**
|
638 |
+
* Get plugin's logo
|
639 |
+
*
|
640 |
+
* @since 2.1
|
641 |
+
* @version 1.0
|
642 |
+
*/
|
643 |
+
public function getPluginLogo() {
|
644 |
+
return POST_SMTP_ASSETS . "images/logos/wp-smtp.png";
|
645 |
+
}
|
646 |
}
|
647 |
}
|
Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php
CHANGED
@@ -279,7 +279,7 @@ class PostmanSettingsRegistry {
|
|
279 |
* Get the settings option array and print one of its values
|
280 |
*/
|
281 |
public function sender_name_callback() {
|
282 |
-
printf( '<input type="text" id="input_sender_name" name="postman_options[sender_name]" value="%s" size="40" />', null !== $this->options->getMessageSenderName() ? esc_attr( $this->options->getMessageSenderName() ) : '' );
|
283 |
}
|
284 |
|
285 |
/**
|
@@ -293,7 +293,7 @@ class PostmanSettingsRegistry {
|
|
293 |
* Get the settings option array and print one of its values
|
294 |
*/
|
295 |
public function from_email_callback() {
|
296 |
-
printf( '<input type="email" id="input_sender_email" name="postman_options[sender_email]" value="%s" size="40" class="required" placeholder="%s"/>', null !== $this->options->getMessageSenderEmail() ? esc_attr( $this->options->getMessageSenderEmail() ) : '', __( 'Required', 'post-smtp' ) );
|
297 |
}
|
298 |
|
299 |
/**
|
279 |
* Get the settings option array and print one of its values
|
280 |
*/
|
281 |
public function sender_name_callback() {
|
282 |
+
printf( '<input type="text" id="input_sender_name" class="ps-input ps-w-75" name="postman_options[sender_name]" value="%s" size="40" />', null !== $this->options->getMessageSenderName() ? esc_attr( $this->options->getMessageSenderName() ) : '' );
|
283 |
}
|
284 |
|
285 |
/**
|
293 |
* Get the settings option array and print one of its values
|
294 |
*/
|
295 |
public function from_email_callback() {
|
296 |
+
printf( '<input type="email" id="input_sender_email" class="ps-input ps-w-75" name="postman_options[sender_email]" value="%s" size="40" class="required" placeholder="%s"/>', null !== $this->options->getMessageSenderEmail() ? esc_attr( $this->options->getMessageSenderEmail() ) : '', __( 'Required', 'post-smtp' ) );
|
297 |
}
|
298 |
|
299 |
/**
|
Postman/Postman-Configuration/postman_manual_config.js
CHANGED
@@ -8,7 +8,15 @@ jQuery(document).ready(
|
|
8 |
'togglePasswordField');
|
9 |
|
10 |
// tabs
|
11 |
-
jQuery("#config_tabs").tabs(
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
12 |
|
13 |
// on first viewing, determine whether to show password or
|
14 |
// oauth section
|
8 |
'togglePasswordField');
|
9 |
|
10 |
// tabs
|
11 |
+
jQuery("#config_tabs").tabs( {
|
12 |
+
|
13 |
+
activate: function( event ,ui ) {
|
14 |
+
|
15 |
+
jQuery( ui.oldTab ).addClass( 'visited-config-ui-tab' );
|
16 |
+
|
17 |
+
}
|
18 |
+
|
19 |
+
} );
|
20 |
|
21 |
// on first viewing, determine whether to show password or
|
22 |
// oauth section
|
Postman/Postman-Configuration/postman_wizard.js
CHANGED
@@ -116,12 +116,26 @@ function initializeJQuerySteps() {
|
|
116 |
loading : post_smtp_localize.steps_loading
|
117 |
},
|
118 |
onStepChanging : function(event, currentIndex, newIndex) {
|
119 |
-
|
120 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
121 |
|
122 |
},
|
123 |
onInit : function() {
|
|
|
|
|
|
|
|
|
124 |
jQuery(post_smtp_localize.postman_input_sender_email).focus();
|
|
|
125 |
},
|
126 |
onStepChanged : function(event, currentIndex, priorIndex) {
|
127 |
return postHandleStepChange(event, currentIndex,
|
@@ -307,6 +321,7 @@ function handleHostsToCheckResponse(response) {
|
|
307 |
var hostname = response.hosts[x].host;
|
308 |
var port = response.hosts[x].port;
|
309 |
var transport = response.hosts[x].transport_id;
|
|
|
310 |
portsToCheck++;
|
311 |
show('#connectivity_test_status');
|
312 |
updateStatus(postman_port_test.in_progress + " " + portsToCheck);
|
@@ -315,6 +330,7 @@ function handleHostsToCheckResponse(response) {
|
|
315 |
'hostname' : hostname,
|
316 |
'port' : port,
|
317 |
'transport' : transport,
|
|
|
318 |
'security' : jQuery('#security').val(),
|
319 |
};
|
320 |
postThePortTest(hostname, port, data);
|
@@ -449,6 +465,10 @@ function postTheConfigurationRequest(data) {
|
|
449 |
});
|
450 |
}
|
451 |
function handleConfigurationResponse(response) {
|
|
|
|
|
|
|
|
|
452 |
jQuery('#input_transport_type').val(response.configuration.transport_type);
|
453 |
transports.forEach(function(item) {
|
454 |
item.handleConfigurationResponse(response);
|
@@ -459,12 +479,33 @@ function handleConfigurationResponse(response) {
|
|
459 |
show('.user_override');
|
460 |
var el1 = jQuery('#user_socket_override');
|
461 |
el1.html('');
|
|
|
|
|
|
|
462 |
for (i = 0; i < response.override_menu.length; i++) {
|
463 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
464 |
response.override_menu[i].selected,
|
465 |
response.override_menu[i].value,
|
466 |
response.override_menu[i].description,
|
467 |
-
response.override_menu[i].secure
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
468 |
// populate user Auth Override menu
|
469 |
if (response.override_menu[i].selected) {
|
470 |
if (response.override_menu[i].mitm) {
|
@@ -482,24 +523,29 @@ function handleConfigurationResponse(response) {
|
|
482 |
el2.html('');
|
483 |
hide('#smtp_not_secure');
|
484 |
for (j = 0; j < response.override_menu[i].auth_items.length; j++) {
|
485 |
-
|
|
|
|
|
486 |
response.override_menu[i].auth_items[j].selected,
|
487 |
response.override_menu[i].auth_items[j].value,
|
488 |
-
response.override_menu[i].auth_items[j].name,
|
|
|
|
|
|
|
489 |
if (response.override_menu[i].auth_items[j].selected
|
490 |
&& !response.override_menu[i].secure
|
491 |
&& response.override_menu[i].auth_items[j].value != 'none') {
|
492 |
show('#smtp_not_secure');
|
493 |
}
|
494 |
}
|
495 |
-
// add an event on the user port override field
|
496 |
-
jQuery('input.user_auth_override').change(function() {
|
497 |
-
userOverrideMenu();
|
498 |
-
});
|
499 |
}
|
500 |
|
|
|
501 |
}
|
502 |
|
|
|
|
|
|
|
503 |
jQuery('select#input_notification_service').change(function() {
|
504 |
var selected = jQuery( this ).val();
|
505 |
|
@@ -521,27 +567,77 @@ function handleConfigurationResponse(response) {
|
|
521 |
Hook.call( 'post_smtp_notification_change', selected );
|
522 |
});
|
523 |
|
524 |
-
//
|
525 |
-
jQuery('input.user_socket_override').change(function() {
|
526 |
userOverrideMenu();
|
527 |
-
});
|
|
|
|
|
|
|
|
|
|
|
528 |
}
|
529 |
|
530 |
-
|
531 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
532 |
var radioInputValue = ' value="' + value + '"';
|
533 |
var radioInputChecked = '';
|
|
|
|
|
|
|
|
|
|
|
|
|
534 |
if (isSelected) {
|
535 |
radioInputChecked = ' checked = "checked"';
|
536 |
}
|
537 |
-
|
538 |
if (isSecure) {
|
539 |
-
secureIcon = '🔒
|
540 |
}
|
541 |
-
|
542 |
-
|
543 |
-
|
544 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
545 |
}
|
546 |
|
547 |
/**
|
116 |
loading : post_smtp_localize.steps_loading
|
117 |
},
|
118 |
onStepChanging : function(event, currentIndex, newIndex) {
|
119 |
+
|
120 |
+
var response = handleStepChange( event, currentIndex, newIndex, jQuery( this ) );
|
121 |
+
|
122 |
+
if( response ) {
|
123 |
+
|
124 |
+
if( !jQuery( `#postman_wizard-t-${currentIndex} span` ).hasClass( 'dashicons' ) )
|
125 |
+
jQuery( `#postman_wizard-t-${currentIndex}` ).append( '<span class="ps-right dashicons dashicons-yes-alt"></span>' );
|
126 |
+
|
127 |
+
}
|
128 |
+
|
129 |
+
return response;
|
130 |
|
131 |
},
|
132 |
onInit : function() {
|
133 |
+
|
134 |
+
if( !jQuery( `#postman_wizard-t-0 span` ).hasClass( 'dashicons' ) )
|
135 |
+
jQuery( '#postman_wizard-t-0' ).append( '<span class="ps-right dashicons dashicons-yes-alt"></span>' );
|
136 |
+
|
137 |
jQuery(post_smtp_localize.postman_input_sender_email).focus();
|
138 |
+
|
139 |
},
|
140 |
onStepChanged : function(event, currentIndex, priorIndex) {
|
141 |
return postHandleStepChange(event, currentIndex,
|
321 |
var hostname = response.hosts[x].host;
|
322 |
var port = response.hosts[x].port;
|
323 |
var transport = response.hosts[x].transport_id;
|
324 |
+
var logoURL = response.hosts[x].logo_url;
|
325 |
portsToCheck++;
|
326 |
show('#connectivity_test_status');
|
327 |
updateStatus(postman_port_test.in_progress + " " + portsToCheck);
|
330 |
'hostname' : hostname,
|
331 |
'port' : port,
|
332 |
'transport' : transport,
|
333 |
+
'logo_url': logoURL,
|
334 |
'security' : jQuery('#security').val(),
|
335 |
};
|
336 |
postThePortTest(hostname, port, data);
|
465 |
});
|
466 |
}
|
467 |
function handleConfigurationResponse(response) {
|
468 |
+
|
469 |
+
var html = '';
|
470 |
+
var authHtml = '';
|
471 |
+
|
472 |
jQuery('#input_transport_type').val(response.configuration.transport_type);
|
473 |
transports.forEach(function(item) {
|
474 |
item.handleConfigurationResponse(response);
|
479 |
show('.user_override');
|
480 |
var el1 = jQuery('#user_socket_override');
|
481 |
el1.html('');
|
482 |
+
|
483 |
+
var columns = 1;
|
484 |
+
|
485 |
for (i = 0; i < response.override_menu.length; i++) {
|
486 |
+
|
487 |
+
response.override_menu[i].data = response.override_menu[i].data !== null ? response.override_menu[i].data : false;
|
488 |
+
|
489 |
+
if( columns == 1 ) {
|
490 |
+
html += "<div class='ps-socket-wizad-row'>";
|
491 |
+
}
|
492 |
+
|
493 |
+
html += buildRadioButtonGroup(
|
494 |
+
'user_socket_override',
|
495 |
response.override_menu[i].selected,
|
496 |
response.override_menu[i].value,
|
497 |
response.override_menu[i].description,
|
498 |
+
response.override_menu[i].secure,
|
499 |
+
response.override_menu[i].data
|
500 |
+
);
|
501 |
+
|
502 |
+
if( columns == 3 ) {
|
503 |
+
html += '</div>';
|
504 |
+
columns = 0;
|
505 |
+
}
|
506 |
+
|
507 |
+
columns++;
|
508 |
+
|
509 |
// populate user Auth Override menu
|
510 |
if (response.override_menu[i].selected) {
|
511 |
if (response.override_menu[i].mitm) {
|
523 |
el2.html('');
|
524 |
hide('#smtp_not_secure');
|
525 |
for (j = 0; j < response.override_menu[i].auth_items.length; j++) {
|
526 |
+
|
527 |
+
authHtml += buildRadioButtonGroup(
|
528 |
+
'user_auth_override',
|
529 |
response.override_menu[i].auth_items[j].selected,
|
530 |
response.override_menu[i].auth_items[j].value,
|
531 |
+
response.override_menu[i].auth_items[j].name,
|
532 |
+
false
|
533 |
+
);
|
534 |
+
|
535 |
if (response.override_menu[i].auth_items[j].selected
|
536 |
&& !response.override_menu[i].secure
|
537 |
&& response.override_menu[i].auth_items[j].value != 'none') {
|
538 |
show('#smtp_not_secure');
|
539 |
}
|
540 |
}
|
|
|
|
|
|
|
|
|
541 |
}
|
542 |
|
543 |
+
|
544 |
}
|
545 |
|
546 |
+
el1.append( html );
|
547 |
+
el2.append( authHtml );
|
548 |
+
|
549 |
jQuery('select#input_notification_service').change(function() {
|
550 |
var selected = jQuery( this ).val();
|
551 |
|
567 |
Hook.call( 'post_smtp_notification_change', selected );
|
568 |
});
|
569 |
|
570 |
+
// Add an event on Socket Selection/ Switching
|
571 |
+
jQuery( 'input.user_socket_override' ).change( function() {
|
572 |
userOverrideMenu();
|
573 |
+
} );
|
574 |
+
|
575 |
+
// Add an event on Socket's Auth Type Selection/ Switching
|
576 |
+
jQuery( 'input.user_auth_override' ).change( function() {
|
577 |
+
userOverrideMenu();
|
578 |
+
} );
|
579 |
}
|
580 |
|
581 |
+
/**
|
582 |
+
*
|
583 |
+
* @param {*} radioGroupName
|
584 |
+
* @param {*} isSelected
|
585 |
+
* @param {*} value
|
586 |
+
* @param {*} label
|
587 |
+
* @param {*} isSecure
|
588 |
+
* @param {*} data
|
589 |
+
* @returns
|
590 |
+
*
|
591 |
+
* @since 2.1 Returns html instead of appending
|
592 |
+
*/
|
593 |
+
function buildRadioButtonGroup( radioGroupName, isSelected, value, label, isSecure, data = '' ) {
|
594 |
+
|
595 |
var radioInputValue = ' value="' + value + '"';
|
596 |
var radioInputChecked = '';
|
597 |
+
var secureIcon = '';
|
598 |
+
var logoTag = '';
|
599 |
+
var html = '';
|
600 |
+
var recommendedBlock = '';
|
601 |
+
var relativeClass = '';
|
602 |
+
|
603 |
if (isSelected) {
|
604 |
radioInputChecked = ' checked = "checked"';
|
605 |
}
|
606 |
+
|
607 |
if (isSecure) {
|
608 |
+
secureIcon = '🔒';
|
609 |
}
|
610 |
+
|
611 |
+
if( data.logo_url && data.logo_url !== undefined ) {
|
612 |
+
|
613 |
+
if( label == 'Sendinblue' ) {
|
614 |
+
|
615 |
+
relativeClass = 'ps-sib';
|
616 |
+
recommendedBlock = `
|
617 |
+
<img src="${postman.assets}images/icons/recommended.png" class="ps-sib-recommended" />
|
618 |
+
`;
|
619 |
+
|
620 |
+
}
|
621 |
+
|
622 |
+
logoTag = `
|
623 |
+
<div class='ps-single-socket-outer ${relativeClass}'>
|
624 |
+
${recommendedBlock}
|
625 |
+
<img src='${data.logo_url}' class='ps-wizard-socket-logo' width='165px' />
|
626 |
+
</div>
|
627 |
+
`;
|
628 |
+
|
629 |
+
}
|
630 |
+
|
631 |
+
html = `
|
632 |
+
<label>
|
633 |
+
${logoTag}
|
634 |
+
<input class="${radioGroupName}" type="radio" name="${radioGroupName}"${radioInputChecked} ${radioInputValue} />
|
635 |
+
${secureIcon + label}
|
636 |
+
</label>
|
637 |
+
`;
|
638 |
+
|
639 |
+
return html;
|
640 |
+
|
641 |
}
|
642 |
|
643 |
/**
|
Postman/Postman-Connectivity-Test/PostmanConnectivityTestController.php
CHANGED
@@ -264,6 +264,9 @@ class PostmanPortTestAjaxController {
|
|
264 |
$port = intval( PostmanUtils::getRequestParameter( 'port' ) );
|
265 |
$transport = trim( PostmanUtils::getRequestParameter( 'transport' ) );
|
266 |
$timeout = PostmanUtils::getRequestParameter( 'timeout' );
|
|
|
|
|
|
|
267 |
$this->logger->trace( $timeout );
|
268 |
$portTest = new PostmanPortTest( $hostname, $port );
|
269 |
if ( isset( $timeout ) ) {
|
@@ -277,7 +280,8 @@ class PostmanPortTestAjaxController {
|
|
277 |
$this->logger->debug( sprintf( 'testing HTTPS socket %s:%s (%s)', $hostname, $port, $transport ) );
|
278 |
$success = $portTest->testHttpPorts();
|
279 |
}
|
280 |
-
|
|
|
281 |
}
|
282 |
/**
|
283 |
* This Ajax function retrieves whether a TCP port is open or not
|
@@ -290,11 +294,14 @@ class PostmanPortTestAjaxController {
|
|
290 |
$port = intval( PostmanUtils::getRequestParameter( 'port' ) );
|
291 |
$transport = trim( PostmanUtils::getRequestParameter( 'transport' ) );
|
292 |
$transportName = trim( PostmanUtils::getRequestParameter( 'transport_name' ) );
|
|
|
|
|
|
|
293 |
$this->logger->debug( sprintf( 'testing SMTPS socket %s:%s (%s)', $hostname, $port, $transport ) );
|
294 |
$portTest = new PostmanPortTest( $hostname, $port );
|
295 |
$portTest->transportName = $transportName;
|
296 |
$success = $portTest->testSmtpsPorts();
|
297 |
-
$this->buildResponse( $hostname, $port, $portTest, $success, $transport );
|
298 |
}
|
299 |
|
300 |
/**
|
@@ -302,29 +309,32 @@ class PostmanPortTestAjaxController {
|
|
302 |
* @param mixed $hostname
|
303 |
* @param mixed $port
|
304 |
* @param mixed $success
|
|
|
305 |
*/
|
306 |
-
private function buildResponse( $hostname, $port, PostmanPortTest $portTest, $success, $transport = '' ) {
|
307 |
$this->logger->debug( sprintf( 'testing port result for %s:%s success=%s', $hostname, $port, $success ) );
|
308 |
$response = array(
|
309 |
-
'hostname'
|
310 |
-
'hostname_domain_only'
|
311 |
-
'port'
|
312 |
-
'protocol'
|
313 |
-
'secure'
|
314 |
-
'mitm'
|
315 |
-
'reported_hostname'
|
316 |
'reported_hostname_domain_only' => $portTest->reportedHostnameDomainOnly,
|
317 |
-
'message'
|
318 |
-
'start_tls'
|
319 |
-
'auth_plain'
|
320 |
-
'auth_login'
|
321 |
-
'auth_crammd5'
|
322 |
-
'auth_xoauth'
|
323 |
-
'auth_none'
|
324 |
-
'try_smtps'
|
325 |
-
'success'
|
326 |
-
'transport'
|
|
|
327 |
);
|
|
|
328 |
$this->logger->trace( 'Ajax response:' );
|
329 |
$this->logger->trace( $response );
|
330 |
if ( $success ) {
|
264 |
$port = intval( PostmanUtils::getRequestParameter( 'port' ) );
|
265 |
$transport = trim( PostmanUtils::getRequestParameter( 'transport' ) );
|
266 |
$timeout = PostmanUtils::getRequestParameter( 'timeout' );
|
267 |
+
$logo_url = PostmanUtils::getRequestParameter( 'logo_url' );
|
268 |
+
$data['logo_url'] = $logo_url;
|
269 |
+
|
270 |
$this->logger->trace( $timeout );
|
271 |
$portTest = new PostmanPortTest( $hostname, $port );
|
272 |
if ( isset( $timeout ) ) {
|
280 |
$this->logger->debug( sprintf( 'testing HTTPS socket %s:%s (%s)', $hostname, $port, $transport ) );
|
281 |
$success = $portTest->testHttpPorts();
|
282 |
}
|
283 |
+
|
284 |
+
$this->buildResponse( $hostname, $port, $portTest, $success, $transport, $data );
|
285 |
}
|
286 |
/**
|
287 |
* This Ajax function retrieves whether a TCP port is open or not
|
294 |
$port = intval( PostmanUtils::getRequestParameter( 'port' ) );
|
295 |
$transport = trim( PostmanUtils::getRequestParameter( 'transport' ) );
|
296 |
$transportName = trim( PostmanUtils::getRequestParameter( 'transport_name' ) );
|
297 |
+
$logo_url = PostmanUtils::getRequestParameter( 'logo_url' );
|
298 |
+
$data['logo_url'] = $logo_url;
|
299 |
+
|
300 |
$this->logger->debug( sprintf( 'testing SMTPS socket %s:%s (%s)', $hostname, $port, $transport ) );
|
301 |
$portTest = new PostmanPortTest( $hostname, $port );
|
302 |
$portTest->transportName = $transportName;
|
303 |
$success = $portTest->testSmtpsPorts();
|
304 |
+
$this->buildResponse( $hostname, $port, $portTest, $success, $transport, $data );
|
305 |
}
|
306 |
|
307 |
/**
|
309 |
* @param mixed $hostname
|
310 |
* @param mixed $port
|
311 |
* @param mixed $success
|
312 |
+
* @since 2.1 @param mixed $data for extra fields
|
313 |
*/
|
314 |
+
private function buildResponse( $hostname, $port, PostmanPortTest $portTest, $success, $transport = '', $data = array() ) {
|
315 |
$this->logger->debug( sprintf( 'testing port result for %s:%s success=%s', $hostname, $port, $success ) );
|
316 |
$response = array(
|
317 |
+
'hostname' => $hostname,
|
318 |
+
'hostname_domain_only' => $portTest->hostnameDomainOnly,
|
319 |
+
'port' => $port,
|
320 |
+
'protocol' => $portTest->protocol,
|
321 |
+
'secure' => ($portTest->secure),
|
322 |
+
'mitm' => ($portTest->mitm),
|
323 |
+
'reported_hostname' => $portTest->reportedHostname,
|
324 |
'reported_hostname_domain_only' => $portTest->reportedHostnameDomainOnly,
|
325 |
+
'message' => $portTest->getErrorMessage(),
|
326 |
+
'start_tls' => $portTest->startTls,
|
327 |
+
'auth_plain' => $portTest->authPlain,
|
328 |
+
'auth_login' => $portTest->authLogin,
|
329 |
+
'auth_crammd5' => $portTest->authCrammd5,
|
330 |
+
'auth_xoauth' => $portTest->authXoauth,
|
331 |
+
'auth_none' => $portTest->authNone,
|
332 |
+
'try_smtps' => $portTest->trySmtps,
|
333 |
+
'success' => $success,
|
334 |
+
'transport' => $transport,
|
335 |
+
'data' => $data
|
336 |
);
|
337 |
+
|
338 |
$this->logger->trace( 'Ajax response:' );
|
339 |
$this->logger->trace( $response );
|
340 |
if ( $success ) {
|
Postman/Postman-Controller/PostmanManageConfigurationAjaxHandler.php
CHANGED
@@ -24,6 +24,13 @@ class PostmanWizardSocket {
|
|
24 |
public $try_smtps;
|
25 |
public $success;
|
26 |
public $transport;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
// these variables are populated by The Transport Recommenders
|
29 |
public $label;
|
@@ -52,6 +59,8 @@ class PostmanWizardSocket {
|
|
52 |
$this->try_smtps = PostmanUtils::parseBoolean ( $queryHostData ['try_smtps'] );
|
53 |
$this->success = PostmanUtils::parseBoolean ( $queryHostData ['success'] );
|
54 |
$this->transport = $queryHostData ['transport'];
|
|
|
|
|
55 |
assert ( ! empty ( $this->transport ) );
|
56 |
$this->id = sprintf ( '%s_%s', $this->hostname, $this->port );
|
57 |
}
|
24 |
public $try_smtps;
|
25 |
public $success;
|
26 |
public $transport;
|
27 |
+
|
28 |
+
/**
|
29 |
+
* Extra Fields
|
30 |
+
*
|
31 |
+
* @since 2.1
|
32 |
+
*/
|
33 |
+
public $data = false;
|
34 |
|
35 |
// these variables are populated by The Transport Recommenders
|
36 |
public $label;
|
59 |
$this->try_smtps = PostmanUtils::parseBoolean ( $queryHostData ['try_smtps'] );
|
60 |
$this->success = PostmanUtils::parseBoolean ( $queryHostData ['success'] );
|
61 |
$this->transport = $queryHostData ['transport'];
|
62 |
+
$this->data = $queryHostData['data'];
|
63 |
+
|
64 |
assert ( ! empty ( $this->transport ) );
|
65 |
$this->id = sprintf ( '%s_%s', $this->hostname, $this->port );
|
66 |
}
|
Postman/Postman-Email-Log/PostmanEmailLogController.php
CHANGED
@@ -385,12 +385,18 @@ class PostmanEmailLogController {
|
|
385 |
}
|
386 |
}
|
387 |
|
|
|
|
|
|
|
|
|
|
|
|
|
388 |
function postman_email_log_enqueue_resources() {
|
389 |
-
|
390 |
-
|
391 |
-
wp_enqueue_style( 'postman_email_log' );
|
392 |
wp_enqueue_script( 'postman_resend_email_script' );
|
393 |
wp_enqueue_script( 'sprintf' );
|
|
|
394 |
}
|
395 |
|
396 |
/**
|
@@ -423,8 +429,7 @@ class PostmanEmailLogController {
|
|
423 |
|
424 |
<?php //include_once POST_SMTP_PATH . '/Postman/extra/donation.php'; ?>
|
425 |
|
426 |
-
<div
|
427 |
-
style="background: #ECECEC; border: 1px solid #CCC; padding: 0 10px; margin-top: 5px; border-radius: 5px; -moz-border-radius: 5px; -webkit-border-radius: 5px;">
|
428 |
<p><?php
|
429 |
|
430 |
echo __( 'This is a record of deliveries made to the mail server. It does not neccessarily indicate sucessful delivery to the recipient.', 'post-smtp' )?></p>
|
@@ -469,15 +474,15 @@ class PostmanEmailLogController {
|
|
469 |
</div>
|
470 |
|
471 |
<div class="form-control" style="padding: 0 5px 0 5px;">
|
472 |
-
<button type="submit" name="filter" class="
|
473 |
</div>
|
474 |
|
475 |
<div class="form-control" style="padding: 0 5px 0 0px;">
|
476 |
-
<button type="submit" id="postman_export_csv" name="postman_export_csv" class="
|
477 |
</div>
|
478 |
|
479 |
<div class="form-control">
|
480 |
-
<button type="submit" id="postman_trash_all" name="postman_trash_all" class="
|
481 |
</div>
|
482 |
|
483 |
</div>
|
385 |
}
|
386 |
}
|
387 |
|
388 |
+
/**
|
389 |
+
* Enqueus Styles/ Scripts
|
390 |
+
*
|
391 |
+
* @since 2.1 Changed stylesheet
|
392 |
+
* @version 1.0
|
393 |
+
*/
|
394 |
function postman_email_log_enqueue_resources() {
|
395 |
+
|
396 |
+
wp_enqueue_style( PostmanViewController::POSTMAN_STYLE );
|
|
|
397 |
wp_enqueue_script( 'postman_resend_email_script' );
|
398 |
wp_enqueue_script( 'sprintf' );
|
399 |
+
|
400 |
}
|
401 |
|
402 |
/**
|
429 |
|
430 |
<?php //include_once POST_SMTP_PATH . '/Postman/extra/donation.php'; ?>
|
431 |
|
432 |
+
<div class="ps-config-bar">
|
|
|
433 |
<p><?php
|
434 |
|
435 |
echo __( 'This is a record of deliveries made to the mail server. It does not neccessarily indicate sucessful delivery to the recipient.', 'post-smtp' )?></p>
|
474 |
</div>
|
475 |
|
476 |
<div class="form-control" style="padding: 0 5px 0 5px;">
|
477 |
+
<button type="submit" name="filter" class="ps-btn-orange"><?php _e( 'Filter/Search', 'post-smtp' ); ?></button>
|
478 |
</div>
|
479 |
|
480 |
<div class="form-control" style="padding: 0 5px 0 0px;">
|
481 |
+
<button type="submit" id="postman_export_csv" name="postman_export_csv" class="ps-btn-orange"><?php _e( 'Export To CSV', 'post-smtp' ); ?></button>
|
482 |
</div>
|
483 |
|
484 |
<div class="form-control">
|
485 |
+
<button type="submit" id="postman_trash_all" name="postman_trash_all" class="ps-btn-red"><?php _e( 'Trash All', 'post-smtp' ); ?></button>
|
486 |
</div>
|
487 |
|
488 |
</div>
|
Postman/Postman-Mail/PostmanGmailApiModuleTransport.php
CHANGED
@@ -204,6 +204,8 @@ class PostmanGmailApiModuleTransport extends PostmanAbstractZendModuleTransport
|
|
204 |
$recommendation ['hostname'] = null; // scribe looks this
|
205 |
$recommendation ['label'] = $this->getName ();
|
206 |
$recommendation ['display_auth'] = 'oauth2';
|
|
|
|
|
207 |
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
208 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
209 |
$recommendation ['message'] = sprintf ( __ ( ('Postman recommends the %1$s to host %2$s on port %3$d.') ), $this->getName (), self::HOST, self::PORT );
|
@@ -258,4 +260,16 @@ class PostmanGmailApiModuleTransport extends PostmanAbstractZendModuleTransport
|
|
258 |
public function enqueueScript() {
|
259 |
wp_enqueue_script ( 'postman_gmail_script' );
|
260 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
261 |
}
|
204 |
$recommendation ['hostname'] = null; // scribe looks this
|
205 |
$recommendation ['label'] = $this->getName ();
|
206 |
$recommendation ['display_auth'] = 'oauth2';
|
207 |
+
$recommendation['logo_url'] = $this->getLogoURL();
|
208 |
+
|
209 |
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
210 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
211 |
$recommendation ['message'] = sprintf ( __ ( ('Postman recommends the %1$s to host %2$s on port %3$d.') ), $this->getName (), self::HOST, self::PORT );
|
260 |
public function enqueueScript() {
|
261 |
wp_enqueue_script ( 'postman_gmail_script' );
|
262 |
}
|
263 |
+
|
264 |
+
/**
|
265 |
+
* Get Socket's logo
|
266 |
+
*
|
267 |
+
* @since 2.1
|
268 |
+
* @version 1.0
|
269 |
+
*/
|
270 |
+
public function getLogoURL() {
|
271 |
+
|
272 |
+
return POST_SMTP_ASSETS . "images/logos/gmail.png";
|
273 |
+
|
274 |
+
}
|
275 |
}
|
Postman/Postman-Mail/PostmanMailgunTransport.php
CHANGED
@@ -133,6 +133,8 @@ class PostmanMailgunTransport extends PostmanAbstractModuleTransport implements
|
|
133 |
$recommendation ['transport'] = self::SLUG;
|
134 |
$recommendation ['hostname'] = null; // scribe looks this
|
135 |
$recommendation ['label'] = $this->getName();
|
|
|
|
|
136 |
if ( $hostData->hostname == $this->getHostname() && $hostData->port == self::PORT ) {
|
137 |
$recommendation ['priority'] = self::PRIORITY;
|
138 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
@@ -216,12 +218,12 @@ class PostmanMailgunTransport extends PostmanAbstractModuleTransport implements
|
|
216 |
/**
|
217 |
*/
|
218 |
public function mailgun_api_key_callback() {
|
219 |
-
printf( '<input type="password" autocomplete="off" id="mailgun_api_key" name="postman_options[mailgun_api_key]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getMailgunApiKey() ? esc_attr( PostmanUtils::obfuscatePassword( $this->options->getMailgunApiKey() ) ) : '', __( 'Required', 'post-smtp' ) );
|
220 |
print '<input type="button" id="toggleMailgunApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
221 |
}
|
222 |
|
223 |
function mailgun_domain_name_callback() {
|
224 |
-
printf( '<input type="text" autocomplete="off" id="mailgun_domain_name" name="postman_options[mailgun_domain_name]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getMailgunDomainName() ? esc_attr( $this->options->getMailgunDomainName() ) : '', __( 'Required', 'post-smtp' ) );
|
225 |
}
|
226 |
|
227 |
function mailgun_region_callback() {
|
@@ -264,4 +266,16 @@ class PostmanMailgunTransport extends PostmanAbstractModuleTransport implements
|
|
264 |
print $this->mailgun_region_callback();
|
265 |
print '</section>';
|
266 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
267 |
}
|
133 |
$recommendation ['transport'] = self::SLUG;
|
134 |
$recommendation ['hostname'] = null; // scribe looks this
|
135 |
$recommendation ['label'] = $this->getName();
|
136 |
+
$recommendation['logo_url'] = $this->getLogoURL();
|
137 |
+
|
138 |
if ( $hostData->hostname == $this->getHostname() && $hostData->port == self::PORT ) {
|
139 |
$recommendation ['priority'] = self::PRIORITY;
|
140 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
218 |
/**
|
219 |
*/
|
220 |
public function mailgun_api_key_callback() {
|
221 |
+
printf( '<input type="password" autocomplete="off" id="mailgun_api_key" name="postman_options[mailgun_api_key]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getMailgunApiKey() ? esc_attr( PostmanUtils::obfuscatePassword( $this->options->getMailgunApiKey() ) ) : '', __( 'Required', 'post-smtp' ) );
|
222 |
print '<input type="button" id="toggleMailgunApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
223 |
}
|
224 |
|
225 |
function mailgun_domain_name_callback() {
|
226 |
+
printf( '<input type="text" autocomplete="off" id="mailgun_domain_name" name="postman_options[mailgun_domain_name]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getMailgunDomainName() ? esc_attr( $this->options->getMailgunDomainName() ) : '', __( 'Required', 'post-smtp' ) );
|
227 |
}
|
228 |
|
229 |
function mailgun_region_callback() {
|
266 |
print $this->mailgun_region_callback();
|
267 |
print '</section>';
|
268 |
}
|
269 |
+
|
270 |
+
/**
|
271 |
+
* Get Socket's logo
|
272 |
+
*
|
273 |
+
* @since 2.1
|
274 |
+
* @version 1.0
|
275 |
+
*/
|
276 |
+
public function getLogoURL() {
|
277 |
+
|
278 |
+
return POST_SMTP_ASSETS . "images/logos/mailgun.png";
|
279 |
+
|
280 |
+
}
|
281 |
}
|
Postman/Postman-Mail/PostmanMandrillTransport.php
CHANGED
@@ -179,6 +179,8 @@ class PostmanMandrillTransport extends PostmanAbstractModuleTransport implements
|
|
179 |
$recommendation ['transport'] = self::SLUG;
|
180 |
$recommendation ['hostname'] = null; // scribe looks this
|
181 |
$recommendation ['label'] = $this->getName ();
|
|
|
|
|
182 |
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
183 |
$recommendation ['priority'] = self::PRIORITY;
|
184 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
@@ -245,7 +247,7 @@ class PostmanMandrillTransport extends PostmanAbstractModuleTransport implements
|
|
245 |
/**
|
246 |
*/
|
247 |
public function mandrill_api_key_callback() {
|
248 |
-
printf ( '<input type="password" autocomplete="off" id="mandrill_api_key" name="postman_options[mandrill_api_key]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getMandrillApiKey () ? esc_attr ( PostmanUtils::obfuscatePassword ( $this->options->getMandrillApiKey () ) ) : '', __ ( 'Required', 'post-smtp' ) );
|
249 |
print ' <input type="button" id="toggleMandrillApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
250 |
}
|
251 |
|
@@ -277,4 +279,16 @@ class PostmanMandrillTransport extends PostmanAbstractModuleTransport implements
|
|
277 |
print $this->mandrill_api_key_callback ();
|
278 |
print '</section>';
|
279 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
280 |
}
|
179 |
$recommendation ['transport'] = self::SLUG;
|
180 |
$recommendation ['hostname'] = null; // scribe looks this
|
181 |
$recommendation ['label'] = $this->getName ();
|
182 |
+
$recommendation['logo_url'] = $this->getLogoURL();
|
183 |
+
|
184 |
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
185 |
$recommendation ['priority'] = self::PRIORITY;
|
186 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
247 |
/**
|
248 |
*/
|
249 |
public function mandrill_api_key_callback() {
|
250 |
+
printf ( '<input type="password" autocomplete="off" id="mandrill_api_key" name="postman_options[mandrill_api_key]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getMandrillApiKey () ? esc_attr ( PostmanUtils::obfuscatePassword ( $this->options->getMandrillApiKey () ) ) : '', __ ( 'Required', 'post-smtp' ) );
|
251 |
print ' <input type="button" id="toggleMandrillApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
252 |
}
|
253 |
|
279 |
print $this->mandrill_api_key_callback ();
|
280 |
print '</section>';
|
281 |
}
|
282 |
+
|
283 |
+
/**
|
284 |
+
* Get Socket's logo
|
285 |
+
*
|
286 |
+
* @since 2.1
|
287 |
+
* @version 1.0
|
288 |
+
*/
|
289 |
+
public function getLogoURL() {
|
290 |
+
|
291 |
+
return POST_SMTP_ASSETS . "images/logos/mandrill.png";
|
292 |
+
|
293 |
+
}
|
294 |
}
|
Postman/Postman-Mail/PostmanModuleTransport.php
CHANGED
@@ -29,6 +29,14 @@ if (! interface_exists ( 'PostmanTransport' )) {
|
|
29 |
public function getConfigurationRecommendation($hostData);
|
30 |
// @deprecated
|
31 |
public function getHostsToTest($hostname);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
32 |
}
|
33 |
}
|
34 |
interface PostmanModuleTransport extends PostmanTransport {
|
@@ -115,8 +123,11 @@ abstract class PostmanAbstractModuleTransport implements PostmanModuleTransport
|
|
115 |
|
116 |
/**
|
117 |
* Creates a single socket for the Wizard to test
|
|
|
|
|
118 |
*/
|
119 |
protected function createSocketDefinition($hostname, $port) {
|
|
|
120 |
$socket = array ();
|
121 |
$socket ['host'] = $hostname;
|
122 |
$socket ['port'] = $port;
|
@@ -124,7 +135,10 @@ abstract class PostmanAbstractModuleTransport implements PostmanModuleTransport
|
|
124 |
$socket ['transport_id'] = $this->getSlug ();
|
125 |
$socket ['transport_name'] = $this->getName ();
|
126 |
$socket ['smtp'] = false;
|
|
|
|
|
127 |
return $socket;
|
|
|
128 |
}
|
129 |
|
130 |
/**
|
@@ -137,9 +151,12 @@ abstract class PostmanAbstractModuleTransport implements PostmanModuleTransport
|
|
137 |
}
|
138 |
|
139 |
/**
|
|
|
|
|
|
|
140 |
*/
|
141 |
public function printActionMenuItem() {
|
142 |
-
|
143 |
}
|
144 |
|
145 |
/**
|
@@ -308,6 +325,7 @@ abstract class PostmanAbstractModuleTransport implements PostmanModuleTransport
|
|
308 |
/**
|
309 |
*/
|
310 |
public function createOverrideMenu(PostmanWizardSocket $socket, $winningRecommendation, $userSocketOverride, $userAuthOverride) {
|
|
|
311 |
$overrideItem = array ();
|
312 |
$overrideItem ['secure'] = $socket->secure;
|
313 |
$overrideItem ['mitm'] = $socket->mitm;
|
@@ -316,6 +334,8 @@ abstract class PostmanAbstractModuleTransport implements PostmanModuleTransport
|
|
316 |
$overrideItem ['value'] = $socket->id;
|
317 |
$overrideItem ['description'] = $socket->label;
|
318 |
$overrideItem ['selected'] = ($winningRecommendation ['id'] == $overrideItem ['value']);
|
|
|
|
|
319 |
return $overrideItem;
|
320 |
}
|
321 |
|
@@ -449,10 +469,13 @@ abstract class PostmanAbstractZendModuleTransport extends PostmanAbstractModuleT
|
|
449 |
}
|
450 |
|
451 |
/**
|
|
|
|
|
|
|
452 |
*/
|
453 |
public function printActionMenuItem() {
|
454 |
if ($this->readyForOAuthGrant && $this->getAuthenticationType () == PostmanOptions::AUTHENTICATION_TYPE_OAUTH2) {
|
455 |
-
|
456 |
} else {
|
457 |
parent::printActionMenuItem ();
|
458 |
}
|
@@ -758,5 +781,17 @@ abstract class PostmanAbstractZendModuleTransport extends PostmanAbstractModuleT
|
|
758 |
}
|
759 |
return $overrideItem;
|
760 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
761 |
}
|
762 |
|
29 |
public function getConfigurationRecommendation($hostData);
|
30 |
// @deprecated
|
31 |
public function getHostsToTest($hostname);
|
32 |
+
|
33 |
+
/**
|
34 |
+
* Get Socket's logo
|
35 |
+
*
|
36 |
+
* @since 2.1
|
37 |
+
* @version 1.0
|
38 |
+
*/
|
39 |
+
public function getLogoURL();
|
40 |
}
|
41 |
}
|
42 |
interface PostmanModuleTransport extends PostmanTransport {
|
123 |
|
124 |
/**
|
125 |
* Creates a single socket for the Wizard to test
|
126 |
+
*
|
127 |
+
* @since 2.1 added `logo_url`
|
128 |
*/
|
129 |
protected function createSocketDefinition($hostname, $port) {
|
130 |
+
|
131 |
$socket = array ();
|
132 |
$socket ['host'] = $hostname;
|
133 |
$socket ['port'] = $port;
|
135 |
$socket ['transport_id'] = $this->getSlug ();
|
136 |
$socket ['transport_name'] = $this->getName ();
|
137 |
$socket ['smtp'] = false;
|
138 |
+
$socket['logo_url'] = $this->getLogoURL();
|
139 |
+
|
140 |
return $socket;
|
141 |
+
|
142 |
}
|
143 |
|
144 |
/**
|
151 |
}
|
152 |
|
153 |
/**
|
154 |
+
* Returns the Status of OAuth
|
155 |
+
*
|
156 |
+
* @since 2.1 Removed HTML
|
157 |
*/
|
158 |
public function printActionMenuItem() {
|
159 |
+
echo $this->getScribe ()->getRequestPermissionLinkText ();
|
160 |
}
|
161 |
|
162 |
/**
|
325 |
/**
|
326 |
*/
|
327 |
public function createOverrideMenu(PostmanWizardSocket $socket, $winningRecommendation, $userSocketOverride, $userAuthOverride) {
|
328 |
+
|
329 |
$overrideItem = array ();
|
330 |
$overrideItem ['secure'] = $socket->secure;
|
331 |
$overrideItem ['mitm'] = $socket->mitm;
|
334 |
$overrideItem ['value'] = $socket->id;
|
335 |
$overrideItem ['description'] = $socket->label;
|
336 |
$overrideItem ['selected'] = ($winningRecommendation ['id'] == $overrideItem ['value']);
|
337 |
+
$overrideItem['data'] = $socket->data;
|
338 |
+
|
339 |
return $overrideItem;
|
340 |
}
|
341 |
|
469 |
}
|
470 |
|
471 |
/**
|
472 |
+
* Returns Link of OAuth
|
473 |
+
*
|
474 |
+
* @since 2.1 Removed `li` tag
|
475 |
*/
|
476 |
public function printActionMenuItem() {
|
477 |
if ($this->readyForOAuthGrant && $this->getAuthenticationType () == PostmanOptions::AUTHENTICATION_TYPE_OAUTH2) {
|
478 |
+
echo '<a href="'.esc_attr( PostmanUtils::getGrantOAuthPermissionUrl () ).'" class="welcome-icon send-test-email">'.esc_html( $this->getScribe ()->getRequestPermissionLinkText () ).'</a>';
|
479 |
} else {
|
480 |
parent::printActionMenuItem ();
|
481 |
}
|
781 |
}
|
782 |
return $overrideItem;
|
783 |
}
|
784 |
+
|
785 |
+
/**
|
786 |
+
* Get Socket's logo
|
787 |
+
*
|
788 |
+
* @since 2.1
|
789 |
+
* @version 1.0
|
790 |
+
*/
|
791 |
+
public function getLogoURL() {
|
792 |
+
|
793 |
+
return false;
|
794 |
+
|
795 |
+
}
|
796 |
}
|
797 |
|
Postman/Postman-Mail/PostmanSendGridTransport.php
CHANGED
@@ -123,6 +123,8 @@ class PostmanSendGridTransport extends PostmanAbstractModuleTransport implements
|
|
123 |
$recommendation ['transport'] = self::SLUG;
|
124 |
$recommendation ['hostname'] = null; // scribe looks this
|
125 |
$recommendation ['label'] = $this->getName ();
|
|
|
|
|
126 |
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
127 |
$recommendation ['priority'] = self::PRIORITY;
|
128 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
@@ -196,7 +198,7 @@ class PostmanSendGridTransport extends PostmanAbstractModuleTransport implements
|
|
196 |
/**
|
197 |
*/
|
198 |
public function sendgrid_api_key_callback() {
|
199 |
-
printf ( '<input type="password" autocomplete="off" id="sendgrid_api_key" name="postman_options[sendgrid_api_key]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getSendGridApiKey () ? esc_attr ( PostmanUtils::obfuscatePassword ( $this->options->getSendGridApiKey () ) ) : '', __ ( 'Required', 'post-smtp' ) );
|
200 |
print ' <input type="button" id="toggleSendGridApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
201 |
}
|
202 |
|
@@ -228,4 +230,16 @@ class PostmanSendGridTransport extends PostmanAbstractModuleTransport implements
|
|
228 |
print $this->sendgrid_api_key_callback ();
|
229 |
print '</section>';
|
230 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
231 |
}
|
123 |
$recommendation ['transport'] = self::SLUG;
|
124 |
$recommendation ['hostname'] = null; // scribe looks this
|
125 |
$recommendation ['label'] = $this->getName ();
|
126 |
+
$recommendation['logo_url'] = $this->getLogoURL();
|
127 |
+
|
128 |
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
129 |
$recommendation ['priority'] = self::PRIORITY;
|
130 |
/* translators: where variables are (1) transport name (2) host and (3) port */
|
198 |
/**
|
199 |
*/
|
200 |
public function sendgrid_api_key_callback() {
|
201 |
+
printf ( '<input type="password" autocomplete="off" id="sendgrid_api_key" name="postman_options[sendgrid_api_key]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getSendGridApiKey () ? esc_attr ( PostmanUtils::obfuscatePassword ( $this->options->getSendGridApiKey () ) ) : '', __ ( 'Required', 'post-smtp' ) );
|
202 |
print ' <input type="button" id="toggleSendGridApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
203 |
}
|
204 |
|
230 |
print $this->sendgrid_api_key_callback ();
|
231 |
print '</section>';
|
232 |
}
|
233 |
+
|
234 |
+
/**
|
235 |
+
* Get Socket's logo
|
236 |
+
*
|
237 |
+
* @since 2.1
|
238 |
+
* @version 1.0
|
239 |
+
*/
|
240 |
+
public function getLogoURL() {
|
241 |
+
|
242 |
+
return POST_SMTP_ASSETS . "images/logos/sendgrid.png";
|
243 |
+
|
244 |
+
}
|
245 |
}
|
Postman/Postman-Mail/PostmanSendinblueMailEngine.php
ADDED
@@ -0,0 +1,297 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
if ( ! defined( 'ABSPATH' ) ) {
|
3 |
+
exit; // Exit if accessed directly
|
4 |
+
}
|
5 |
+
|
6 |
+
if( !class_exists( 'PostmanSendinblueMailEngine' ) ):
|
7 |
+
|
8 |
+
require 'sendinblue/vendor/autoload.php';
|
9 |
+
|
10 |
+
class PostmanSendinblueMailEngine implements PostmanMailEngine {
|
11 |
+
|
12 |
+
protected $logger;
|
13 |
+
|
14 |
+
private $transcript;
|
15 |
+
|
16 |
+
private $api_key;
|
17 |
+
|
18 |
+
|
19 |
+
/**
|
20 |
+
* @since 2.1
|
21 |
+
* @version 1.0
|
22 |
+
*/
|
23 |
+
public function __construct( $api_key ) {
|
24 |
+
|
25 |
+
assert( !empty( $api_key ) );
|
26 |
+
$this->api_key = $api_key;
|
27 |
+
|
28 |
+
// create the logger
|
29 |
+
$this->logger = new PostmanLogger( get_class( $this ) );
|
30 |
+
|
31 |
+
}
|
32 |
+
|
33 |
+
/**
|
34 |
+
* @since 2.1
|
35 |
+
* @version 1.0
|
36 |
+
*/
|
37 |
+
public function getTranscript() {
|
38 |
+
return $this->transcript;
|
39 |
+
}
|
40 |
+
|
41 |
+
private function addAttachmentsToMail( PostmanMessage $message ) {
|
42 |
+
|
43 |
+
$attachments = $message->getAttachments();
|
44 |
+
if ( ! is_array( $attachments ) ) {
|
45 |
+
// WordPress may a single filename or a newline-delimited string list of multiple filenames
|
46 |
+
$attArray = explode( PHP_EOL, $attachments );
|
47 |
+
} else {
|
48 |
+
$attArray = $attachments;
|
49 |
+
}
|
50 |
+
// otherwise WordPress sends an array
|
51 |
+
$attachments = array();
|
52 |
+
foreach ( $attArray as $file ) {
|
53 |
+
if ( ! empty( $file ) ) {
|
54 |
+
$this->logger->debug( 'Adding attachment: ' . $file );
|
55 |
+
|
56 |
+
$file_name = basename( $file );
|
57 |
+
$file_parts = explode( '.', $file_name );
|
58 |
+
$file_type = wp_check_filetype( $file );
|
59 |
+
$attachments[] = array(
|
60 |
+
'content' => base64_encode( file_get_contents( $file ) ),
|
61 |
+
'type' => $file_type['type'],
|
62 |
+
'file_name' => $file_name,
|
63 |
+
'disposition' => 'attachment',
|
64 |
+
'id' => $file_parts[0],
|
65 |
+
);
|
66 |
+
}
|
67 |
+
}
|
68 |
+
|
69 |
+
return $attachments;
|
70 |
+
|
71 |
+
}
|
72 |
+
|
73 |
+
/**
|
74 |
+
* @since 2.1
|
75 |
+
* @version 1.0
|
76 |
+
*/
|
77 |
+
public function send( PostmanMessage $message ) {
|
78 |
+
|
79 |
+
$options = PostmanOptions::getInstance();
|
80 |
+
//Sendinblue preparation
|
81 |
+
if ( $this->logger->isDebug() ) {
|
82 |
+
$this->logger->debug( 'Creating SendGrid service with apiKey=' . $this->apiKey );
|
83 |
+
}
|
84 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', $this->api_key);
|
85 |
+
$sendSmtpEmail = new \SendinBlue\Client\Model\SendSmtpEmail();
|
86 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
87 |
+
new GuzzleHttp\Client(),
|
88 |
+
$config
|
89 |
+
);
|
90 |
+
|
91 |
+
$sender = $message->getFromAddress();
|
92 |
+
$senderEmail = !empty( $sender->getEmail() ) ? $sender->getEmail() : $options->getMessageSenderEmail();
|
93 |
+
$senderName = !empty( $sender->getName() ) ? $sender->getName() : $options->getMessageSenderName();
|
94 |
+
$headers = array();
|
95 |
+
|
96 |
+
$sender->log( $this->logger, 'From' );
|
97 |
+
|
98 |
+
$sendSmtpEmail['sender'] = array(
|
99 |
+
'name' => $senderName,
|
100 |
+
'email' => $senderEmail
|
101 |
+
);
|
102 |
+
|
103 |
+
$tos = array();
|
104 |
+
$duplicates = array();
|
105 |
+
|
106 |
+
// add the to recipients
|
107 |
+
foreach ( (array)$message->getToRecipients() as $recipient ) {
|
108 |
+
|
109 |
+
if ( !array_key_exists( $recipient->getEmail(), $duplicates ) ) {
|
110 |
+
|
111 |
+
$tos[] = array(
|
112 |
+
'email' => $recipient->getEmail(),
|
113 |
+
'name' => '$recipient->getName()'
|
114 |
+
);
|
115 |
+
$duplicates[] = $recipient->getEmail();
|
116 |
+
|
117 |
+
}
|
118 |
+
|
119 |
+
}
|
120 |
+
$sendSmtpEmail['to'] = $tos;
|
121 |
+
|
122 |
+
$sendSmtpEmail['subject'] = $message->getSubject();
|
123 |
+
|
124 |
+
$textPart = $message->getBodyTextPart();
|
125 |
+
if ( ! empty( $textPart ) ) {
|
126 |
+
$this->logger->debug( 'Adding body as text' );
|
127 |
+
$sendSmtpEmail['textContent'] = $textPart;
|
128 |
+
}
|
129 |
+
|
130 |
+
$htmlPart = $message->getBodyHtmlPart();
|
131 |
+
if ( ! empty( $htmlPart ) ) {
|
132 |
+
$this->logger->debug( 'Adding body as html' );
|
133 |
+
$sendSmtpEmail['htmlContent'] = $htmlPart;
|
134 |
+
}
|
135 |
+
|
136 |
+
// add the reply-to
|
137 |
+
$replyTo = $message->getReplyTo();
|
138 |
+
// $replyTo is null or a PostmanEmailAddress object
|
139 |
+
if ( isset( $replyTo ) ) {
|
140 |
+
$sendSmtpEmail['replyTo'] = array(
|
141 |
+
'email' => $replyTo->getEmail(),
|
142 |
+
'name' => '$replyTo->getName()'
|
143 |
+
);
|
144 |
+
}
|
145 |
+
|
146 |
+
// add the Postman signature - append it to whatever the user may have set
|
147 |
+
if ( ! $options->isStealthModeEnabled() ) {
|
148 |
+
$pluginData = apply_filters( 'postman_get_plugin_metadata', null );
|
149 |
+
$headers['X-Mailer'] = sprintf( 'Postman SMTP %s for WordPress (%s)', $pluginData ['version'], 'https://wordpress.org/plugins/post-smtp/' );
|
150 |
+
}
|
151 |
+
|
152 |
+
foreach ( ( array ) $message->getHeaders() as $header ) {
|
153 |
+
$this->logger->debug( sprintf( 'Adding user header %s=%s', $header ['name'], $header ['content'] ) );
|
154 |
+
$headers[$header['name']] = $header ['content'];
|
155 |
+
}
|
156 |
+
|
157 |
+
// add the messageId
|
158 |
+
$messageId = $message->getMessageId();
|
159 |
+
if ( ! empty( $messageId ) ) {
|
160 |
+
$headers['message-id'] = $messageId;
|
161 |
+
}
|
162 |
+
|
163 |
+
$sendSmtpEmail['headers'] = $headers;
|
164 |
+
|
165 |
+
// if the caller set a Content-Type header, use it
|
166 |
+
$contentType = $message->getContentType();
|
167 |
+
if ( ! empty( $contentType ) ) {
|
168 |
+
$this->logger->debug( 'Some header keys are reserved. You may not include any of the following reserved headers: x-sg-id, x-sg-eid, received, dkim-signature, Content-Type, Content-Transfer-Encoding, To, From, Subject, Reply-To, CC, BCC.' );
|
169 |
+
}
|
170 |
+
|
171 |
+
$cc = array();
|
172 |
+
$duplicates = array();
|
173 |
+
foreach ( ( array ) $message->getCcRecipients() as $recipient ) {
|
174 |
+
|
175 |
+
if ( ! in_array( $recipient->getEmail(), $duplicates ) ) {
|
176 |
+
|
177 |
+
$recipient->log($this->logger, 'Cc');
|
178 |
+
$cc[] = array(
|
179 |
+
'name' => '$recipient->getName()',
|
180 |
+
'email' => $recipient->getEmail()
|
181 |
+
);
|
182 |
+
$duplicates[] = $recipient->getEmail();
|
183 |
+
|
184 |
+
}
|
185 |
+
|
186 |
+
}
|
187 |
+
if( !empty( $cc ) )
|
188 |
+
$sendSmtpEmail['cc'] = $cc;
|
189 |
+
|
190 |
+
$bcc = array();
|
191 |
+
$duplicates = array();
|
192 |
+
foreach ( ( array ) $message->getBccRecipients() as $recipient ) {
|
193 |
+
|
194 |
+
if ( ! in_array( $recipient->getEmail(), $duplicates ) ) {
|
195 |
+
|
196 |
+
$recipient->log($this->logger, 'Bcc');
|
197 |
+
$bcc[] = array(
|
198 |
+
'email' => $recipient->getEmail(),
|
199 |
+
'name' => '$recipient->getName()'
|
200 |
+
);
|
201 |
+
$duplicates[] = $recipient->getEmail();
|
202 |
+
|
203 |
+
}
|
204 |
+
|
205 |
+
}
|
206 |
+
|
207 |
+
if( !empty( $bcc ) )
|
208 |
+
$sendSmtpEmail['bcc'] = $bcc;
|
209 |
+
|
210 |
+
// add attachments
|
211 |
+
$this->logger->debug( 'Adding attachments' );
|
212 |
+
|
213 |
+
$attachments = $this->addAttachmentsToMail( $message );
|
214 |
+
|
215 |
+
$email_attachments = array();
|
216 |
+
|
217 |
+
if( !empty( $attachments ) ) {
|
218 |
+
|
219 |
+
foreach ( $attachments as $index => $attachment ) {
|
220 |
+
|
221 |
+
$email_attachments[] = array(
|
222 |
+
'name' => $attachment['file_name'],
|
223 |
+
'content' => $attachment['content']
|
224 |
+
);
|
225 |
+
}
|
226 |
+
|
227 |
+
$sendSmtpEmail['attachment'] = $email_attachments;
|
228 |
+
|
229 |
+
}
|
230 |
+
|
231 |
+
|
232 |
+
try {
|
233 |
+
|
234 |
+
// send the message
|
235 |
+
if ( $this->logger->isDebug() ) {
|
236 |
+
$this->logger->debug( 'Sending mail' );
|
237 |
+
}
|
238 |
+
|
239 |
+
$response = $apiInstance->sendTransacEmail($sendSmtpEmail);
|
240 |
+
|
241 |
+
$this->transcript = print_r( $response, true );
|
242 |
+
$this->transcript .= PostmanModuleTransport::RAW_MESSAGE_FOLLOWS;
|
243 |
+
$this->transcript .= print_r( $sendSmtpEmail, true );
|
244 |
+
$this->logger->debug( 'Transcript=' . $this->transcript );
|
245 |
+
|
246 |
+
} catch (Exception $e) {
|
247 |
+
|
248 |
+
$this->transcript = $e->getMessage();
|
249 |
+
$this->transcript .= PostmanModuleTransport::RAW_MESSAGE_FOLLOWS;
|
250 |
+
$this->transcript .= print_r( $sendSmtpEmail, true );
|
251 |
+
$this->logger->debug( 'Transcript=' . $this->transcript );
|
252 |
+
|
253 |
+
throw $e;
|
254 |
+
|
255 |
+
}
|
256 |
+
|
257 |
+
}
|
258 |
+
|
259 |
+
/**
|
260 |
+
* @since 2.1
|
261 |
+
* @version 1.0
|
262 |
+
*/
|
263 |
+
private function errorCodesMap( $error_code ) {
|
264 |
+
switch ( $error_code ) {
|
265 |
+
case 400:
|
266 |
+
$message = sprintf( __( 'ERROR: Request is invalid. Check the error code in JSON. Status code is %1$s', 'post-smtp' ), $error_code );
|
267 |
+
break;
|
268 |
+
case 401:
|
269 |
+
$message = sprintf( __( 'ERROR: You have not been authenticated. Make sure the provided api-key is correct. Status code is %1$s', 'post-smtp' ), $error_code );
|
270 |
+
break;
|
271 |
+
case 402:
|
272 |
+
$message = sprintf( __( 'ERROR: Make sure you\'re account is activated and that you\'ve sufficient credits. Status code is %1$s', 'post-smtp' ), $error_code );
|
273 |
+
break;
|
274 |
+
case 403:
|
275 |
+
$message = sprintf( __( 'ERROR: You do not have the rights to access the resource. Status code is %1$s', 'post-smtp' ), $error_code );
|
276 |
+
break;
|
277 |
+
case 404:
|
278 |
+
$message = sprintf( __( 'ERROR: Make sure your calling an existing endpoint and that the parameters (object id etc.) in the path are correct. Status code is %1$s', 'post-smtp' ), $error_code );
|
279 |
+
break;
|
280 |
+
case 405:
|
281 |
+
$message = sprintf( __( 'ERROR: The verb you\'re using is not allowed for this endpoint. Make sure you\'re using the correct method (GET, POST, PUT, DELETE). Status code is %1$s', 'post-smtp' ), $error_code );
|
282 |
+
break;
|
283 |
+
case 406:
|
284 |
+
$message = sprintf( __( 'ERROR: The value of contentType for PUT or POST request in request headers is not application/json. Make sure the value is application/json only and not empty. Status code is %1$s', 'post-smtp' ), $error_code );
|
285 |
+
break;
|
286 |
+
case 429:
|
287 |
+
$message = sprintf( __( 'ERROR: The expected rate limit is exceeded. Status code is %1$s', 'post-smtp' ), $error_code );
|
288 |
+
break;
|
289 |
+
default:
|
290 |
+
$message = sprintf( __( 'ERROR: Status code is %1$s', 'post-smtp' ), $error_code );
|
291 |
+
}
|
292 |
+
|
293 |
+
return $message;
|
294 |
+
}
|
295 |
+
|
296 |
+
}
|
297 |
+
endif;
|
Postman/Postman-Mail/PostmanSendinblueTransport.php
ADDED
@@ -0,0 +1,276 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
if ( ! defined( 'ABSPATH' ) ) {
|
3 |
+
exit;
|
4 |
+
}
|
5 |
+
|
6 |
+
require_once 'PostmanModuleTransport.php';
|
7 |
+
|
8 |
+
/**
|
9 |
+
* Postman Sendinblue
|
10 |
+
* @since 2.1
|
11 |
+
* @version 1.0
|
12 |
+
*/
|
13 |
+
if( !class_exists( 'PostmanSendinblueTransport' ) ):
|
14 |
+
class PostmanSendinblueTransport extends PostmanAbstractModuleTransport implements PostmanModuleTransport {
|
15 |
+
|
16 |
+
const SLUG = 'sendinblue_api';
|
17 |
+
const PORT = 587;
|
18 |
+
const HOST = 'smtp-relay.sendinblue.com';
|
19 |
+
const PRIORITY = 8000;
|
20 |
+
const SENDINBLUE_AUTH_OPTIONS = 'postman_sendinblue_auth_options';
|
21 |
+
const SENDINBLUE_AUTH_SECTION = 'postman_sendinblue_auth_section';
|
22 |
+
|
23 |
+
/**
|
24 |
+
* PostmanSendinblueTransport constructor.
|
25 |
+
* @param $rootPluginFilenameAndPath
|
26 |
+
* @since 2.1
|
27 |
+
* @version 1.0
|
28 |
+
*/
|
29 |
+
public function __construct( $rootPluginFilenameAndPath ) {
|
30 |
+
|
31 |
+
parent::__construct ( $rootPluginFilenameAndPath );
|
32 |
+
|
33 |
+
// add a hook on the plugins_loaded event
|
34 |
+
add_action ( 'admin_init', array ( $this, 'on_admin_init' ) );
|
35 |
+
|
36 |
+
}
|
37 |
+
|
38 |
+
/**
|
39 |
+
* @return int
|
40 |
+
* @since 2.1
|
41 |
+
* @version 1.0
|
42 |
+
*/
|
43 |
+
public function getPort() {
|
44 |
+
return self::PORT;
|
45 |
+
}
|
46 |
+
|
47 |
+
/**
|
48 |
+
* @return string
|
49 |
+
* @since 2.1
|
50 |
+
* @version 1.0
|
51 |
+
*/
|
52 |
+
public function getSlug() {
|
53 |
+
return self::SLUG;
|
54 |
+
}
|
55 |
+
|
56 |
+
/**
|
57 |
+
* @return string
|
58 |
+
* @since 2.1
|
59 |
+
* @version 1.0
|
60 |
+
*/
|
61 |
+
public function getProtocol() {
|
62 |
+
return 'https';
|
63 |
+
}
|
64 |
+
|
65 |
+
/**
|
66 |
+
* @return string
|
67 |
+
* @since 2.1
|
68 |
+
* @version 1.0
|
69 |
+
*/
|
70 |
+
public function getHostname() {
|
71 |
+
return self::HOST;
|
72 |
+
}
|
73 |
+
|
74 |
+
/**
|
75 |
+
* @since 2.1
|
76 |
+
* @version 1.0
|
77 |
+
*/
|
78 |
+
public function getConfigurationBid( PostmanWizardSocket $hostData, $userAuthOverride, $originalSmtpServer ) {
|
79 |
+
|
80 |
+
$recommendation = array();
|
81 |
+
$recommendation ['priority'] = 0;
|
82 |
+
$recommendation ['transport'] = self::SLUG;
|
83 |
+
$recommendation ['hostname'] = null; // scribe looks this
|
84 |
+
$recommendation ['label'] = $this->getName();
|
85 |
+
$recommendation['logo_url'] = $this->getLogoURL();
|
86 |
+
|
87 |
+
if ($hostData->hostname == self::HOST && $hostData->port == self::PORT) {
|
88 |
+
$recommendation ['priority'] = self::PRIORITY;
|
89 |
+
/* translators: where variables are (1) transport name (2) host and (3) port */
|
90 |
+
$recommendation ['message'] = sprintf ( __ ( ('Postman recommends the %1$s to host %2$s on port %3$d.') ), $this->getName(), self::HOST, self::PORT );
|
91 |
+
}
|
92 |
+
|
93 |
+
return $recommendation;
|
94 |
+
|
95 |
+
}
|
96 |
+
|
97 |
+
/**
|
98 |
+
* @since 2.1
|
99 |
+
* @version 1.0
|
100 |
+
*/
|
101 |
+
public function createMailEngine() {
|
102 |
+
|
103 |
+
$api_key = $this->options->getSendinblueApiKey();
|
104 |
+
require_once 'PostmanSendinblueMailEngine.php';
|
105 |
+
$engine = new PostmanSendinblueMailEngine( $api_key );
|
106 |
+
|
107 |
+
return $engine;
|
108 |
+
|
109 |
+
}
|
110 |
+
|
111 |
+
/**
|
112 |
+
* @since 2.1
|
113 |
+
* @version 1.0
|
114 |
+
*/
|
115 |
+
public function getName() {
|
116 |
+
|
117 |
+
return __( 'Sendinblue', 'post-smtp' );
|
118 |
+
|
119 |
+
}
|
120 |
+
|
121 |
+
/**
|
122 |
+
* @since 2.1
|
123 |
+
* @version 1.0
|
124 |
+
*/
|
125 |
+
public function getDeliveryDetails() {
|
126 |
+
|
127 |
+
|
128 |
+
|
129 |
+
}
|
130 |
+
|
131 |
+
/**
|
132 |
+
* @param PostmanWizardSocket $socket
|
133 |
+
* @param $winningRecommendation
|
134 |
+
* @param $userSocketOverride
|
135 |
+
* @param $userAuthOverride
|
136 |
+
* @return array
|
137 |
+
* @since 2.1
|
138 |
+
* @version 1.0
|
139 |
+
*/
|
140 |
+
public function createOverrideMenu( PostmanWizardSocket $socket, $winningRecommendation, $userSocketOverride, $userAuthOverride ) {
|
141 |
+
|
142 |
+
$overrideItem = parent::createOverrideMenu ( $socket, $winningRecommendation, $userSocketOverride, $userAuthOverride );
|
143 |
+
|
144 |
+
// push the authentication options into the $overrideItem structure
|
145 |
+
$overrideItem ['auth_items'] = array (
|
146 |
+
array (
|
147 |
+
'selected' => true,
|
148 |
+
'name' => __ ( 'API Key', 'post-smtp' ),
|
149 |
+
'value' => 'api_key'
|
150 |
+
)
|
151 |
+
);
|
152 |
+
|
153 |
+
return $overrideItem;
|
154 |
+
|
155 |
+
}
|
156 |
+
|
157 |
+
/**
|
158 |
+
* @since 2.1
|
159 |
+
* @version 1.0
|
160 |
+
*/
|
161 |
+
public function on_admin_init() {
|
162 |
+
|
163 |
+
if( PostmanUtils::isAdmin() ) {
|
164 |
+
|
165 |
+
$this->addSettings();
|
166 |
+
$this->registerStylesAndScripts();
|
167 |
+
|
168 |
+
}
|
169 |
+
|
170 |
+
}
|
171 |
+
|
172 |
+
/**
|
173 |
+
* @since 2.1
|
174 |
+
* @version 1.0
|
175 |
+
*/
|
176 |
+
public function addSettings()
|
177 |
+
{
|
178 |
+
|
179 |
+
add_settings_section(
|
180 |
+
self::SENDINBLUE_AUTH_SECTION,
|
181 |
+
__('Authentication', 'post-smtp'),
|
182 |
+
array( $this, 'printSendinblueAuthSectionInfo' ),
|
183 |
+
self::SENDINBLUE_AUTH_OPTIONS
|
184 |
+
);
|
185 |
+
|
186 |
+
add_settings_field(
|
187 |
+
PostmanOptions::SENDINBLUE_API_KEY,
|
188 |
+
__( 'API Key', 'post-smtp' ),
|
189 |
+
array( $this, 'sendinblue_api_key_callback' ),
|
190 |
+
self::SENDINBLUE_AUTH_OPTIONS,
|
191 |
+
self::SENDINBLUE_AUTH_SECTION
|
192 |
+
);
|
193 |
+
|
194 |
+
}
|
195 |
+
|
196 |
+
/**
|
197 |
+
* @since 2.1
|
198 |
+
* @version 1.0
|
199 |
+
*/
|
200 |
+
public function printSendinblueAuthSectionInfo() {
|
201 |
+
|
202 |
+
printf (
|
203 |
+
'<p id="wizard_sendinblue_auth_help">%s</p>', sprintf ( __ ( 'Create an account at <a href="%1$s" target="_blank">%2$s</a> and enter <a href="%3$s" target="_blank">an API key</a> below.', 'post-smtp' ),
|
204 |
+
'https://www.sendinblue.com/', 'sendinblue.com', 'https://account.sendinblue.com/advanced/api' )
|
205 |
+
);
|
206 |
+
|
207 |
+
}
|
208 |
+
|
209 |
+
/**
|
210 |
+
* @since 2.1
|
211 |
+
* @version 1.0
|
212 |
+
*/
|
213 |
+
public function sendinblue_api_key_callback() {
|
214 |
+
|
215 |
+
printf ( '<input type="password" autocomplete="off" id="sendinblue_api_key" name="postman_options[sendinblue_api_key]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getSendinblueApiKey() ? esc_attr ( PostmanUtils::obfuscatePassword ( $this->options->getSendinblueApiKey() ) ) : '', __ ( 'Required', 'post-smtp' ) );
|
216 |
+
print ' <input type="button" id="toggleSendinblueApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
217 |
+
|
218 |
+
}
|
219 |
+
|
220 |
+
/**
|
221 |
+
* @since 2.1
|
222 |
+
* @version 1.0
|
223 |
+
*/
|
224 |
+
public function registerStylesAndScripts() {
|
225 |
+
|
226 |
+
$pluginData = apply_filters( 'postman_get_plugin_metadata', null );
|
227 |
+
|
228 |
+
wp_register_script (
|
229 |
+
'postman-sendinblue',
|
230 |
+
plugins_url ( 'Postman/Postman-Mail/postman-sendinblue.js', $this->rootPluginFilenameAndPath ),
|
231 |
+
array (
|
232 |
+
PostmanViewController::JQUERY_SCRIPT,
|
233 |
+
'jquery_validation',
|
234 |
+
PostmanViewController::POSTMAN_SCRIPT
|
235 |
+
),
|
236 |
+
$pluginData['version']
|
237 |
+
);
|
238 |
+
|
239 |
+
}
|
240 |
+
|
241 |
+
/**
|
242 |
+
* @since 2.1
|
243 |
+
* @version 1.0
|
244 |
+
*/
|
245 |
+
public function enqueueScript() {
|
246 |
+
|
247 |
+
wp_enqueue_script( 'postman-sendinblue' );
|
248 |
+
|
249 |
+
}
|
250 |
+
|
251 |
+
/**
|
252 |
+
* @since 2.1
|
253 |
+
* @version 1.0
|
254 |
+
*/
|
255 |
+
public function printWizardAuthenticationStep() {
|
256 |
+
print '<section class="wizard_sendinblue">';
|
257 |
+
$this->printSendinblueAuthSectionInfo();
|
258 |
+
printf ( '<label for="api_key">%s</label>', __ ( 'API Key', 'post-smtp' ) );
|
259 |
+
print '<br />';
|
260 |
+
print $this->sendinblue_api_key_callback();
|
261 |
+
print '</section>';
|
262 |
+
}
|
263 |
+
|
264 |
+
/**
|
265 |
+
* Get Socket's logo
|
266 |
+
*
|
267 |
+
* @since 2.1
|
268 |
+
* @version 1.0
|
269 |
+
*/
|
270 |
+
public function getLogoURL() {
|
271 |
+
|
272 |
+
return POST_SMTP_ASSETS . "images/logos/sendinblue.png";
|
273 |
+
|
274 |
+
}
|
275 |
+
}
|
276 |
+
endif;
|
Postman/Postman-Mail/PostmanSmtpModuleTransport.php
CHANGED
@@ -278,6 +278,7 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
278 |
$recommendation ['port'] = $port;
|
279 |
$recommendation ['hostname'] = $hostname;
|
280 |
$recommendation ['transport'] = self::SLUG;
|
|
|
281 |
|
282 |
return $recommendation;
|
283 |
}
|
@@ -409,7 +410,7 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
409 |
* Get the settings option array and print one of its values
|
410 |
*/
|
411 |
public function hostname_callback() {
|
412 |
-
printf( '<input type="text" id="input_hostname" name="postman_options[hostname]" value="%s" size="40" class="required" placeholder="%s"/>', null !== $this->options->getHostname() ? esc_attr( $this->options->getHostname() ) : '', __( 'Required', 'post-smtp' ) );
|
413 |
}
|
414 |
|
415 |
/**
|
@@ -459,15 +460,15 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
459 |
$inputValue = (null !== $this->options->getUsername() ? esc_attr( $this->options->getUsername() ) : '');
|
460 |
$inputDescription = __( 'The Username is usually the same as the Envelope-From Email Address.', 'post-smtp' );
|
461 |
print ('<input tabindex="99" id="fake_user_name" name="fake_user[name]" style="position:absolute; top:-500px;" type="text" value="Safari Autofill Me">') ;
|
462 |
-
printf( '<input type="text" id="input_basic_auth_username" name="postman_options[basic_auth_username]" value="%s" size="40" class="required" placeholder="%s"/><br/><span class="postman_input_description">%s</span>', $inputValue, __( 'Required', 'post-smtp' ), $inputDescription );
|
463 |
}
|
464 |
|
465 |
/**
|
466 |
* Get the settings option array and print one of its values
|
467 |
*/
|
468 |
public function basic_auth_password_callback() {
|
469 |
-
print ('<input tabindex="99" id="fake_password" name="fake[password]" style="position:absolute; top:-500px;" type="password" value="Safari Autofill Me">') ;
|
470 |
-
printf( '<input type="password" id="input_basic_auth_password" name="postman_options[basic_auth_password]" value="%s" size="40" class="required" placeholder="%s"/>', null !== $this->options->getPassword() ? esc_attr( PostmanUtils::obfuscatePassword( $this->options->getPassword() ) ) : '', __( 'Required', 'post-smtp' ) );
|
471 |
print ' <input type="button" id="togglePasswordField" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
472 |
}
|
473 |
|
@@ -475,14 +476,14 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
475 |
* Get the settings option array and print one of its values
|
476 |
*/
|
477 |
public function oauth_client_id_callback() {
|
478 |
-
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" id="oauth_client_id" name="postman_options[oauth_client_id]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getClientId() ? esc_attr( $this->options->getClientId() ) : '', __( 'Required', 'post-smtp' ) );
|
479 |
}
|
480 |
|
481 |
/**
|
482 |
* Get the settings option array and print one of its values
|
483 |
*/
|
484 |
public function oauth_client_secret_callback() {
|
485 |
-
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" autocomplete="off" id="oauth_client_secret" name="postman_options[oauth_client_secret]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getClientSecret() ? esc_attr( $this->options->getClientSecret() ) : '', __( 'Required', 'post-smtp' ) );
|
486 |
}
|
487 |
|
488 |
/**
|
@@ -499,7 +500,7 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
499 |
* Get the settings option array and print one of its values
|
500 |
*/
|
501 |
public function callback_domain_callback() {
|
502 |
-
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" readonly="readonly" id="input_oauth_callback_domain" value="%s" size="60"/>', $this->getCallbackDomain() );
|
503 |
}
|
504 |
|
505 |
/**
|
@@ -522,7 +523,7 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
522 |
$this->options = $this->options;
|
523 |
$transport = $this;
|
524 |
$oauthScribe = $transport->getScribe();
|
525 |
-
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" readonly="readonly" id="input_oauth_redirect_url" value="%s" size="60"/>', $oauthScribe->getCallbackUrl() );
|
526 |
}
|
527 |
|
528 |
/**
|
@@ -541,7 +542,7 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
541 |
public function printWizardMailServerHostnameStep() {
|
542 |
printf( '<legend>%s</legend>', _x( 'Which host will relay the mail?', 'Wizard Step Title', 'post-smtp' ) );
|
543 |
printf( '<p>%s</p>', __( 'This is the Outgoing (SMTP) Mail Server, or Mail Submission Agent (MSA), which Postman delegates mail delivery to. This server is specific to your email account, and if you don\'t know what to use, ask your email service provider.', 'post-smtp' ) );
|
544 |
-
printf( '<p>%s
|
545 |
|
546 |
//printf( '<div><strong><u>%s</u></strong></div><br>', __( 'If you plan to use An API and not SMTP just type any value.', 'post-smtp' ) );
|
547 |
printf( '<label for="hostname">%s</label>', __( 'Outgoing Mail Server Hostname', 'post-smtp' ) );
|
@@ -591,4 +592,16 @@ class PostmanSmtpModuleTransport extends PostmanAbstractZendModuleTransport impl
|
|
591 |
print $this->basic_auth_password_callback();
|
592 |
print '</section>';
|
593 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
594 |
}
|
278 |
$recommendation ['port'] = $port;
|
279 |
$recommendation ['hostname'] = $hostname;
|
280 |
$recommendation ['transport'] = self::SLUG;
|
281 |
+
$recommendation['logo_url'] = $this->getLogoURL();
|
282 |
|
283 |
return $recommendation;
|
284 |
}
|
410 |
* Get the settings option array and print one of its values
|
411 |
*/
|
412 |
public function hostname_callback() {
|
413 |
+
printf( '<input type="text" id="input_hostname" name="postman_options[hostname]" class="ps-input" value="%s" size="40" class="required" placeholder="%s"/>', null !== $this->options->getHostname() ? esc_attr( $this->options->getHostname() ) : '', __( 'Required', 'post-smtp' ) );
|
414 |
}
|
415 |
|
416 |
/**
|
460 |
$inputValue = (null !== $this->options->getUsername() ? esc_attr( $this->options->getUsername() ) : '');
|
461 |
$inputDescription = __( 'The Username is usually the same as the Envelope-From Email Address.', 'post-smtp' );
|
462 |
print ('<input tabindex="99" id="fake_user_name" name="fake_user[name]" style="position:absolute; top:-500px;" type="text" value="Safari Autofill Me">') ;
|
463 |
+
printf( '<input type="text" id="input_basic_auth_username" name="postman_options[basic_auth_username]" value="%s" size="40" class="required ps-input ps-w-75" placeholder="%s"/><br/><span class="postman_input_description ps-input ps-w-75">%s</span>', $inputValue, __( 'Required', 'post-smtp' ), $inputDescription );
|
464 |
}
|
465 |
|
466 |
/**
|
467 |
* Get the settings option array and print one of its values
|
468 |
*/
|
469 |
public function basic_auth_password_callback() {
|
470 |
+
print ('<input tabindex="99" id="fake_password" name="fake[password]" style="position:absolute; top:-500px;" type="password" class="ps-input ps-w-75" value="Safari Autofill Me">') ;
|
471 |
+
printf( '<input type="password" id="input_basic_auth_password" name="postman_options[basic_auth_password]" value="%s" size="40" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getPassword() ? esc_attr( PostmanUtils::obfuscatePassword( $this->options->getPassword() ) ) : '', __( 'Required', 'post-smtp' ) );
|
472 |
print ' <input type="button" id="togglePasswordField" value="Show Password" class="button button-secondary" style="visibility:hidden" />';
|
473 |
}
|
474 |
|
476 |
* Get the settings option array and print one of its values
|
477 |
*/
|
478 |
public function oauth_client_id_callback() {
|
479 |
+
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" id="oauth_client_id" name="postman_options[oauth_client_id]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getClientId() ? esc_attr( $this->options->getClientId() ) : '', __( 'Required', 'post-smtp' ) );
|
480 |
}
|
481 |
|
482 |
/**
|
483 |
* Get the settings option array and print one of its values
|
484 |
*/
|
485 |
public function oauth_client_secret_callback() {
|
486 |
+
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" autocomplete="off" id="oauth_client_secret" name="postman_options[oauth_client_secret]" value="%s" size="60" class="required ps-input ps-w-75" placeholder="%s"/>', null !== $this->options->getClientSecret() ? esc_attr( $this->options->getClientSecret() ) : '', __( 'Required', 'post-smtp' ) );
|
487 |
}
|
488 |
|
489 |
/**
|
500 |
* Get the settings option array and print one of its values
|
501 |
*/
|
502 |
public function callback_domain_callback() {
|
503 |
+
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" readonly="readonly" class="ps-input ps-w-75" id="input_oauth_callback_domain" value="%s" size="60"/>', $this->getCallbackDomain() );
|
504 |
}
|
505 |
|
506 |
/**
|
523 |
$this->options = $this->options;
|
524 |
$transport = $this;
|
525 |
$oauthScribe = $transport->getScribe();
|
526 |
+
printf( '<input type="text" onClick="this.setSelectionRange(0, this.value.length)" readonly="readonly" id="input_oauth_redirect_url" class="ps-input ps-w-75" value="%s" size="60"/>', $oauthScribe->getCallbackUrl() );
|
527 |
}
|
528 |
|
529 |
/**
|
542 |
public function printWizardMailServerHostnameStep() {
|
543 |
printf( '<legend>%s</legend>', _x( 'Which host will relay the mail?', 'Wizard Step Title', 'post-smtp' ) );
|
544 |
printf( '<p>%s</p>', __( 'This is the Outgoing (SMTP) Mail Server, or Mail Submission Agent (MSA), which Postman delegates mail delivery to. This server is specific to your email account, and if you don\'t know what to use, ask your email service provider.', 'post-smtp' ) );
|
545 |
+
printf( '<p><label>%s<label></p>', __( 'Note that many WordPress hosts, such as GoDaddy, Bluehost and Dreamhost, require that you use their mail accounts with their mail servers, and prevent you from using others.', 'post-smtp' ) );
|
546 |
|
547 |
//printf( '<div><strong><u>%s</u></strong></div><br>', __( 'If you plan to use An API and not SMTP just type any value.', 'post-smtp' ) );
|
548 |
printf( '<label for="hostname">%s</label>', __( 'Outgoing Mail Server Hostname', 'post-smtp' ) );
|
592 |
print $this->basic_auth_password_callback();
|
593 |
print '</section>';
|
594 |
}
|
595 |
+
|
596 |
+
/**
|
597 |
+
* Get Socket's logo
|
598 |
+
*
|
599 |
+
* @since 2.1
|
600 |
+
* @version 1.0
|
601 |
+
*/
|
602 |
+
public function getLogoURL() {
|
603 |
+
|
604 |
+
return POST_SMTP_ASSETS . "images/logos/smtp.png";
|
605 |
+
|
606 |
+
}
|
607 |
}
|
Postman/Postman-Mail/postman-sendinblue.js
ADDED
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
jQuery( document ).ready( function(){
|
2 |
+
|
3 |
+
// enable toggling of the API field from password to plain text
|
4 |
+
enablePasswordDisplayOnEntry('sendinblue_api_key', 'toggleSendinblueApiKey');
|
5 |
+
|
6 |
+
// define the PostmanMandrill class
|
7 |
+
var PostmanSendGrid = function() {
|
8 |
+
|
9 |
+
}
|
10 |
+
|
11 |
+
// behavior for handling the user's transport change
|
12 |
+
PostmanSendGrid.prototype.handleTransportChange = function( transportName ) {
|
13 |
+
if ( transportName == 'sendinblue_api' ) {
|
14 |
+
hide( 'div.transport_setting' );
|
15 |
+
hide( 'div.authentication_setting' );
|
16 |
+
show( 'div#sendinblue_settings' );
|
17 |
+
}
|
18 |
+
}
|
19 |
+
|
20 |
+
// behavior for handling the wizard configuration from the
|
21 |
+
// server (after the port test)
|
22 |
+
PostmanSendGrid.prototype.handleConfigurationResponse = function( response ) {
|
23 |
+
var transportName = response.configuration.transport_type;
|
24 |
+
if ( transportName == 'sendinblue_api' ) {
|
25 |
+
show( 'section.wizard_sendinblue' );
|
26 |
+
} else {
|
27 |
+
hide( 'section.wizard_sendinblue' );
|
28 |
+
}
|
29 |
+
}
|
30 |
+
|
31 |
+
// add this class to the global transports
|
32 |
+
var transport = new PostmanSendGrid();
|
33 |
+
transports.push( transport );
|
34 |
+
|
35 |
+
// since we are initialize the screen, check if needs to be modded by this
|
36 |
+
// transport
|
37 |
+
var transportName = jQuery( 'select#input_transport_type' ).val();
|
38 |
+
transport.handleTransportChange( transportName );
|
39 |
+
|
40 |
+
} )
|
Postman/Postman-Mail/sendinblue/.travis.yml
ADDED
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
language: php
|
2 |
+
sudo: false
|
3 |
+
php:
|
4 |
+
- 5.6
|
5 |
+
- 7.0
|
6 |
+
before_install: "composer install"
|
7 |
+
script: "vendor/bin/phpunit"
|
Postman/Postman-Mail/sendinblue/LICENSE.md
ADDED
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
The MIT License (MIT)
|
2 |
+
|
3 |
+
Copyright (c) 2019 SendinBlue
|
4 |
+
|
5 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6 |
+
of this software and associated documentation files (the "Software"), to deal
|
7 |
+
in the Software without restriction, including without limitation the rights
|
8 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9 |
+
copies of the Software, and to permit persons to whom the Software is
|
10 |
+
furnished to do so, subject to the following conditions:
|
11 |
+
|
12 |
+
The above copyright notice and this permission notice shall be included in
|
13 |
+
all copies or substantial portions of the Software.
|
14 |
+
|
15 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21 |
+
THE SOFTWARE.
|
Postman/Postman-Mail/sendinblue/README.md
ADDED
@@ -0,0 +1,480 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue's API v3 Php Library
|
2 |
+
|
3 |
+
SendinBlue's API exposes the entire SendinBlue features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.sendinblue.com) to learn more.
|
4 |
+
|
5 |
+
This is the wrapper for the API. It implements all the features of the API v3.
|
6 |
+
|
7 |
+
SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.sendinblue.com/v3/swagger_definition.yml).
|
8 |
+
|
9 |
+
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue:
|
10 |
+
|
11 |
+
- API version: 3.0.0
|
12 |
+
- Build package: io.swagger.codegen.languages.PhpClientCodegen
|
13 |
+
For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support)
|
14 |
+
|
15 |
+
## Requirements
|
16 |
+
|
17 |
+
PHP 5.6 and later
|
18 |
+
|
19 |
+
## Installation & Usage
|
20 |
+
### Composer
|
21 |
+
|
22 |
+
To install the bindings via [Composer](http://getcomposer.org/):
|
23 |
+
|
24 |
+
```
|
25 |
+
composer require sendinblue/api-v3-sdk "8.x.x"
|
26 |
+
```
|
27 |
+
|
28 |
+
Further do:
|
29 |
+
* run ``composer install`` to get these dependencies added to your vendor directory
|
30 |
+
* add the autoloader to your application with this line: ``require("vendor/autoload.php")``
|
31 |
+
|
32 |
+
|
33 |
+
## Tests
|
34 |
+
|
35 |
+
To run the unit tests:
|
36 |
+
|
37 |
+
```
|
38 |
+
composer install
|
39 |
+
./vendor/bin/phpunit
|
40 |
+
```
|
41 |
+
|
42 |
+
## Getting Started
|
43 |
+
|
44 |
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
45 |
+
|
46 |
+
```php
|
47 |
+
<?php
|
48 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
49 |
+
|
50 |
+
// Configure API key authorization: api-key
|
51 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
52 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
53 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
54 |
+
// Configure API key authorization: partner-key
|
55 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
56 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
57 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
58 |
+
|
59 |
+
$apiInstance = new SendinBlue\Client\Api\AccountApi(
|
60 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
61 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
62 |
+
new GuzzleHttp\Client(),
|
63 |
+
$config
|
64 |
+
);
|
65 |
+
|
66 |
+
try {
|
67 |
+
$result = $apiInstance->getAccount();
|
68 |
+
print_r($result);
|
69 |
+
} catch (Exception $e) {
|
70 |
+
echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
|
71 |
+
}
|
72 |
+
|
73 |
+
?>
|
74 |
+
```
|
75 |
+
|
76 |
+
## Documentation for API Endpoints
|
77 |
+
|
78 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
79 |
+
|
80 |
+
Class | Method | HTTP request | Description
|
81 |
+
------------ | ------------- | ------------- | -------------
|
82 |
+
*AccountApi* | [**getAccount**](docs/Api/AccountApi.md#getaccount) | **GET** /account | Get your account information, plan and credits details
|
83 |
+
*AttributesApi* | [**createAttribute**](docs/Api/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
84 |
+
*AttributesApi* | [**deleteAttribute**](docs/Api/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
85 |
+
*AttributesApi* | [**getAttributes**](docs/Api/AttributesApi.md#getattributes) | **GET** /contacts/attributes | List all attributes
|
86 |
+
*AttributesApi* | [**updateAttribute**](docs/Api/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
87 |
+
*CRMApi* | [**crmFilesIdDataGet**](docs/Api/CRMApi.md#crmfilesiddataget) | **GET** /crm/files/{id}/data | Get file details
|
88 |
+
*CRMApi* | [**crmFilesIdDelete**](docs/Api/CRMApi.md#crmfilesiddelete) | **DELETE** /crm/files/{id} | Delete a file
|
89 |
+
*CRMApi* | [**crmFilesIdGet**](docs/Api/CRMApi.md#crmfilesidget) | **GET** /crm/files/{id} | Download a file
|
90 |
+
*CRMApi* | [**crmFilesPost**](docs/Api/CRMApi.md#crmfilespost) | **POST** /crm/files | Upload a file
|
91 |
+
*CRMApi* | [**crmNotesIdDelete**](docs/Api/CRMApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note
|
92 |
+
*CRMApi* | [**crmNotesIdGet**](docs/Api/CRMApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note
|
93 |
+
*CRMApi* | [**crmNotesIdPatch**](docs/Api/CRMApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note
|
94 |
+
*CRMApi* | [**crmNotesPost**](docs/Api/CRMApi.md#crmnotespost) | **POST** /crm/notes | Create a note
|
95 |
+
*CRMApi* | [**crmTasksIdDelete**](docs/Api/CRMApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task
|
96 |
+
*CRMApi* | [**crmTasksIdGet**](docs/Api/CRMApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task
|
97 |
+
*CRMApi* | [**crmTasksIdPatch**](docs/Api/CRMApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task
|
98 |
+
*CRMApi* | [**crmTasksPost**](docs/Api/CRMApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task
|
99 |
+
*CRMApi* | [**crmTasktypesGet**](docs/Api/CRMApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types
|
100 |
+
*ContactsApi* | [**addContactToList**](docs/Api/ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
101 |
+
*ContactsApi* | [**createAttribute**](docs/Api/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
102 |
+
*ContactsApi* | [**createContact**](docs/Api/ContactsApi.md#createcontact) | **POST** /contacts | Create a contact
|
103 |
+
*ContactsApi* | [**createDoiContact**](docs/Api/ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
|
104 |
+
*ContactsApi* | [**createFolder**](docs/Api/ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder
|
105 |
+
*ContactsApi* | [**createList**](docs/Api/ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list
|
106 |
+
*ContactsApi* | [**deleteAttribute**](docs/Api/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
107 |
+
*ContactsApi* | [**deleteContact**](docs/Api/ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | Delete a contact
|
108 |
+
*ContactsApi* | [**deleteFolder**](docs/Api/ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
109 |
+
*ContactsApi* | [**deleteList**](docs/Api/ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
|
110 |
+
*ContactsApi* | [**getAttributes**](docs/Api/ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes
|
111 |
+
*ContactsApi* | [**getContactInfo**](docs/Api/ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details
|
112 |
+
*ContactsApi* | [**getContactStats**](docs/Api/ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
|
113 |
+
*ContactsApi* | [**getContacts**](docs/Api/ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts
|
114 |
+
*ContactsApi* | [**getContactsFromList**](docs/Api/ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
115 |
+
*ContactsApi* | [**getFolder**](docs/Api/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
116 |
+
*ContactsApi* | [**getFolderLists**](docs/Api/ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
117 |
+
*ContactsApi* | [**getFolders**](docs/Api/ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all folders
|
118 |
+
*ContactsApi* | [**getList**](docs/Api/ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details
|
119 |
+
*ContactsApi* | [**getLists**](docs/Api/ContactsApi.md#getlists) | **GET** /contacts/lists | Get all the lists
|
120 |
+
*ContactsApi* | [**importContacts**](docs/Api/ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts
|
121 |
+
*ContactsApi* | [**removeContactFromList**](docs/Api/ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
122 |
+
*ContactsApi* | [**requestContactExport**](docs/Api/ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts
|
123 |
+
*ContactsApi* | [**updateAttribute**](docs/Api/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
124 |
+
*ContactsApi* | [**updateBatchContacts**](docs/Api/ContactsApi.md#updatebatchcontacts) | **POST** /contacts/batch | Update multiple contacts
|
125 |
+
*ContactsApi* | [**updateContact**](docs/Api/ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | Update a contact
|
126 |
+
*ContactsApi* | [**updateFolder**](docs/Api/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
127 |
+
*ContactsApi* | [**updateList**](docs/Api/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
|
128 |
+
*EmailCampaignsApi* | [**createEmailCampaign**](docs/Api/EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign
|
129 |
+
*EmailCampaignsApi* | [**deleteEmailCampaign**](docs/Api/EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
130 |
+
*EmailCampaignsApi* | [**emailExportRecipients**](docs/Api/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
131 |
+
*EmailCampaignsApi* | [**getAbTestCampaignResult**](docs/Api/EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
132 |
+
*EmailCampaignsApi* | [**getEmailCampaign**](docs/Api/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
133 |
+
*EmailCampaignsApi* | [**getEmailCampaigns**](docs/Api/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
134 |
+
*EmailCampaignsApi* | [**getSharedTemplateUrl**](docs/Api/EmailCampaignsApi.md#getsharedtemplateurl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
135 |
+
*EmailCampaignsApi* | [**sendEmailCampaignNow**](docs/Api/EmailCampaignsApi.md#sendemailcampaignnow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
136 |
+
*EmailCampaignsApi* | [**sendReport**](docs/Api/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
137 |
+
*EmailCampaignsApi* | [**sendTestEmail**](docs/Api/EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
138 |
+
*EmailCampaignsApi* | [**updateCampaignStatus**](docs/Api/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
139 |
+
*EmailCampaignsApi* | [**updateEmailCampaign**](docs/Api/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
140 |
+
*EmailCampaignsApi* | [**uploadImageToGallery**](docs/Api/EmailCampaignsApi.md#uploadimagetogallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
141 |
+
*FoldersApi* | [**createFolder**](docs/Api/FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder
|
142 |
+
*FoldersApi* | [**deleteFolder**](docs/Api/FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
143 |
+
*FoldersApi* | [**getFolder**](docs/Api/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
144 |
+
*FoldersApi* | [**getFolderLists**](docs/Api/FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
145 |
+
*FoldersApi* | [**getFolders**](docs/Api/FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all folders
|
146 |
+
*FoldersApi* | [**updateFolder**](docs/Api/FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
147 |
+
*InboundParsingApi* | [**getInboundEmailEvents**](docs/Api/InboundParsingApi.md#getinboundemailevents) | **GET** /inbound/events | Get the list of all the events for the received emails.
|
148 |
+
*InboundParsingApi* | [**getInboundEmailEventsByUuid**](docs/Api/InboundParsingApi.md#getinboundemaileventsbyuuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
|
149 |
+
*ListsApi* | [**addContactToList**](docs/Api/ListsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
150 |
+
*ListsApi* | [**createList**](docs/Api/ListsApi.md#createlist) | **POST** /contacts/lists | Create a list
|
151 |
+
*ListsApi* | [**deleteList**](docs/Api/ListsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
|
152 |
+
*ListsApi* | [**getContactsFromList**](docs/Api/ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
153 |
+
*ListsApi* | [**getFolderLists**](docs/Api/ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
154 |
+
*ListsApi* | [**getList**](docs/Api/ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details
|
155 |
+
*ListsApi* | [**getLists**](docs/Api/ListsApi.md#getlists) | **GET** /contacts/lists | Get all the lists
|
156 |
+
*ListsApi* | [**removeContactFromList**](docs/Api/ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
157 |
+
*ListsApi* | [**updateList**](docs/Api/ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
|
158 |
+
*MasterAccountApi* | [**corporateMasterAccountGet**](docs/Api/MasterAccountApi.md#corporatemasteraccountget) | **GET** /corporate/masterAccount | Get the details of requested master account
|
159 |
+
*MasterAccountApi* | [**corporateSubAccountGet**](docs/Api/MasterAccountApi.md#corporatesubaccountget) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
|
160 |
+
*MasterAccountApi* | [**corporateSubAccountIdDelete**](docs/Api/MasterAccountApi.md#corporatesubaccountiddelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
|
161 |
+
*MasterAccountApi* | [**corporateSubAccountIdGet**](docs/Api/MasterAccountApi.md#corporatesubaccountidget) | **GET** /corporate/subAccount/{id} | Get sub-account details
|
162 |
+
*MasterAccountApi* | [**corporateSubAccountIdPlanPut**](docs/Api/MasterAccountApi.md#corporatesubaccountidplanput) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
163 |
+
*MasterAccountApi* | [**corporateSubAccountPost**](docs/Api/MasterAccountApi.md#corporatesubaccountpost) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
164 |
+
*MasterAccountApi* | [**corporateSubAccountSsoTokenPost**](docs/Api/MasterAccountApi.md#corporatesubaccountssotokenpost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Sendinblue
|
165 |
+
*ProcessApi* | [**getProcess**](docs/Api/ProcessApi.md#getprocess) | **GET** /processes/{processId} | Return the informations for a process
|
166 |
+
*ProcessApi* | [**getProcesses**](docs/Api/ProcessApi.md#getprocesses) | **GET** /processes | Return all the processes for your account
|
167 |
+
*ResellerApi* | [**addCredits**](docs/Api/ResellerApi.md#addcredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
168 |
+
*ResellerApi* | [**associateIpToChild**](docs/Api/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
|
169 |
+
*ResellerApi* | [**createChildDomain**](docs/Api/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
|
170 |
+
*ResellerApi* | [**createResellerChild**](docs/Api/ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child
|
171 |
+
*ResellerApi* | [**deleteChildDomain**](docs/Api/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
172 |
+
*ResellerApi* | [**deleteResellerChild**](docs/Api/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
|
173 |
+
*ResellerApi* | [**dissociateIpFromChild**](docs/Api/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
|
174 |
+
*ResellerApi* | [**getChildAccountCreationStatus**](docs/Api/ResellerApi.md#getchildaccountcreationstatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
175 |
+
*ResellerApi* | [**getChildDomains**](docs/Api/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
|
176 |
+
*ResellerApi* | [**getChildInfo**](docs/Api/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
|
177 |
+
*ResellerApi* | [**getResellerChilds**](docs/Api/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Get the list of all children accounts
|
178 |
+
*ResellerApi* | [**getSsoToken**](docs/Api/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO)
|
179 |
+
*ResellerApi* | [**removeCredits**](docs/Api/ResellerApi.md#removecredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
180 |
+
*ResellerApi* | [**updateChildAccountStatus**](docs/Api/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
|
181 |
+
*ResellerApi* | [**updateChildDomain**](docs/Api/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
182 |
+
*ResellerApi* | [**updateResellerChild**](docs/Api/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
|
183 |
+
*SMSCampaignsApi* | [**createSmsCampaign**](docs/Api/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
184 |
+
*SMSCampaignsApi* | [**deleteSmsCampaign**](docs/Api/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
185 |
+
*SMSCampaignsApi* | [**getSmsCampaign**](docs/Api/SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
186 |
+
*SMSCampaignsApi* | [**getSmsCampaigns**](docs/Api/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
187 |
+
*SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/Api/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
188 |
+
*SMSCampaignsApi* | [**sendSmsCampaignNow**](docs/Api/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
189 |
+
*SMSCampaignsApi* | [**sendSmsReport**](docs/Api/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
190 |
+
*SMSCampaignsApi* | [**sendTestSms**](docs/Api/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
191 |
+
*SMSCampaignsApi* | [**updateSmsCampaign**](docs/Api/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
192 |
+
*SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
|
193 |
+
*SendersApi* | [**createSender**](docs/Api/SendersApi.md#createsender) | **POST** /senders | Create a new sender
|
194 |
+
*SendersApi* | [**deleteSender**](docs/Api/SendersApi.md#deletesender) | **DELETE** /senders/{senderId} | Delete a sender
|
195 |
+
*SendersApi* | [**getIps**](docs/Api/SendersApi.md#getips) | **GET** /senders/ips | Get all the dedicated IPs for your account
|
196 |
+
*SendersApi* | [**getIpsFromSender**](docs/Api/SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
197 |
+
*SendersApi* | [**getSenders**](docs/Api/SendersApi.md#getsenders) | **GET** /senders | Get the list of all your senders
|
198 |
+
*SendersApi* | [**updateSender**](docs/Api/SendersApi.md#updatesender) | **PUT** /senders/{senderId} | Update a sender
|
199 |
+
*TransactionalEmailsApi* | [**blockNewDomain**](docs/Api/TransactionalEmailsApi.md#blocknewdomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
200 |
+
*TransactionalEmailsApi* | [**createSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template
|
201 |
+
*TransactionalEmailsApi* | [**deleteBlockedDomain**](docs/Api/TransactionalEmailsApi.md#deleteblockeddomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
202 |
+
*TransactionalEmailsApi* | [**deleteHardbounces**](docs/Api/TransactionalEmailsApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
203 |
+
*TransactionalEmailsApi* | [**deleteSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
204 |
+
*TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/Api/TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
205 |
+
*TransactionalEmailsApi* | [**getBlockedDomains**](docs/Api/TransactionalEmailsApi.md#getblockeddomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
206 |
+
*TransactionalEmailsApi* | [**getEmailEventReport**](docs/Api/TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
207 |
+
*TransactionalEmailsApi* | [**getScheduledEmailByBatchId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbybatchid) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
|
208 |
+
*TransactionalEmailsApi* | [**getScheduledEmailById**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbyid) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
|
209 |
+
*TransactionalEmailsApi* | [**getScheduledEmailByMessageId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbymessageid) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
|
210 |
+
*TransactionalEmailsApi* | [**getSmtpReport**](docs/Api/TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
211 |
+
*TransactionalEmailsApi* | [**getSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
|
212 |
+
*TransactionalEmailsApi* | [**getSmtpTemplates**](docs/Api/TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates
|
213 |
+
*TransactionalEmailsApi* | [**getTransacBlockedContacts**](docs/Api/TransactionalEmailsApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
214 |
+
*TransactionalEmailsApi* | [**getTransacEmailContent**](docs/Api/TransactionalEmailsApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
215 |
+
*TransactionalEmailsApi* | [**getTransacEmailsList**](docs/Api/TransactionalEmailsApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
216 |
+
*TransactionalEmailsApi* | [**sendTestTemplate**](docs/Api/TransactionalEmailsApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
217 |
+
*TransactionalEmailsApi* | [**sendTransacEmail**](docs/Api/TransactionalEmailsApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email
|
218 |
+
*TransactionalEmailsApi* | [**smtpBlockedContactsEmailDelete**](docs/Api/TransactionalEmailsApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
219 |
+
*TransactionalEmailsApi* | [**smtpLogMessageIdDelete**](docs/Api/TransactionalEmailsApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
220 |
+
*TransactionalEmailsApi* | [**updateSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template
|
221 |
+
*TransactionalSMSApi* | [**getSmsEvents**](docs/Api/TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
222 |
+
*TransactionalSMSApi* | [**getTransacAggregatedSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacaggregatedsmsreport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
223 |
+
*TransactionalSMSApi* | [**getTransacSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacsmsreport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
224 |
+
*TransactionalSMSApi* | [**sendTransacSms**](docs/Api/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
225 |
+
*WebhooksApi* | [**createWebhook**](docs/Api/WebhooksApi.md#createwebhook) | **POST** /webhooks | Create a webhook
|
226 |
+
*WebhooksApi* | [**deleteWebhook**](docs/Api/WebhooksApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
227 |
+
*WebhooksApi* | [**getWebhook**](docs/Api/WebhooksApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
228 |
+
*WebhooksApi* | [**getWebhooks**](docs/Api/WebhooksApi.md#getwebhooks) | **GET** /webhooks | Get all webhooks
|
229 |
+
*WebhooksApi* | [**updateWebhook**](docs/Api/WebhooksApi.md#updatewebhook) | **PUT** /webhooks/{webhookId} | Update a webhook
|
230 |
+
|
231 |
+
|
232 |
+
## Documentation For Models
|
233 |
+
|
234 |
+
- [AbTestCampaignResult](docs/Model/AbTestCampaignResult.md)
|
235 |
+
- [AbTestCampaignResultClickedLinks](docs/Model/AbTestCampaignResultClickedLinks.md)
|
236 |
+
- [AbTestCampaignResultStatistics](docs/Model/AbTestCampaignResultStatistics.md)
|
237 |
+
- [AbTestVersionClicks](docs/Model/AbTestVersionClicks.md)
|
238 |
+
- [AbTestVersionClicksInner](docs/Model/AbTestVersionClicksInner.md)
|
239 |
+
- [AbTestVersionStats](docs/Model/AbTestVersionStats.md)
|
240 |
+
- [AddChildDomain](docs/Model/AddChildDomain.md)
|
241 |
+
- [AddContactToList](docs/Model/AddContactToList.md)
|
242 |
+
- [AddCredits](docs/Model/AddCredits.md)
|
243 |
+
- [BlockDomain](docs/Model/BlockDomain.md)
|
244 |
+
- [Body](docs/Model/Body.md)
|
245 |
+
- [Body1](docs/Model/Body1.md)
|
246 |
+
- [Contact](docs/Model/Contact.md)
|
247 |
+
- [CreateAttribute](docs/Model/CreateAttribute.md)
|
248 |
+
- [CreateAttributeEnumeration](docs/Model/CreateAttributeEnumeration.md)
|
249 |
+
- [CreateChild](docs/Model/CreateChild.md)
|
250 |
+
- [CreateContact](docs/Model/CreateContact.md)
|
251 |
+
- [CreateDoiContact](docs/Model/CreateDoiContact.md)
|
252 |
+
- [CreateEmailCampaign](docs/Model/CreateEmailCampaign.md)
|
253 |
+
- [CreateEmailCampaignRecipients](docs/Model/CreateEmailCampaignRecipients.md)
|
254 |
+
- [CreateEmailCampaignSender](docs/Model/CreateEmailCampaignSender.md)
|
255 |
+
- [CreateList](docs/Model/CreateList.md)
|
256 |
+
- [CreateModel](docs/Model/CreateModel.md)
|
257 |
+
- [CreateReseller](docs/Model/CreateReseller.md)
|
258 |
+
- [CreateSender](docs/Model/CreateSender.md)
|
259 |
+
- [CreateSenderIps](docs/Model/CreateSenderIps.md)
|
260 |
+
- [CreateSenderModel](docs/Model/CreateSenderModel.md)
|
261 |
+
- [CreateSmsCampaign](docs/Model/CreateSmsCampaign.md)
|
262 |
+
- [CreateSmsCampaignRecipients](docs/Model/CreateSmsCampaignRecipients.md)
|
263 |
+
- [CreateSmtpEmail](docs/Model/CreateSmtpEmail.md)
|
264 |
+
- [CreateSmtpTemplate](docs/Model/CreateSmtpTemplate.md)
|
265 |
+
- [CreateSmtpTemplateSender](docs/Model/CreateSmtpTemplateSender.md)
|
266 |
+
- [CreateSubAccount](docs/Model/CreateSubAccount.md)
|
267 |
+
- [CreateSubAccountResponse](docs/Model/CreateSubAccountResponse.md)
|
268 |
+
- [CreateUpdateContactModel](docs/Model/CreateUpdateContactModel.md)
|
269 |
+
- [CreateUpdateFolder](docs/Model/CreateUpdateFolder.md)
|
270 |
+
- [CreateWebhook](docs/Model/CreateWebhook.md)
|
271 |
+
- [CreatedProcessId](docs/Model/CreatedProcessId.md)
|
272 |
+
- [DeleteHardbounces](docs/Model/DeleteHardbounces.md)
|
273 |
+
- [EmailExportRecipients](docs/Model/EmailExportRecipients.md)
|
274 |
+
- [ErrorModel](docs/Model/ErrorModel.md)
|
275 |
+
- [FileData](docs/Model/FileData.md)
|
276 |
+
- [GetAccountMarketingAutomation](docs/Model/GetAccountMarketingAutomation.md)
|
277 |
+
- [GetAccountPlan](docs/Model/GetAccountPlan.md)
|
278 |
+
- [GetAccountRelay](docs/Model/GetAccountRelay.md)
|
279 |
+
- [GetAccountRelayData](docs/Model/GetAccountRelayData.md)
|
280 |
+
- [GetAggregatedReport](docs/Model/GetAggregatedReport.md)
|
281 |
+
- [GetAttributes](docs/Model/GetAttributes.md)
|
282 |
+
- [GetAttributesAttributes](docs/Model/GetAttributesAttributes.md)
|
283 |
+
- [GetAttributesEnumeration](docs/Model/GetAttributesEnumeration.md)
|
284 |
+
- [GetBlockedDomains](docs/Model/GetBlockedDomains.md)
|
285 |
+
- [GetCampaignOverview](docs/Model/GetCampaignOverview.md)
|
286 |
+
- [GetCampaignRecipients](docs/Model/GetCampaignRecipients.md)
|
287 |
+
- [GetCampaignStats](docs/Model/GetCampaignStats.md)
|
288 |
+
- [GetChildAccountCreationStatus](docs/Model/GetChildAccountCreationStatus.md)
|
289 |
+
- [GetChildDomain](docs/Model/GetChildDomain.md)
|
290 |
+
- [GetChildDomains](docs/Model/GetChildDomains.md)
|
291 |
+
- [GetChildInfoApiKeys](docs/Model/GetChildInfoApiKeys.md)
|
292 |
+
- [GetChildInfoApiKeysV2](docs/Model/GetChildInfoApiKeysV2.md)
|
293 |
+
- [GetChildInfoApiKeysV3](docs/Model/GetChildInfoApiKeysV3.md)
|
294 |
+
- [GetChildInfoCredits](docs/Model/GetChildInfoCredits.md)
|
295 |
+
- [GetChildInfoStatistics](docs/Model/GetChildInfoStatistics.md)
|
296 |
+
- [GetChildrenList](docs/Model/GetChildrenList.md)
|
297 |
+
- [GetClient](docs/Model/GetClient.md)
|
298 |
+
- [GetContactCampaignStats](docs/Model/GetContactCampaignStats.md)
|
299 |
+
- [GetContactCampaignStatsClicked](docs/Model/GetContactCampaignStatsClicked.md)
|
300 |
+
- [GetContactCampaignStatsOpened](docs/Model/GetContactCampaignStatsOpened.md)
|
301 |
+
- [GetContactCampaignStatsTransacAttributes](docs/Model/GetContactCampaignStatsTransacAttributes.md)
|
302 |
+
- [GetContactCampaignStatsUnsubscriptions](docs/Model/GetContactCampaignStatsUnsubscriptions.md)
|
303 |
+
- [GetContactDetails](docs/Model/GetContactDetails.md)
|
304 |
+
- [GetContacts](docs/Model/GetContacts.md)
|
305 |
+
- [GetDeviceBrowserStats](docs/Model/GetDeviceBrowserStats.md)
|
306 |
+
- [GetEmailCampaigns](docs/Model/GetEmailCampaigns.md)
|
307 |
+
- [GetEmailEventReport](docs/Model/GetEmailEventReport.md)
|
308 |
+
- [GetEmailEventReportEvents](docs/Model/GetEmailEventReportEvents.md)
|
309 |
+
- [GetExtendedCampaignOverviewSender](docs/Model/GetExtendedCampaignOverviewSender.md)
|
310 |
+
- [GetExtendedCampaignStats](docs/Model/GetExtendedCampaignStats.md)
|
311 |
+
- [GetExtendedClientAddress](docs/Model/GetExtendedClientAddress.md)
|
312 |
+
- [GetExtendedContactDetailsStatistics](docs/Model/GetExtendedContactDetailsStatistics.md)
|
313 |
+
- [GetExtendedContactDetailsStatisticsClicked](docs/Model/GetExtendedContactDetailsStatisticsClicked.md)
|
314 |
+
- [GetExtendedContactDetailsStatisticsDelivered](docs/Model/GetExtendedContactDetailsStatisticsDelivered.md)
|
315 |
+
- [GetExtendedContactDetailsStatisticsLinks](docs/Model/GetExtendedContactDetailsStatisticsLinks.md)
|
316 |
+
- [GetExtendedContactDetailsStatisticsMessagesSent](docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md)
|
317 |
+
- [GetExtendedContactDetailsStatisticsOpened](docs/Model/GetExtendedContactDetailsStatisticsOpened.md)
|
318 |
+
- [GetExtendedContactDetailsStatisticsUnsubscriptions](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
|
319 |
+
- [GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
|
320 |
+
- [GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
|
321 |
+
- [GetExtendedListCampaignStats](docs/Model/GetExtendedListCampaignStats.md)
|
322 |
+
- [GetFolder](docs/Model/GetFolder.md)
|
323 |
+
- [GetFolderLists](docs/Model/GetFolderLists.md)
|
324 |
+
- [GetFolders](docs/Model/GetFolders.md)
|
325 |
+
- [GetInboundEmailEvents](docs/Model/GetInboundEmailEvents.md)
|
326 |
+
- [GetInboundEmailEventsByUuid](docs/Model/GetInboundEmailEventsByUuid.md)
|
327 |
+
- [GetInboundEmailEventsByUuidAttachments](docs/Model/GetInboundEmailEventsByUuidAttachments.md)
|
328 |
+
- [GetInboundEmailEventsByUuidLogs](docs/Model/GetInboundEmailEventsByUuidLogs.md)
|
329 |
+
- [GetInboundEmailEventsEvents](docs/Model/GetInboundEmailEventsEvents.md)
|
330 |
+
- [GetIp](docs/Model/GetIp.md)
|
331 |
+
- [GetIpFromSender](docs/Model/GetIpFromSender.md)
|
332 |
+
- [GetIps](docs/Model/GetIps.md)
|
333 |
+
- [GetIpsFromSender](docs/Model/GetIpsFromSender.md)
|
334 |
+
- [GetList](docs/Model/GetList.md)
|
335 |
+
- [GetLists](docs/Model/GetLists.md)
|
336 |
+
- [GetProcess](docs/Model/GetProcess.md)
|
337 |
+
- [GetProcesses](docs/Model/GetProcesses.md)
|
338 |
+
- [GetReports](docs/Model/GetReports.md)
|
339 |
+
- [GetReportsReports](docs/Model/GetReportsReports.md)
|
340 |
+
- [GetScheduledEmailByBatchId](docs/Model/GetScheduledEmailByBatchId.md)
|
341 |
+
- [GetScheduledEmailByBatchIdBatches](docs/Model/GetScheduledEmailByBatchIdBatches.md)
|
342 |
+
- [GetScheduledEmailByMessageId](docs/Model/GetScheduledEmailByMessageId.md)
|
343 |
+
- [GetSendersList](docs/Model/GetSendersList.md)
|
344 |
+
- [GetSendersListIps](docs/Model/GetSendersListIps.md)
|
345 |
+
- [GetSendersListSenders](docs/Model/GetSendersListSenders.md)
|
346 |
+
- [GetSharedTemplateUrl](docs/Model/GetSharedTemplateUrl.md)
|
347 |
+
- [GetSmsCampaignOverview](docs/Model/GetSmsCampaignOverview.md)
|
348 |
+
- [GetSmsCampaignStats](docs/Model/GetSmsCampaignStats.md)
|
349 |
+
- [GetSmsCampaigns](docs/Model/GetSmsCampaigns.md)
|
350 |
+
- [GetSmsEventReport](docs/Model/GetSmsEventReport.md)
|
351 |
+
- [GetSmsEventReportEvents](docs/Model/GetSmsEventReportEvents.md)
|
352 |
+
- [GetSmtpTemplateOverview](docs/Model/GetSmtpTemplateOverview.md)
|
353 |
+
- [GetSmtpTemplateOverviewSender](docs/Model/GetSmtpTemplateOverviewSender.md)
|
354 |
+
- [GetSmtpTemplates](docs/Model/GetSmtpTemplates.md)
|
355 |
+
- [GetSsoToken](docs/Model/GetSsoToken.md)
|
356 |
+
- [GetStatsByBrowser](docs/Model/GetStatsByBrowser.md)
|
357 |
+
- [GetStatsByDevice](docs/Model/GetStatsByDevice.md)
|
358 |
+
- [GetStatsByDomain](docs/Model/GetStatsByDomain.md)
|
359 |
+
- [GetTransacAggregatedSmsReport](docs/Model/GetTransacAggregatedSmsReport.md)
|
360 |
+
- [GetTransacBlockedContacts](docs/Model/GetTransacBlockedContacts.md)
|
361 |
+
- [GetTransacBlockedContactsContacts](docs/Model/GetTransacBlockedContactsContacts.md)
|
362 |
+
- [GetTransacBlockedContactsReason](docs/Model/GetTransacBlockedContactsReason.md)
|
363 |
+
- [GetTransacEmailContent](docs/Model/GetTransacEmailContent.md)
|
364 |
+
- [GetTransacEmailContentEvents](docs/Model/GetTransacEmailContentEvents.md)
|
365 |
+
- [GetTransacEmailsList](docs/Model/GetTransacEmailsList.md)
|
366 |
+
- [GetTransacEmailsListTransactionalEmails](docs/Model/GetTransacEmailsListTransactionalEmails.md)
|
367 |
+
- [GetTransacSmsReport](docs/Model/GetTransacSmsReport.md)
|
368 |
+
- [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md)
|
369 |
+
- [GetWebhook](docs/Model/GetWebhook.md)
|
370 |
+
- [GetWebhooks](docs/Model/GetWebhooks.md)
|
371 |
+
- [InlineResponse201](docs/Model/InlineResponse201.md)
|
372 |
+
- [ManageIp](docs/Model/ManageIp.md)
|
373 |
+
- [MasterDetailsResponse](docs/Model/MasterDetailsResponse.md)
|
374 |
+
- [MasterDetailsResponseBillingInfo](docs/Model/MasterDetailsResponseBillingInfo.md)
|
375 |
+
- [MasterDetailsResponseBillingInfoAddress](docs/Model/MasterDetailsResponseBillingInfoAddress.md)
|
376 |
+
- [MasterDetailsResponseBillingInfoName](docs/Model/MasterDetailsResponseBillingInfoName.md)
|
377 |
+
- [MasterDetailsResponsePlanInfo](docs/Model/MasterDetailsResponsePlanInfo.md)
|
378 |
+
- [MasterDetailsResponsePlanInfoFeatures](docs/Model/MasterDetailsResponsePlanInfoFeatures.md)
|
379 |
+
- [Note](docs/Model/Note.md)
|
380 |
+
- [NoteData](docs/Model/NoteData.md)
|
381 |
+
- [PostContactInfo](docs/Model/PostContactInfo.md)
|
382 |
+
- [PostContactInfoContacts](docs/Model/PostContactInfoContacts.md)
|
383 |
+
- [PostSendFailed](docs/Model/PostSendFailed.md)
|
384 |
+
- [PostSendSmsTestFailed](docs/Model/PostSendSmsTestFailed.md)
|
385 |
+
- [RemainingCreditModel](docs/Model/RemainingCreditModel.md)
|
386 |
+
- [RemainingCreditModelChild](docs/Model/RemainingCreditModelChild.md)
|
387 |
+
- [RemainingCreditModelReseller](docs/Model/RemainingCreditModelReseller.md)
|
388 |
+
- [RemoveContactFromList](docs/Model/RemoveContactFromList.md)
|
389 |
+
- [RemoveCredits](docs/Model/RemoveCredits.md)
|
390 |
+
- [RequestContactExport](docs/Model/RequestContactExport.md)
|
391 |
+
- [RequestContactExportCustomContactFilter](docs/Model/RequestContactExportCustomContactFilter.md)
|
392 |
+
- [RequestContactImport](docs/Model/RequestContactImport.md)
|
393 |
+
- [RequestContactImportNewList](docs/Model/RequestContactImportNewList.md)
|
394 |
+
- [RequestSmsRecipientExport](docs/Model/RequestSmsRecipientExport.md)
|
395 |
+
- [SendReport](docs/Model/SendReport.md)
|
396 |
+
- [SendReportEmail](docs/Model/SendReportEmail.md)
|
397 |
+
- [SendSms](docs/Model/SendSms.md)
|
398 |
+
- [SendSmtpEmail](docs/Model/SendSmtpEmail.md)
|
399 |
+
- [SendSmtpEmailAttachment](docs/Model/SendSmtpEmailAttachment.md)
|
400 |
+
- [SendSmtpEmailBcc](docs/Model/SendSmtpEmailBcc.md)
|
401 |
+
- [SendSmtpEmailCc](docs/Model/SendSmtpEmailCc.md)
|
402 |
+
- [SendSmtpEmailMessageVersions](docs/Model/SendSmtpEmailMessageVersions.md)
|
403 |
+
- [SendSmtpEmailReplyTo](docs/Model/SendSmtpEmailReplyTo.md)
|
404 |
+
- [SendSmtpEmailReplyTo1](docs/Model/SendSmtpEmailReplyTo1.md)
|
405 |
+
- [SendSmtpEmailSender](docs/Model/SendSmtpEmailSender.md)
|
406 |
+
- [SendSmtpEmailTo](docs/Model/SendSmtpEmailTo.md)
|
407 |
+
- [SendSmtpEmailTo1](docs/Model/SendSmtpEmailTo1.md)
|
408 |
+
- [SendTestEmail](docs/Model/SendTestEmail.md)
|
409 |
+
- [SendTestSms](docs/Model/SendTestSms.md)
|
410 |
+
- [SendTransacSms](docs/Model/SendTransacSms.md)
|
411 |
+
- [SsoTokenRequest](docs/Model/SsoTokenRequest.md)
|
412 |
+
- [SubAccountDetailsResponse](docs/Model/SubAccountDetailsResponse.md)
|
413 |
+
- [SubAccountDetailsResponsePlanInfo](docs/Model/SubAccountDetailsResponsePlanInfo.md)
|
414 |
+
- [SubAccountDetailsResponsePlanInfoCredits](docs/Model/SubAccountDetailsResponsePlanInfoCredits.md)
|
415 |
+
- [SubAccountDetailsResponsePlanInfoCreditsEmails](docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md)
|
416 |
+
- [SubAccountDetailsResponsePlanInfoFeatures](docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md)
|
417 |
+
- [SubAccountDetailsResponsePlanInfoFeaturesInbox](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md)
|
418 |
+
- [SubAccountDetailsResponsePlanInfoFeaturesLandingPage](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md)
|
419 |
+
- [SubAccountDetailsResponsePlanInfoFeaturesUsers](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md)
|
420 |
+
- [SubAccountUpdatePlanRequest](docs/Model/SubAccountUpdatePlanRequest.md)
|
421 |
+
- [SubAccountUpdatePlanRequestCredits](docs/Model/SubAccountUpdatePlanRequestCredits.md)
|
422 |
+
- [SubAccountUpdatePlanRequestFeatures](docs/Model/SubAccountUpdatePlanRequestFeatures.md)
|
423 |
+
- [SubAccountsResponse](docs/Model/SubAccountsResponse.md)
|
424 |
+
- [SubAccountsResponseSubAccounts](docs/Model/SubAccountsResponseSubAccounts.md)
|
425 |
+
- [Task](docs/Model/Task.md)
|
426 |
+
- [TaskReminder](docs/Model/TaskReminder.md)
|
427 |
+
- [TaskTypes](docs/Model/TaskTypes.md)
|
428 |
+
- [UpdateAttribute](docs/Model/UpdateAttribute.md)
|
429 |
+
- [UpdateAttributeEnumeration](docs/Model/UpdateAttributeEnumeration.md)
|
430 |
+
- [UpdateBatchContacts](docs/Model/UpdateBatchContacts.md)
|
431 |
+
- [UpdateBatchContactsContacts](docs/Model/UpdateBatchContactsContacts.md)
|
432 |
+
- [UpdateBatchContactsModel](docs/Model/UpdateBatchContactsModel.md)
|
433 |
+
- [UpdateCampaignStatus](docs/Model/UpdateCampaignStatus.md)
|
434 |
+
- [UpdateChild](docs/Model/UpdateChild.md)
|
435 |
+
- [UpdateChildAccountStatus](docs/Model/UpdateChildAccountStatus.md)
|
436 |
+
- [UpdateChildDomain](docs/Model/UpdateChildDomain.md)
|
437 |
+
- [UpdateContact](docs/Model/UpdateContact.md)
|
438 |
+
- [UpdateEmailCampaign](docs/Model/UpdateEmailCampaign.md)
|
439 |
+
- [UpdateEmailCampaignRecipients](docs/Model/UpdateEmailCampaignRecipients.md)
|
440 |
+
- [UpdateEmailCampaignSender](docs/Model/UpdateEmailCampaignSender.md)
|
441 |
+
- [UpdateList](docs/Model/UpdateList.md)
|
442 |
+
- [UpdateSender](docs/Model/UpdateSender.md)
|
443 |
+
- [UpdateSmsCampaign](docs/Model/UpdateSmsCampaign.md)
|
444 |
+
- [UpdateSmtpTemplate](docs/Model/UpdateSmtpTemplate.md)
|
445 |
+
- [UpdateSmtpTemplateSender](docs/Model/UpdateSmtpTemplateSender.md)
|
446 |
+
- [UpdateWebhook](docs/Model/UpdateWebhook.md)
|
447 |
+
- [UploadImageToGallery](docs/Model/UploadImageToGallery.md)
|
448 |
+
- [GetChildInfo](docs/Model/GetChildInfo.md)
|
449 |
+
- [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md)
|
450 |
+
- [GetExtendedClient](docs/Model/GetExtendedClient.md)
|
451 |
+
- [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md)
|
452 |
+
- [GetExtendedList](docs/Model/GetExtendedList.md)
|
453 |
+
- [GetSmsCampaign](docs/Model/GetSmsCampaign.md)
|
454 |
+
- [GetAccount](docs/Model/GetAccount.md)
|
455 |
+
- [GetEmailCampaign](docs/Model/GetEmailCampaign.md)
|
456 |
+
|
457 |
+
|
458 |
+
## Documentation For Authorization
|
459 |
+
|
460 |
+
|
461 |
+
## api-key
|
462 |
+
|
463 |
+
The API key should be passed in the request headers as `api-key` for authentication.
|
464 |
+
|
465 |
+
- **Type**: API key
|
466 |
+
- **API key parameter name**: api-key
|
467 |
+
- **Location**: HTTP header
|
468 |
+
|
469 |
+
## partner-key
|
470 |
+
|
471 |
+
The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).
|
472 |
+
|
473 |
+
- **Type**: API key
|
474 |
+
- **API key parameter name**: partner-key
|
475 |
+
- **Location**: HTTP header
|
476 |
+
|
477 |
+
|
478 |
+
If you find a bug, please post the issue on [Github](https://github.com/sendinblue/APIv3-php-library/issues).
|
479 |
+
|
480 |
+
As always, if you need additional assistance, drop us a note [here](https://account.sendinblue.com/support).
|
Postman/Postman-Mail/sendinblue/composer.json
ADDED
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
{
|
2 |
+
"name": "sendinblue/api-v3-sdk",
|
3 |
+
"description": "Official SendinBlue provided RESTFul API V3 php library",
|
4 |
+
"keywords": [
|
5 |
+
"sendinblue",
|
6 |
+
"swagger",
|
7 |
+
"php",
|
8 |
+
"sdk",
|
9 |
+
"api"
|
10 |
+
],
|
11 |
+
"homepage": "https://github.com/sendinblue/APIv3-php-library",
|
12 |
+
"license": "MIT",
|
13 |
+
"authors": [
|
14 |
+
{
|
15 |
+
"name": "SendinBlue Developers",
|
16 |
+
"email": "contact@sendinblue.com",
|
17 |
+
"homepage": "https://www.sendinblue.com/"
|
18 |
+
}
|
19 |
+
],
|
20 |
+
"require": {
|
21 |
+
"php": ">=5.6",
|
22 |
+
"ext-curl": "*",
|
23 |
+
"ext-json": "*",
|
24 |
+
"ext-mbstring": "*",
|
25 |
+
"guzzlehttp/guzzle": "^7.4.0"
|
26 |
+
},
|
27 |
+
"require-dev": {
|
28 |
+
"phpunit/phpunit": "^4.8",
|
29 |
+
"squizlabs/php_codesniffer": "~2.6",
|
30 |
+
"friendsofphp/php-cs-fixer": "~1.12"
|
31 |
+
},
|
32 |
+
"autoload": {
|
33 |
+
"psr-4": { "SendinBlue\\Client\\" : "lib/" }
|
34 |
+
},
|
35 |
+
"autoload-dev": {
|
36 |
+
"psr-4": { "SendinBlue\\Client\\" : "test/" }
|
37 |
+
},
|
38 |
+
"extra": {
|
39 |
+
"branch-alias": {
|
40 |
+
"dev-master": "8.x.x-dev"
|
41 |
+
}
|
42 |
+
}
|
43 |
+
}
|
Postman/Postman-Mail/sendinblue/composer.lock
ADDED
@@ -0,0 +1,2107 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
{
|
2 |
+
"_readme": [
|
3 |
+
"This file locks the dependencies of your project to a known state",
|
4 |
+
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
5 |
+
"This file is @generated automatically"
|
6 |
+
],
|
7 |
+
"content-hash": "fc3a3187a6ed0508923186df909358ff",
|
8 |
+
"packages": [
|
9 |
+
{
|
10 |
+
"name": "guzzlehttp/guzzle",
|
11 |
+
"version": "6.3.3",
|
12 |
+
"source": {
|
13 |
+
"type": "git",
|
14 |
+
"url": "https://github.com/guzzle/guzzle.git",
|
15 |
+
"reference": "407b0cb880ace85c9b63c5f9551db498cb2d50ba"
|
16 |
+
},
|
17 |
+
"dist": {
|
18 |
+
"type": "zip",
|
19 |
+
"url": "https://api.github.com/repos/guzzle/guzzle/zipball/407b0cb880ace85c9b63c5f9551db498cb2d50ba",
|
20 |
+
"reference": "407b0cb880ace85c9b63c5f9551db498cb2d50ba",
|
21 |
+
"shasum": ""
|
22 |
+
},
|
23 |
+
"require": {
|
24 |
+
"guzzlehttp/promises": "^1.0",
|
25 |
+
"guzzlehttp/psr7": "^1.4",
|
26 |
+
"php": ">=5.5"
|
27 |
+
},
|
28 |
+
"require-dev": {
|
29 |
+
"ext-curl": "*",
|
30 |
+
"phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.4 || ^7.0",
|
31 |
+
"psr/log": "^1.0"
|
32 |
+
},
|
33 |
+
"suggest": {
|
34 |
+
"psr/log": "Required for using the Log middleware"
|
35 |
+
},
|
36 |
+
"type": "library",
|
37 |
+
"extra": {
|
38 |
+
"branch-alias": {
|
39 |
+
"dev-master": "6.3-dev"
|
40 |
+
}
|
41 |
+
},
|
42 |
+
"autoload": {
|
43 |
+
"files": [
|
44 |
+
"src/functions_include.php"
|
45 |
+
],
|
46 |
+
"psr-4": {
|
47 |
+
"GuzzleHttp\\": "src/"
|
48 |
+
}
|
49 |
+
},
|
50 |
+
"notification-url": "https://packagist.org/downloads/",
|
51 |
+
"license": [
|
52 |
+
"MIT"
|
53 |
+
],
|
54 |
+
"authors": [
|
55 |
+
{
|
56 |
+
"name": "Michael Dowling",
|
57 |
+
"email": "mtdowling@gmail.com",
|
58 |
+
"homepage": "https://github.com/mtdowling"
|
59 |
+
}
|
60 |
+
],
|
61 |
+
"description": "Guzzle is a PHP HTTP client library",
|
62 |
+
"homepage": "http://guzzlephp.org/",
|
63 |
+
"keywords": [
|
64 |
+
"client",
|
65 |
+
"curl",
|
66 |
+
"framework",
|
67 |
+
"http",
|
68 |
+
"http client",
|
69 |
+
"rest",
|
70 |
+
"web service"
|
71 |
+
],
|
72 |
+
"time": "2018-04-22T15:46:56+00:00"
|
73 |
+
},
|
74 |
+
{
|
75 |
+
"name": "guzzlehttp/promises",
|
76 |
+
"version": "v1.3.1",
|
77 |
+
"source": {
|
78 |
+
"type": "git",
|
79 |
+
"url": "https://github.com/guzzle/promises.git",
|
80 |
+
"reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646"
|
81 |
+
},
|
82 |
+
"dist": {
|
83 |
+
"type": "zip",
|
84 |
+
"url": "https://api.github.com/repos/guzzle/promises/zipball/a59da6cf61d80060647ff4d3eb2c03a2bc694646",
|
85 |
+
"reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646",
|
86 |
+
"shasum": ""
|
87 |
+
},
|
88 |
+
"require": {
|
89 |
+
"php": ">=5.5.0"
|
90 |
+
},
|
91 |
+
"require-dev": {
|
92 |
+
"phpunit/phpunit": "^4.0"
|
93 |
+
},
|
94 |
+
"type": "library",
|
95 |
+
"extra": {
|
96 |
+
"branch-alias": {
|
97 |
+
"dev-master": "1.4-dev"
|
98 |
+
}
|
99 |
+
},
|
100 |
+
"autoload": {
|
101 |
+
"psr-4": {
|
102 |
+
"GuzzleHttp\\Promise\\": "src/"
|
103 |
+
},
|
104 |
+
"files": [
|
105 |
+
"src/functions_include.php"
|
106 |
+
]
|
107 |
+
},
|
108 |
+
"notification-url": "https://packagist.org/downloads/",
|
109 |
+
"license": [
|
110 |
+
"MIT"
|
111 |
+
],
|
112 |
+
"authors": [
|
113 |
+
{
|
114 |
+
"name": "Michael Dowling",
|
115 |
+
"email": "mtdowling@gmail.com",
|
116 |
+
"homepage": "https://github.com/mtdowling"
|
117 |
+
}
|
118 |
+
],
|
119 |
+
"description": "Guzzle promises library",
|
120 |
+
"keywords": [
|
121 |
+
"promise"
|
122 |
+
],
|
123 |
+
"time": "2016-12-20T10:07:11+00:00"
|
124 |
+
},
|
125 |
+
{
|
126 |
+
"name": "guzzlehttp/psr7",
|
127 |
+
"version": "1.5.2",
|
128 |
+
"source": {
|
129 |
+
"type": "git",
|
130 |
+
"url": "https://github.com/guzzle/psr7.git",
|
131 |
+
"reference": "9f83dded91781a01c63574e387eaa769be769115"
|
132 |
+
},
|
133 |
+
"dist": {
|
134 |
+
"type": "zip",
|
135 |
+
"url": "https://api.github.com/repos/guzzle/psr7/zipball/9f83dded91781a01c63574e387eaa769be769115",
|
136 |
+
"reference": "9f83dded91781a01c63574e387eaa769be769115",
|
137 |
+
"shasum": ""
|
138 |
+
},
|
139 |
+
"require": {
|
140 |
+
"php": ">=5.4.0",
|
141 |
+
"psr/http-message": "~1.0",
|
142 |
+
"ralouphie/getallheaders": "^2.0.5"
|
143 |
+
},
|
144 |
+
"provide": {
|
145 |
+
"psr/http-message-implementation": "1.0"
|
146 |
+
},
|
147 |
+
"require-dev": {
|
148 |
+
"phpunit/phpunit": "~4.8.36 || ^5.7.27 || ^6.5.8"
|
149 |
+
},
|
150 |
+
"type": "library",
|
151 |
+
"extra": {
|
152 |
+
"branch-alias": {
|
153 |
+
"dev-master": "1.5-dev"
|
154 |
+
}
|
155 |
+
},
|
156 |
+
"autoload": {
|
157 |
+
"psr-4": {
|
158 |
+
"GuzzleHttp\\Psr7\\": "src/"
|
159 |
+
},
|
160 |
+
"files": [
|
161 |
+
"src/functions_include.php"
|
162 |
+
]
|
163 |
+
},
|
164 |
+
"notification-url": "https://packagist.org/downloads/",
|
165 |
+
"license": [
|
166 |
+
"MIT"
|
167 |
+
],
|
168 |
+
"authors": [
|
169 |
+
{
|
170 |
+
"name": "Michael Dowling",
|
171 |
+
"email": "mtdowling@gmail.com",
|
172 |
+
"homepage": "https://github.com/mtdowling"
|
173 |
+
},
|
174 |
+
{
|
175 |
+
"name": "Tobias Schultze",
|
176 |
+
"homepage": "https://github.com/Tobion"
|
177 |
+
}
|
178 |
+
],
|
179 |
+
"description": "PSR-7 message implementation that also provides common utility methods",
|
180 |
+
"keywords": [
|
181 |
+
"http",
|
182 |
+
"message",
|
183 |
+
"psr-7",
|
184 |
+
"request",
|
185 |
+
"response",
|
186 |
+
"stream",
|
187 |
+
"uri",
|
188 |
+
"url"
|
189 |
+
],
|
190 |
+
"time": "2018-12-04T20:46:45+00:00"
|
191 |
+
},
|
192 |
+
{
|
193 |
+
"name": "psr/http-message",
|
194 |
+
"version": "1.0.1",
|
195 |
+
"source": {
|
196 |
+
"type": "git",
|
197 |
+
"url": "https://github.com/php-fig/http-message.git",
|
198 |
+
"reference": "f6561bf28d520154e4b0ec72be95418abe6d9363"
|
199 |
+
},
|
200 |
+
"dist": {
|
201 |
+
"type": "zip",
|
202 |
+
"url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363",
|
203 |
+
"reference": "f6561bf28d520154e4b0ec72be95418abe6d9363",
|
204 |
+
"shasum": ""
|
205 |
+
},
|
206 |
+
"require": {
|
207 |
+
"php": ">=5.3.0"
|
208 |
+
},
|
209 |
+
"type": "library",
|
210 |
+
"extra": {
|
211 |
+
"branch-alias": {
|
212 |
+
"dev-master": "1.0.x-dev"
|
213 |
+
}
|
214 |
+
},
|
215 |
+
"autoload": {
|
216 |
+
"psr-4": {
|
217 |
+
"Psr\\Http\\Message\\": "src/"
|
218 |
+
}
|
219 |
+
},
|
220 |
+
"notification-url": "https://packagist.org/downloads/",
|
221 |
+
"license": [
|
222 |
+
"MIT"
|
223 |
+
],
|
224 |
+
"authors": [
|
225 |
+
{
|
226 |
+
"name": "PHP-FIG",
|
227 |
+
"homepage": "http://www.php-fig.org/"
|
228 |
+
}
|
229 |
+
],
|
230 |
+
"description": "Common interface for HTTP messages",
|
231 |
+
"homepage": "https://github.com/php-fig/http-message",
|
232 |
+
"keywords": [
|
233 |
+
"http",
|
234 |
+
"http-message",
|
235 |
+
"psr",
|
236 |
+
"psr-7",
|
237 |
+
"request",
|
238 |
+
"response"
|
239 |
+
],
|
240 |
+
"time": "2016-08-06T14:39:51+00:00"
|
241 |
+
},
|
242 |
+
{
|
243 |
+
"name": "ralouphie/getallheaders",
|
244 |
+
"version": "2.0.5",
|
245 |
+
"source": {
|
246 |
+
"type": "git",
|
247 |
+
"url": "https://github.com/ralouphie/getallheaders.git",
|
248 |
+
"reference": "5601c8a83fbba7ef674a7369456d12f1e0d0eafa"
|
249 |
+
},
|
250 |
+
"dist": {
|
251 |
+
"type": "zip",
|
252 |
+
"url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/5601c8a83fbba7ef674a7369456d12f1e0d0eafa",
|
253 |
+
"reference": "5601c8a83fbba7ef674a7369456d12f1e0d0eafa",
|
254 |
+
"shasum": ""
|
255 |
+
},
|
256 |
+
"require": {
|
257 |
+
"php": ">=5.3"
|
258 |
+
},
|
259 |
+
"require-dev": {
|
260 |
+
"phpunit/phpunit": "~3.7.0",
|
261 |
+
"satooshi/php-coveralls": ">=1.0"
|
262 |
+
},
|
263 |
+
"type": "library",
|
264 |
+
"autoload": {
|
265 |
+
"files": [
|
266 |
+
"src/getallheaders.php"
|
267 |
+
]
|
268 |
+
},
|
269 |
+
"notification-url": "https://packagist.org/downloads/",
|
270 |
+
"license": [
|
271 |
+
"MIT"
|
272 |
+
],
|
273 |
+
"authors": [
|
274 |
+
{
|
275 |
+
"name": "Ralph Khattar",
|
276 |
+
"email": "ralph.khattar@gmail.com"
|
277 |
+
}
|
278 |
+
],
|
279 |
+
"description": "A polyfill for getallheaders.",
|
280 |
+
"time": "2016-02-11T07:05:27+00:00"
|
281 |
+
}
|
282 |
+
],
|
283 |
+
"packages-dev": [
|
284 |
+
{
|
285 |
+
"name": "doctrine/instantiator",
|
286 |
+
"version": "1.0.5",
|
287 |
+
"source": {
|
288 |
+
"type": "git",
|
289 |
+
"url": "https://github.com/doctrine/instantiator.git",
|
290 |
+
"reference": "8e884e78f9f0eb1329e445619e04456e64d8051d"
|
291 |
+
},
|
292 |
+
"dist": {
|
293 |
+
"type": "zip",
|
294 |
+
"url": "https://api.github.com/repos/doctrine/instantiator/zipball/8e884e78f9f0eb1329e445619e04456e64d8051d",
|
295 |
+
"reference": "8e884e78f9f0eb1329e445619e04456e64d8051d",
|
296 |
+
"shasum": ""
|
297 |
+
},
|
298 |
+
"require": {
|
299 |
+
"php": ">=5.3,<8.0-DEV"
|
300 |
+
},
|
301 |
+
"require-dev": {
|
302 |
+
"athletic/athletic": "~0.1.8",
|
303 |
+
"ext-pdo": "*",
|
304 |
+
"ext-phar": "*",
|
305 |
+
"phpunit/phpunit": "~4.0",
|
306 |
+
"squizlabs/php_codesniffer": "~2.0"
|
307 |
+
},
|
308 |
+
"type": "library",
|
309 |
+
"extra": {
|
310 |
+
"branch-alias": {
|
311 |
+
"dev-master": "1.0.x-dev"
|
312 |
+
}
|
313 |
+
},
|
314 |
+
"autoload": {
|
315 |
+
"psr-4": {
|
316 |
+
"Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/"
|
317 |
+
}
|
318 |
+
},
|
319 |
+
"notification-url": "https://packagist.org/downloads/",
|
320 |
+
"license": [
|
321 |
+
"MIT"
|
322 |
+
],
|
323 |
+
"authors": [
|
324 |
+
{
|
325 |
+
"name": "Marco Pivetta",
|
326 |
+
"email": "ocramius@gmail.com",
|
327 |
+
"homepage": "http://ocramius.github.com/"
|
328 |
+
}
|
329 |
+
],
|
330 |
+
"description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors",
|
331 |
+
"homepage": "https://github.com/doctrine/instantiator",
|
332 |
+
"keywords": [
|
333 |
+
"constructor",
|
334 |
+
"instantiate"
|
335 |
+
],
|
336 |
+
"time": "2015-06-14T21:17:01+00:00"
|
337 |
+
},
|
338 |
+
{
|
339 |
+
"name": "friendsofphp/php-cs-fixer",
|
340 |
+
"version": "v1.13.3",
|
341 |
+
"source": {
|
342 |
+
"type": "git",
|
343 |
+
"url": "https://github.com/FriendsOfPHP/PHP-CS-Fixer.git",
|
344 |
+
"reference": "387e4c86c9dc0e1e4c475291fc114ec45b98e624"
|
345 |
+
},
|
346 |
+
"dist": {
|
347 |
+
"type": "zip",
|
348 |
+
"url": "https://api.github.com/repos/FriendsOfPHP/PHP-CS-Fixer/zipball/387e4c86c9dc0e1e4c475291fc114ec45b98e624",
|
349 |
+
"reference": "387e4c86c9dc0e1e4c475291fc114ec45b98e624",
|
350 |
+
"shasum": ""
|
351 |
+
},
|
352 |
+
"require": {
|
353 |
+
"ext-tokenizer": "*",
|
354 |
+
"php": "^5.3.6 || >=7.0 <7.2",
|
355 |
+
"sebastian/diff": "^1.1",
|
356 |
+
"symfony/console": "^2.3 || ^3.0",
|
357 |
+
"symfony/event-dispatcher": "^2.1 || ^3.0",
|
358 |
+
"symfony/filesystem": "^2.1 || ^3.0",
|
359 |
+
"symfony/finder": "^2.1 || ^3.0",
|
360 |
+
"symfony/process": "^2.3 || ^3.0",
|
361 |
+
"symfony/stopwatch": "^2.5 || ^3.0"
|
362 |
+
},
|
363 |
+
"conflict": {
|
364 |
+
"hhvm": "<3.9"
|
365 |
+
},
|
366 |
+
"require-dev": {
|
367 |
+
"phpunit/phpunit": "^4.5|^5",
|
368 |
+
"satooshi/php-coveralls": "^1.0"
|
369 |
+
},
|
370 |
+
"bin": [
|
371 |
+
"php-cs-fixer"
|
372 |
+
],
|
373 |
+
"type": "application",
|
374 |
+
"autoload": {
|
375 |
+
"psr-4": {
|
376 |
+
"Symfony\\CS\\": "Symfony/CS/"
|
377 |
+
}
|
378 |
+
},
|
379 |
+
"notification-url": "https://packagist.org/downloads/",
|
380 |
+
"license": [
|
381 |
+
"MIT"
|
382 |
+
],
|
383 |
+
"authors": [
|
384 |
+
{
|
385 |
+
"name": "Dariusz Rumiński",
|
386 |
+
"email": "dariusz.ruminski@gmail.com"
|
387 |
+
},
|
388 |
+
{
|
389 |
+
"name": "Fabien Potencier",
|
390 |
+
"email": "fabien@symfony.com"
|
391 |
+
}
|
392 |
+
],
|
393 |
+
"description": "A tool to automatically fix PHP code style",
|
394 |
+
"time": "2017-09-11T14:11:16+00:00"
|
395 |
+
},
|
396 |
+
{
|
397 |
+
"name": "phpdocumentor/reflection-common",
|
398 |
+
"version": "1.0.1",
|
399 |
+
"source": {
|
400 |
+
"type": "git",
|
401 |
+
"url": "https://github.com/phpDocumentor/ReflectionCommon.git",
|
402 |
+
"reference": "21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6"
|
403 |
+
},
|
404 |
+
"dist": {
|
405 |
+
"type": "zip",
|
406 |
+
"url": "https://api.github.com/repos/phpDocumentor/ReflectionCommon/zipball/21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6",
|
407 |
+
"reference": "21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6",
|
408 |
+
"shasum": ""
|
409 |
+
},
|
410 |
+
"require": {
|
411 |
+
"php": ">=5.5"
|
412 |
+
},
|
413 |
+
"require-dev": {
|
414 |
+
"phpunit/phpunit": "^4.6"
|
415 |
+
},
|
416 |
+
"type": "library",
|
417 |
+
"extra": {
|
418 |
+
"branch-alias": {
|
419 |
+
"dev-master": "1.0.x-dev"
|
420 |
+
}
|
421 |
+
},
|
422 |
+
"autoload": {
|
423 |
+
"psr-4": {
|
424 |
+
"phpDocumentor\\Reflection\\": [
|
425 |
+
"src"
|
426 |
+
]
|
427 |
+
}
|
428 |
+
},
|
429 |
+
"notification-url": "https://packagist.org/downloads/",
|
430 |
+
"license": [
|
431 |
+
"MIT"
|
432 |
+
],
|
433 |
+
"authors": [
|
434 |
+
{
|
435 |
+
"name": "Jaap van Otterdijk",
|
436 |
+
"email": "opensource@ijaap.nl"
|
437 |
+
}
|
438 |
+
],
|
439 |
+
"description": "Common reflection classes used by phpdocumentor to reflect the code structure",
|
440 |
+
"homepage": "http://www.phpdoc.org",
|
441 |
+
"keywords": [
|
442 |
+
"FQSEN",
|
443 |
+
"phpDocumentor",
|
444 |
+
"phpdoc",
|
445 |
+
"reflection",
|
446 |
+
"static analysis"
|
447 |
+
],
|
448 |
+
"time": "2017-09-11T18:02:19+00:00"
|
449 |
+
},
|
450 |
+
{
|
451 |
+
"name": "phpdocumentor/reflection-docblock",
|
452 |
+
"version": "3.3.2",
|
453 |
+
"source": {
|
454 |
+
"type": "git",
|
455 |
+
"url": "https://github.com/phpDocumentor/ReflectionDocBlock.git",
|
456 |
+
"reference": "bf329f6c1aadea3299f08ee804682b7c45b326a2"
|
457 |
+
},
|
458 |
+
"dist": {
|
459 |
+
"type": "zip",
|
460 |
+
"url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/bf329f6c1aadea3299f08ee804682b7c45b326a2",
|
461 |
+
"reference": "bf329f6c1aadea3299f08ee804682b7c45b326a2",
|
462 |
+
"shasum": ""
|
463 |
+
},
|
464 |
+
"require": {
|
465 |
+
"php": "^5.6 || ^7.0",
|
466 |
+
"phpdocumentor/reflection-common": "^1.0.0",
|
467 |
+
"phpdocumentor/type-resolver": "^0.4.0",
|
468 |
+
"webmozart/assert": "^1.0"
|
469 |
+
},
|
470 |
+
"require-dev": {
|
471 |
+
"mockery/mockery": "^0.9.4",
|
472 |
+
"phpunit/phpunit": "^4.4"
|
473 |
+
},
|
474 |
+
"type": "library",
|
475 |
+
"autoload": {
|
476 |
+
"psr-4": {
|
477 |
+
"phpDocumentor\\Reflection\\": [
|
478 |
+
"src/"
|
479 |
+
]
|
480 |
+
}
|
481 |
+
},
|
482 |
+
"notification-url": "https://packagist.org/downloads/",
|
483 |
+
"license": [
|
484 |
+
"MIT"
|
485 |
+
],
|
486 |
+
"authors": [
|
487 |
+
{
|
488 |
+
"name": "Mike van Riel",
|
489 |
+
"email": "me@mikevanriel.com"
|
490 |
+
}
|
491 |
+
],
|
492 |
+
"description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.",
|
493 |
+
"time": "2017-11-10T14:09:06+00:00"
|
494 |
+
},
|
495 |
+
{
|
496 |
+
"name": "phpdocumentor/type-resolver",
|
497 |
+
"version": "0.4.0",
|
498 |
+
"source": {
|
499 |
+
"type": "git",
|
500 |
+
"url": "https://github.com/phpDocumentor/TypeResolver.git",
|
501 |
+
"reference": "9c977708995954784726e25d0cd1dddf4e65b0f7"
|
502 |
+
},
|
503 |
+
"dist": {
|
504 |
+
"type": "zip",
|
505 |
+
"url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/9c977708995954784726e25d0cd1dddf4e65b0f7",
|
506 |
+
"reference": "9c977708995954784726e25d0cd1dddf4e65b0f7",
|
507 |
+
"shasum": ""
|
508 |
+
},
|
509 |
+
"require": {
|
510 |
+
"php": "^5.5 || ^7.0",
|
511 |
+
"phpdocumentor/reflection-common": "^1.0"
|
512 |
+
},
|
513 |
+
"require-dev": {
|
514 |
+
"mockery/mockery": "^0.9.4",
|
515 |
+
"phpunit/phpunit": "^5.2||^4.8.24"
|
516 |
+
},
|
517 |
+
"type": "library",
|
518 |
+
"extra": {
|
519 |
+
"branch-alias": {
|
520 |
+
"dev-master": "1.0.x-dev"
|
521 |
+
}
|
522 |
+
},
|
523 |
+
"autoload": {
|
524 |
+
"psr-4": {
|
525 |
+
"phpDocumentor\\Reflection\\": [
|
526 |
+
"src/"
|
527 |
+
]
|
528 |
+
}
|
529 |
+
},
|
530 |
+
"notification-url": "https://packagist.org/downloads/",
|
531 |
+
"license": [
|
532 |
+
"MIT"
|
533 |
+
],
|
534 |
+
"authors": [
|
535 |
+
{
|
536 |
+
"name": "Mike van Riel",
|
537 |
+
"email": "me@mikevanriel.com"
|
538 |
+
}
|
539 |
+
],
|
540 |
+
"time": "2017-07-14T14:27:02+00:00"
|
541 |
+
},
|
542 |
+
{
|
543 |
+
"name": "phpspec/prophecy",
|
544 |
+
"version": "1.8.0",
|
545 |
+
"source": {
|
546 |
+
"type": "git",
|
547 |
+
"url": "https://github.com/phpspec/prophecy.git",
|
548 |
+
"reference": "4ba436b55987b4bf311cb7c6ba82aa528aac0a06"
|
549 |
+
},
|
550 |
+
"dist": {
|
551 |
+
"type": "zip",
|
552 |
+
"url": "https://api.github.com/repos/phpspec/prophecy/zipball/4ba436b55987b4bf311cb7c6ba82aa528aac0a06",
|
553 |
+
"reference": "4ba436b55987b4bf311cb7c6ba82aa528aac0a06",
|
554 |
+
"shasum": ""
|
555 |
+
},
|
556 |
+
"require": {
|
557 |
+
"doctrine/instantiator": "^1.0.2",
|
558 |
+
"php": "^5.3|^7.0",
|
559 |
+
"phpdocumentor/reflection-docblock": "^2.0|^3.0.2|^4.0",
|
560 |
+
"sebastian/comparator": "^1.1|^2.0|^3.0",
|
561 |
+
"sebastian/recursion-context": "^1.0|^2.0|^3.0"
|
562 |
+
},
|
563 |
+
"require-dev": {
|
564 |
+
"phpspec/phpspec": "^2.5|^3.2",
|
565 |
+
"phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.5 || ^7.1"
|
566 |
+
},
|
567 |
+
"type": "library",
|
568 |
+
"extra": {
|
569 |
+
"branch-alias": {
|
570 |
+
"dev-master": "1.8.x-dev"
|
571 |
+
}
|
572 |
+
},
|
573 |
+
"autoload": {
|
574 |
+
"psr-0": {
|
575 |
+
"Prophecy\\": "src/"
|
576 |
+
}
|
577 |
+
},
|
578 |
+
"notification-url": "https://packagist.org/downloads/",
|
579 |
+
"license": [
|
580 |
+
"MIT"
|
581 |
+
],
|
582 |
+
"authors": [
|
583 |
+
{
|
584 |
+
"name": "Konstantin Kudryashov",
|
585 |
+
"email": "ever.zet@gmail.com",
|
586 |
+
"homepage": "http://everzet.com"
|
587 |
+
},
|
588 |
+
{
|
589 |
+
"name": "Marcello Duarte",
|
590 |
+
"email": "marcello.duarte@gmail.com"
|
591 |
+
}
|
592 |
+
],
|
593 |
+
"description": "Highly opinionated mocking framework for PHP 5.3+",
|
594 |
+
"homepage": "https://github.com/phpspec/prophecy",
|
595 |
+
"keywords": [
|
596 |
+
"Double",
|
597 |
+
"Dummy",
|
598 |
+
"fake",
|
599 |
+
"mock",
|
600 |
+
"spy",
|
601 |
+
"stub"
|
602 |
+
],
|
603 |
+
"time": "2018-08-05T17:53:17+00:00"
|
604 |
+
},
|
605 |
+
{
|
606 |
+
"name": "phpunit/php-code-coverage",
|
607 |
+
"version": "2.2.4",
|
608 |
+
"source": {
|
609 |
+
"type": "git",
|
610 |
+
"url": "https://github.com/sebastianbergmann/php-code-coverage.git",
|
611 |
+
"reference": "eabf68b476ac7d0f73793aada060f1c1a9bf8979"
|
612 |
+
},
|
613 |
+
"dist": {
|
614 |
+
"type": "zip",
|
615 |
+
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/eabf68b476ac7d0f73793aada060f1c1a9bf8979",
|
616 |
+
"reference": "eabf68b476ac7d0f73793aada060f1c1a9bf8979",
|
617 |
+
"shasum": ""
|
618 |
+
},
|
619 |
+
"require": {
|
620 |
+
"php": ">=5.3.3",
|
621 |
+
"phpunit/php-file-iterator": "~1.3",
|
622 |
+
"phpunit/php-text-template": "~1.2",
|
623 |
+
"phpunit/php-token-stream": "~1.3",
|
624 |
+
"sebastian/environment": "^1.3.2",
|
625 |
+
"sebastian/version": "~1.0"
|
626 |
+
},
|
627 |
+
"require-dev": {
|
628 |
+
"ext-xdebug": ">=2.1.4",
|
629 |
+
"phpunit/phpunit": "~4"
|
630 |
+
},
|
631 |
+
"suggest": {
|
632 |
+
"ext-dom": "*",
|
633 |
+
"ext-xdebug": ">=2.2.1",
|
634 |
+
"ext-xmlwriter": "*"
|
635 |
+
},
|
636 |
+
"type": "library",
|
637 |
+
"extra": {
|
638 |
+
"branch-alias": {
|
639 |
+
"dev-master": "2.2.x-dev"
|
640 |
+
}
|
641 |
+
},
|
642 |
+
"autoload": {
|
643 |
+
"classmap": [
|
644 |
+
"src/"
|
645 |
+
]
|
646 |
+
},
|
647 |
+
"notification-url": "https://packagist.org/downloads/",
|
648 |
+
"license": [
|
649 |
+
"BSD-3-Clause"
|
650 |
+
],
|
651 |
+
"authors": [
|
652 |
+
{
|
653 |
+
"name": "Sebastian Bergmann",
|
654 |
+
"email": "sb@sebastian-bergmann.de",
|
655 |
+
"role": "lead"
|
656 |
+
}
|
657 |
+
],
|
658 |
+
"description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.",
|
659 |
+
"homepage": "https://github.com/sebastianbergmann/php-code-coverage",
|
660 |
+
"keywords": [
|
661 |
+
"coverage",
|
662 |
+
"testing",
|
663 |
+
"xunit"
|
664 |
+
],
|
665 |
+
"time": "2015-10-06T15:47:00+00:00"
|
666 |
+
},
|
667 |
+
{
|
668 |
+
"name": "phpunit/php-file-iterator",
|
669 |
+
"version": "1.4.5",
|
670 |
+
"source": {
|
671 |
+
"type": "git",
|
672 |
+
"url": "https://github.com/sebastianbergmann/php-file-iterator.git",
|
673 |
+
"reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4"
|
674 |
+
},
|
675 |
+
"dist": {
|
676 |
+
"type": "zip",
|
677 |
+
"url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/730b01bc3e867237eaac355e06a36b85dd93a8b4",
|
678 |
+
"reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4",
|
679 |
+
"shasum": ""
|
680 |
+
},
|
681 |
+
"require": {
|
682 |
+
"php": ">=5.3.3"
|
683 |
+
},
|
684 |
+
"type": "library",
|
685 |
+
"extra": {
|
686 |
+
"branch-alias": {
|
687 |
+
"dev-master": "1.4.x-dev"
|
688 |
+
}
|
689 |
+
},
|
690 |
+
"autoload": {
|
691 |
+
"classmap": [
|
692 |
+
"src/"
|
693 |
+
]
|
694 |
+
},
|
695 |
+
"notification-url": "https://packagist.org/downloads/",
|
696 |
+
"license": [
|
697 |
+
"BSD-3-Clause"
|
698 |
+
],
|
699 |
+
"authors": [
|
700 |
+
{
|
701 |
+
"name": "Sebastian Bergmann",
|
702 |
+
"email": "sb@sebastian-bergmann.de",
|
703 |
+
"role": "lead"
|
704 |
+
}
|
705 |
+
],
|
706 |
+
"description": "FilterIterator implementation that filters files based on a list of suffixes.",
|
707 |
+
"homepage": "https://github.com/sebastianbergmann/php-file-iterator/",
|
708 |
+
"keywords": [
|
709 |
+
"filesystem",
|
710 |
+
"iterator"
|
711 |
+
],
|
712 |
+
"time": "2017-11-27T13:52:08+00:00"
|
713 |
+
},
|
714 |
+
{
|
715 |
+
"name": "phpunit/php-text-template",
|
716 |
+
"version": "1.2.1",
|
717 |
+
"source": {
|
718 |
+
"type": "git",
|
719 |
+
"url": "https://github.com/sebastianbergmann/php-text-template.git",
|
720 |
+
"reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686"
|
721 |
+
},
|
722 |
+
"dist": {
|
723 |
+
"type": "zip",
|
724 |
+
"url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/31f8b717e51d9a2afca6c9f046f5d69fc27c8686",
|
725 |
+
"reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686",
|
726 |
+
"shasum": ""
|
727 |
+
},
|
728 |
+
"require": {
|
729 |
+
"php": ">=5.3.3"
|
730 |
+
},
|
731 |
+
"type": "library",
|
732 |
+
"autoload": {
|
733 |
+
"classmap": [
|
734 |
+
"src/"
|
735 |
+
]
|
736 |
+
},
|
737 |
+
"notification-url": "https://packagist.org/downloads/",
|
738 |
+
"license": [
|
739 |
+
"BSD-3-Clause"
|
740 |
+
],
|
741 |
+
"authors": [
|
742 |
+
{
|
743 |
+
"name": "Sebastian Bergmann",
|
744 |
+
"email": "sebastian@phpunit.de",
|
745 |
+
"role": "lead"
|
746 |
+
}
|
747 |
+
],
|
748 |
+
"description": "Simple template engine.",
|
749 |
+
"homepage": "https://github.com/sebastianbergmann/php-text-template/",
|
750 |
+
"keywords": [
|
751 |
+
"template"
|
752 |
+
],
|
753 |
+
"time": "2015-06-21T13:50:34+00:00"
|
754 |
+
},
|
755 |
+
{
|
756 |
+
"name": "phpunit/php-timer",
|
757 |
+
"version": "1.0.9",
|
758 |
+
"source": {
|
759 |
+
"type": "git",
|
760 |
+
"url": "https://github.com/sebastianbergmann/php-timer.git",
|
761 |
+
"reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f"
|
762 |
+
},
|
763 |
+
"dist": {
|
764 |
+
"type": "zip",
|
765 |
+
"url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/3dcf38ca72b158baf0bc245e9184d3fdffa9c46f",
|
766 |
+
"reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f",
|
767 |
+
"shasum": ""
|
768 |
+
},
|
769 |
+
"require": {
|
770 |
+
"php": "^5.3.3 || ^7.0"
|
771 |
+
},
|
772 |
+
"require-dev": {
|
773 |
+
"phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0"
|
774 |
+
},
|
775 |
+
"type": "library",
|
776 |
+
"extra": {
|
777 |
+
"branch-alias": {
|
778 |
+
"dev-master": "1.0-dev"
|
779 |
+
}
|
780 |
+
},
|
781 |
+
"autoload": {
|
782 |
+
"classmap": [
|
783 |
+
"src/"
|
784 |
+
]
|
785 |
+
},
|
786 |
+
"notification-url": "https://packagist.org/downloads/",
|
787 |
+
"license": [
|
788 |
+
"BSD-3-Clause"
|
789 |
+
],
|
790 |
+
"authors": [
|
791 |
+
{
|
792 |
+
"name": "Sebastian Bergmann",
|
793 |
+
"email": "sb@sebastian-bergmann.de",
|
794 |
+
"role": "lead"
|
795 |
+
}
|
796 |
+
],
|
797 |
+
"description": "Utility class for timing",
|
798 |
+
"homepage": "https://github.com/sebastianbergmann/php-timer/",
|
799 |
+
"keywords": [
|
800 |
+
"timer"
|
801 |
+
],
|
802 |
+
"time": "2017-02-26T11:10:40+00:00"
|
803 |
+
},
|
804 |
+
{
|
805 |
+
"name": "phpunit/php-token-stream",
|
806 |
+
"version": "1.4.12",
|
807 |
+
"source": {
|
808 |
+
"type": "git",
|
809 |
+
"url": "https://github.com/sebastianbergmann/php-token-stream.git",
|
810 |
+
"reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16"
|
811 |
+
},
|
812 |
+
"dist": {
|
813 |
+
"type": "zip",
|
814 |
+
"url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/1ce90ba27c42e4e44e6d8458241466380b51fa16",
|
815 |
+
"reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16",
|
816 |
+
"shasum": ""
|
817 |
+
},
|
818 |
+
"require": {
|
819 |
+
"ext-tokenizer": "*",
|
820 |
+
"php": ">=5.3.3"
|
821 |
+
},
|
822 |
+
"require-dev": {
|
823 |
+
"phpunit/phpunit": "~4.2"
|
824 |
+
},
|
825 |
+
"type": "library",
|
826 |
+
"extra": {
|
827 |
+
"branch-alias": {
|
828 |
+
"dev-master": "1.4-dev"
|
829 |
+
}
|
830 |
+
},
|
831 |
+
"autoload": {
|
832 |
+
"classmap": [
|
833 |
+
"src/"
|
834 |
+
]
|
835 |
+
},
|
836 |
+
"notification-url": "https://packagist.org/downloads/",
|
837 |
+
"license": [
|
838 |
+
"BSD-3-Clause"
|
839 |
+
],
|
840 |
+
"authors": [
|
841 |
+
{
|
842 |
+
"name": "Sebastian Bergmann",
|
843 |
+
"email": "sebastian@phpunit.de"
|
844 |
+
}
|
845 |
+
],
|
846 |
+
"description": "Wrapper around PHP's tokenizer extension.",
|
847 |
+
"homepage": "https://github.com/sebastianbergmann/php-token-stream/",
|
848 |
+
"keywords": [
|
849 |
+
"tokenizer"
|
850 |
+
],
|
851 |
+
"time": "2017-12-04T08:55:13+00:00"
|
852 |
+
},
|
853 |
+
{
|
854 |
+
"name": "phpunit/phpunit",
|
855 |
+
"version": "4.8.36",
|
856 |
+
"source": {
|
857 |
+
"type": "git",
|
858 |
+
"url": "https://github.com/sebastianbergmann/phpunit.git",
|
859 |
+
"reference": "46023de9a91eec7dfb06cc56cb4e260017298517"
|
860 |
+
},
|
861 |
+
"dist": {
|
862 |
+
"type": "zip",
|
863 |
+
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/46023de9a91eec7dfb06cc56cb4e260017298517",
|
864 |
+
"reference": "46023de9a91eec7dfb06cc56cb4e260017298517",
|
865 |
+
"shasum": ""
|
866 |
+
},
|
867 |
+
"require": {
|
868 |
+
"ext-dom": "*",
|
869 |
+
"ext-json": "*",
|
870 |
+
"ext-pcre": "*",
|
871 |
+
"ext-reflection": "*",
|
872 |
+
"ext-spl": "*",
|
873 |
+
"php": ">=5.3.3",
|
874 |
+
"phpspec/prophecy": "^1.3.1",
|
875 |
+
"phpunit/php-code-coverage": "~2.1",
|
876 |
+
"phpunit/php-file-iterator": "~1.4",
|
877 |
+
"phpunit/php-text-template": "~1.2",
|
878 |
+
"phpunit/php-timer": "^1.0.6",
|
879 |
+
"phpunit/phpunit-mock-objects": "~2.3",
|
880 |
+
"sebastian/comparator": "~1.2.2",
|
881 |
+
"sebastian/diff": "~1.2",
|
882 |
+
"sebastian/environment": "~1.3",
|
883 |
+
"sebastian/exporter": "~1.2",
|
884 |
+
"sebastian/global-state": "~1.0",
|
885 |
+
"sebastian/version": "~1.0",
|
886 |
+
"symfony/yaml": "~2.1|~3.0"
|
887 |
+
},
|
888 |
+
"suggest": {
|
889 |
+
"phpunit/php-invoker": "~1.1"
|
890 |
+
},
|
891 |
+
"bin": [
|
892 |
+
"phpunit"
|
893 |
+
],
|
894 |
+
"type": "library",
|
895 |
+
"extra": {
|
896 |
+
"branch-alias": {
|
897 |
+
"dev-master": "4.8.x-dev"
|
898 |
+
}
|
899 |
+
},
|
900 |
+
"autoload": {
|
901 |
+
"classmap": [
|
902 |
+
"src/"
|
903 |
+
]
|
904 |
+
},
|
905 |
+
"notification-url": "https://packagist.org/downloads/",
|
906 |
+
"license": [
|
907 |
+
"BSD-3-Clause"
|
908 |
+
],
|
909 |
+
"authors": [
|
910 |
+
{
|
911 |
+
"name": "Sebastian Bergmann",
|
912 |
+
"email": "sebastian@phpunit.de",
|
913 |
+
"role": "lead"
|
914 |
+
}
|
915 |
+
],
|
916 |
+
"description": "The PHP Unit Testing framework.",
|
917 |
+
"homepage": "https://phpunit.de/",
|
918 |
+
"keywords": [
|
919 |
+
"phpunit",
|
920 |
+
"testing",
|
921 |
+
"xunit"
|
922 |
+
],
|
923 |
+
"time": "2017-06-21T08:07:12+00:00"
|
924 |
+
},
|
925 |
+
{
|
926 |
+
"name": "phpunit/phpunit-mock-objects",
|
927 |
+
"version": "2.3.8",
|
928 |
+
"source": {
|
929 |
+
"type": "git",
|
930 |
+
"url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git",
|
931 |
+
"reference": "ac8e7a3db35738d56ee9a76e78a4e03d97628983"
|
932 |
+
},
|
933 |
+
"dist": {
|
934 |
+
"type": "zip",
|
935 |
+
"url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/ac8e7a3db35738d56ee9a76e78a4e03d97628983",
|
936 |
+
"reference": "ac8e7a3db35738d56ee9a76e78a4e03d97628983",
|
937 |
+
"shasum": ""
|
938 |
+
},
|
939 |
+
"require": {
|
940 |
+
"doctrine/instantiator": "^1.0.2",
|
941 |
+
"php": ">=5.3.3",
|
942 |
+
"phpunit/php-text-template": "~1.2",
|
943 |
+
"sebastian/exporter": "~1.2"
|
944 |
+
},
|
945 |
+
"require-dev": {
|
946 |
+
"phpunit/phpunit": "~4.4"
|
947 |
+
},
|
948 |
+
"suggest": {
|
949 |
+
"ext-soap": "*"
|
950 |
+
},
|
951 |
+
"type": "library",
|
952 |
+
"extra": {
|
953 |
+
"branch-alias": {
|
954 |
+
"dev-master": "2.3.x-dev"
|
955 |
+
}
|
956 |
+
},
|
957 |
+
"autoload": {
|
958 |
+
"classmap": [
|
959 |
+
"src/"
|
960 |
+
]
|
961 |
+
},
|
962 |
+
"notification-url": "https://packagist.org/downloads/",
|
963 |
+
"license": [
|
964 |
+
"BSD-3-Clause"
|
965 |
+
],
|
966 |
+
"authors": [
|
967 |
+
{
|
968 |
+
"name": "Sebastian Bergmann",
|
969 |
+
"email": "sb@sebastian-bergmann.de",
|
970 |
+
"role": "lead"
|
971 |
+
}
|
972 |
+
],
|
973 |
+
"description": "Mock Object library for PHPUnit",
|
974 |
+
"homepage": "https://github.com/sebastianbergmann/phpunit-mock-objects/",
|
975 |
+
"keywords": [
|
976 |
+
"mock",
|
977 |
+
"xunit"
|
978 |
+
],
|
979 |
+
"abandoned": true,
|
980 |
+
"time": "2015-10-02T06:51:40+00:00"
|
981 |
+
},
|
982 |
+
{
|
983 |
+
"name": "psr/log",
|
984 |
+
"version": "1.1.0",
|
985 |
+
"source": {
|
986 |
+
"type": "git",
|
987 |
+
"url": "https://github.com/php-fig/log.git",
|
988 |
+
"reference": "6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd"
|
989 |
+
},
|
990 |
+
"dist": {
|
991 |
+
"type": "zip",
|
992 |
+
"url": "https://api.github.com/repos/php-fig/log/zipball/6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd",
|
993 |
+
"reference": "6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd",
|
994 |
+
"shasum": ""
|
995 |
+
},
|
996 |
+
"require": {
|
997 |
+
"php": ">=5.3.0"
|
998 |
+
},
|
999 |
+
"type": "library",
|
1000 |
+
"extra": {
|
1001 |
+
"branch-alias": {
|
1002 |
+
"dev-master": "1.0.x-dev"
|
1003 |
+
}
|
1004 |
+
},
|
1005 |
+
"autoload": {
|
1006 |
+
"psr-4": {
|
1007 |
+
"Psr\\Log\\": "Psr/Log/"
|
1008 |
+
}
|
1009 |
+
},
|
1010 |
+
"notification-url": "https://packagist.org/downloads/",
|
1011 |
+
"license": [
|
1012 |
+
"MIT"
|
1013 |
+
],
|
1014 |
+
"authors": [
|
1015 |
+
{
|
1016 |
+
"name": "PHP-FIG",
|
1017 |
+
"homepage": "http://www.php-fig.org/"
|
1018 |
+
}
|
1019 |
+
],
|
1020 |
+
"description": "Common interface for logging libraries",
|
1021 |
+
"homepage": "https://github.com/php-fig/log",
|
1022 |
+
"keywords": [
|
1023 |
+
"log",
|
1024 |
+
"psr",
|
1025 |
+
"psr-3"
|
1026 |
+
],
|
1027 |
+
"time": "2018-11-20T15:27:04+00:00"
|
1028 |
+
},
|
1029 |
+
{
|
1030 |
+
"name": "sebastian/comparator",
|
1031 |
+
"version": "1.2.4",
|
1032 |
+
"source": {
|
1033 |
+
"type": "git",
|
1034 |
+
"url": "https://github.com/sebastianbergmann/comparator.git",
|
1035 |
+
"reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be"
|
1036 |
+
},
|
1037 |
+
"dist": {
|
1038 |
+
"type": "zip",
|
1039 |
+
"url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/2b7424b55f5047b47ac6e5ccb20b2aea4011d9be",
|
1040 |
+
"reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be",
|
1041 |
+
"shasum": ""
|
1042 |
+
},
|
1043 |
+
"require": {
|
1044 |
+
"php": ">=5.3.3",
|
1045 |
+
"sebastian/diff": "~1.2",
|
1046 |
+
"sebastian/exporter": "~1.2 || ~2.0"
|
1047 |
+
},
|
1048 |
+
"require-dev": {
|
1049 |
+
"phpunit/phpunit": "~4.4"
|
1050 |
+
},
|
1051 |
+
"type": "library",
|
1052 |
+
"extra": {
|
1053 |
+
"branch-alias": {
|
1054 |
+
"dev-master": "1.2.x-dev"
|
1055 |
+
}
|
1056 |
+
},
|
1057 |
+
"autoload": {
|
1058 |
+
"classmap": [
|
1059 |
+
"src/"
|
1060 |
+
]
|
1061 |
+
},
|
1062 |
+
"notification-url": "https://packagist.org/downloads/",
|
1063 |
+
"license": [
|
1064 |
+
"BSD-3-Clause"
|
1065 |
+
],
|
1066 |
+
"authors": [
|
1067 |
+
{
|
1068 |
+
"name": "Jeff Welch",
|
1069 |
+
"email": "whatthejeff@gmail.com"
|
1070 |
+
},
|
1071 |
+
{
|
1072 |
+
"name": "Volker Dusch",
|
1073 |
+
"email": "github@wallbash.com"
|
1074 |
+
},
|
1075 |
+
{
|
1076 |
+
"name": "Bernhard Schussek",
|
1077 |
+
"email": "bschussek@2bepublished.at"
|
1078 |
+
},
|
1079 |
+
{
|
1080 |
+
"name": "Sebastian Bergmann",
|
1081 |
+
"email": "sebastian@phpunit.de"
|
1082 |
+
}
|
1083 |
+
],
|
1084 |
+
"description": "Provides the functionality to compare PHP values for equality",
|
1085 |
+
"homepage": "http://www.github.com/sebastianbergmann/comparator",
|
1086 |
+
"keywords": [
|
1087 |
+
"comparator",
|
1088 |
+
"compare",
|
1089 |
+
"equality"
|
1090 |
+
],
|
1091 |
+
"time": "2017-01-29T09:50:25+00:00"
|
1092 |
+
},
|
1093 |
+
{
|
1094 |
+
"name": "sebastian/diff",
|
1095 |
+
"version": "1.4.3",
|
1096 |
+
"source": {
|
1097 |
+
"type": "git",
|
1098 |
+
"url": "https://github.com/sebastianbergmann/diff.git",
|
1099 |
+
"reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4"
|
1100 |
+
},
|
1101 |
+
"dist": {
|
1102 |
+
"type": "zip",
|
1103 |
+
"url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7f066a26a962dbe58ddea9f72a4e82874a3975a4",
|
1104 |
+
"reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4",
|
1105 |
+
"shasum": ""
|
1106 |
+
},
|
1107 |
+
"require": {
|
1108 |
+
"php": "^5.3.3 || ^7.0"
|
1109 |
+
},
|
1110 |
+
"require-dev": {
|
1111 |
+
"phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0"
|
1112 |
+
},
|
1113 |
+
"type": "library",
|
1114 |
+
"extra": {
|
1115 |
+
"branch-alias": {
|
1116 |
+
"dev-master": "1.4-dev"
|
1117 |
+
}
|
1118 |
+
},
|
1119 |
+
"autoload": {
|
1120 |
+
"classmap": [
|
1121 |
+
"src/"
|
1122 |
+
]
|
1123 |
+
},
|
1124 |
+
"notification-url": "https://packagist.org/downloads/",
|
1125 |
+
"license": [
|
1126 |
+
"BSD-3-Clause"
|
1127 |
+
],
|
1128 |
+
"authors": [
|
1129 |
+
{
|
1130 |
+
"name": "Kore Nordmann",
|
1131 |
+
"email": "mail@kore-nordmann.de"
|
1132 |
+
},
|
1133 |
+
{
|
1134 |
+
"name": "Sebastian Bergmann",
|
1135 |
+
"email": "sebastian@phpunit.de"
|
1136 |
+
}
|
1137 |
+
],
|
1138 |
+
"description": "Diff implementation",
|
1139 |
+
"homepage": "https://github.com/sebastianbergmann/diff",
|
1140 |
+
"keywords": [
|
1141 |
+
"diff"
|
1142 |
+
],
|
1143 |
+
"time": "2017-05-22T07:24:03+00:00"
|
1144 |
+
},
|
1145 |
+
{
|
1146 |
+
"name": "sebastian/environment",
|
1147 |
+
"version": "1.3.8",
|
1148 |
+
"source": {
|
1149 |
+
"type": "git",
|
1150 |
+
"url": "https://github.com/sebastianbergmann/environment.git",
|
1151 |
+
"reference": "be2c607e43ce4c89ecd60e75c6a85c126e754aea"
|
1152 |
+
},
|
1153 |
+
"dist": {
|
1154 |
+
"type": "zip",
|
1155 |
+
"url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/be2c607e43ce4c89ecd60e75c6a85c126e754aea",
|
1156 |
+
"reference": "be2c607e43ce4c89ecd60e75c6a85c126e754aea",
|
1157 |
+
"shasum": ""
|
1158 |
+
},
|
1159 |
+
"require": {
|
1160 |
+
"php": "^5.3.3 || ^7.0"
|
1161 |
+
},
|
1162 |
+
"require-dev": {
|
1163 |
+
"phpunit/phpunit": "^4.8 || ^5.0"
|
1164 |
+
},
|
1165 |
+
"type": "library",
|
1166 |
+
"extra": {
|
1167 |
+
"branch-alias": {
|
1168 |
+
"dev-master": "1.3.x-dev"
|
1169 |
+
}
|
1170 |
+
},
|
1171 |
+
"autoload": {
|
1172 |
+
"classmap": [
|
1173 |
+
"src/"
|
1174 |
+
]
|
1175 |
+
},
|
1176 |
+
"notification-url": "https://packagist.org/downloads/",
|
1177 |
+
"license": [
|
1178 |
+
"BSD-3-Clause"
|
1179 |
+
],
|
1180 |
+
"authors": [
|
1181 |
+
{
|
1182 |
+
"name": "Sebastian Bergmann",
|
1183 |
+
"email": "sebastian@phpunit.de"
|
1184 |
+
}
|
1185 |
+
],
|
1186 |
+
"description": "Provides functionality to handle HHVM/PHP environments",
|
1187 |
+
"homepage": "http://www.github.com/sebastianbergmann/environment",
|
1188 |
+
"keywords": [
|
1189 |
+
"Xdebug",
|
1190 |
+
"environment",
|
1191 |
+
"hhvm"
|
1192 |
+
],
|
1193 |
+
"time": "2016-08-18T05:49:44+00:00"
|
1194 |
+
},
|
1195 |
+
{
|
1196 |
+
"name": "sebastian/exporter",
|
1197 |
+
"version": "1.2.2",
|
1198 |
+
"source": {
|
1199 |
+
"type": "git",
|
1200 |
+
"url": "https://github.com/sebastianbergmann/exporter.git",
|
1201 |
+
"reference": "42c4c2eec485ee3e159ec9884f95b431287edde4"
|
1202 |
+
},
|
1203 |
+
"dist": {
|
1204 |
+
"type": "zip",
|
1205 |
+
"url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/42c4c2eec485ee3e159ec9884f95b431287edde4",
|
1206 |
+
"reference": "42c4c2eec485ee3e159ec9884f95b431287edde4",
|
1207 |
+
"shasum": ""
|
1208 |
+
},
|
1209 |
+
"require": {
|
1210 |
+
"php": ">=5.3.3",
|
1211 |
+
"sebastian/recursion-context": "~1.0"
|
1212 |
+
},
|
1213 |
+
"require-dev": {
|
1214 |
+
"ext-mbstring": "*",
|
1215 |
+
"phpunit/phpunit": "~4.4"
|
1216 |
+
},
|
1217 |
+
"type": "library",
|
1218 |
+
"extra": {
|
1219 |
+
"branch-alias": {
|
1220 |
+
"dev-master": "1.3.x-dev"
|
1221 |
+
}
|
1222 |
+
},
|
1223 |
+
"autoload": {
|
1224 |
+
"classmap": [
|
1225 |
+
"src/"
|
1226 |
+
]
|
1227 |
+
},
|
1228 |
+
"notification-url": "https://packagist.org/downloads/",
|
1229 |
+
"license": [
|
1230 |
+
"BSD-3-Clause"
|
1231 |
+
],
|
1232 |
+
"authors": [
|
1233 |
+
{
|
1234 |
+
"name": "Jeff Welch",
|
1235 |
+
"email": "whatthejeff@gmail.com"
|
1236 |
+
},
|
1237 |
+
{
|
1238 |
+
"name": "Volker Dusch",
|
1239 |
+
"email": "github@wallbash.com"
|
1240 |
+
},
|
1241 |
+
{
|
1242 |
+
"name": "Bernhard Schussek",
|
1243 |
+
"email": "bschussek@2bepublished.at"
|
1244 |
+
},
|
1245 |
+
{
|
1246 |
+
"name": "Sebastian Bergmann",
|
1247 |
+
"email": "sebastian@phpunit.de"
|
1248 |
+
},
|
1249 |
+
{
|
1250 |
+
"name": "Adam Harvey",
|
1251 |
+
"email": "aharvey@php.net"
|
1252 |
+
}
|
1253 |
+
],
|
1254 |
+
"description": "Provides the functionality to export PHP variables for visualization",
|
1255 |
+
"homepage": "http://www.github.com/sebastianbergmann/exporter",
|
1256 |
+
"keywords": [
|
1257 |
+
"export",
|
1258 |
+
"exporter"
|
1259 |
+
],
|
1260 |
+
"time": "2016-06-17T09:04:28+00:00"
|
1261 |
+
},
|
1262 |
+
{
|
1263 |
+
"name": "sebastian/global-state",
|
1264 |
+
"version": "1.1.1",
|
1265 |
+
"source": {
|
1266 |
+
"type": "git",
|
1267 |
+
"url": "https://github.com/sebastianbergmann/global-state.git",
|
1268 |
+
"reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4"
|
1269 |
+
},
|
1270 |
+
"dist": {
|
1271 |
+
"type": "zip",
|
1272 |
+
"url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/bc37d50fea7d017d3d340f230811c9f1d7280af4",
|
1273 |
+
"reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4",
|
1274 |
+
"shasum": ""
|
1275 |
+
},
|
1276 |
+
"require": {
|
1277 |
+
"php": ">=5.3.3"
|
1278 |
+
},
|
1279 |
+
"require-dev": {
|
1280 |
+
"phpunit/phpunit": "~4.2"
|
1281 |
+
},
|
1282 |
+
"suggest": {
|
1283 |
+
"ext-uopz": "*"
|
1284 |
+
},
|
1285 |
+
"type": "library",
|
1286 |
+
"extra": {
|
1287 |
+
"branch-alias": {
|
1288 |
+
"dev-master": "1.0-dev"
|
1289 |
+
}
|
1290 |
+
},
|
1291 |
+
"autoload": {
|
1292 |
+
"classmap": [
|
1293 |
+
"src/"
|
1294 |
+
]
|
1295 |
+
},
|
1296 |
+
"notification-url": "https://packagist.org/downloads/",
|
1297 |
+
"license": [
|
1298 |
+
"BSD-3-Clause"
|
1299 |
+
],
|
1300 |
+
"authors": [
|
1301 |
+
{
|
1302 |
+
"name": "Sebastian Bergmann",
|
1303 |
+
"email": "sebastian@phpunit.de"
|
1304 |
+
}
|
1305 |
+
],
|
1306 |
+
"description": "Snapshotting of global state",
|
1307 |
+
"homepage": "http://www.github.com/sebastianbergmann/global-state",
|
1308 |
+
"keywords": [
|
1309 |
+
"global state"
|
1310 |
+
],
|
1311 |
+
"time": "2015-10-12T03:26:01+00:00"
|
1312 |
+
},
|
1313 |
+
{
|
1314 |
+
"name": "sebastian/recursion-context",
|
1315 |
+
"version": "1.0.5",
|
1316 |
+
"source": {
|
1317 |
+
"type": "git",
|
1318 |
+
"url": "https://github.com/sebastianbergmann/recursion-context.git",
|
1319 |
+
"reference": "b19cc3298482a335a95f3016d2f8a6950f0fbcd7"
|
1320 |
+
},
|
1321 |
+
"dist": {
|
1322 |
+
"type": "zip",
|
1323 |
+
"url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/b19cc3298482a335a95f3016d2f8a6950f0fbcd7",
|
1324 |
+
"reference": "b19cc3298482a335a95f3016d2f8a6950f0fbcd7",
|
1325 |
+
"shasum": ""
|
1326 |
+
},
|
1327 |
+
"require": {
|
1328 |
+
"php": ">=5.3.3"
|
1329 |
+
},
|
1330 |
+
"require-dev": {
|
1331 |
+
"phpunit/phpunit": "~4.4"
|
1332 |
+
},
|
1333 |
+
"type": "library",
|
1334 |
+
"extra": {
|
1335 |
+
"branch-alias": {
|
1336 |
+
"dev-master": "1.0.x-dev"
|
1337 |
+
}
|
1338 |
+
},
|
1339 |
+
"autoload": {
|
1340 |
+
"classmap": [
|
1341 |
+
"src/"
|
1342 |
+
]
|
1343 |
+
},
|
1344 |
+
"notification-url": "https://packagist.org/downloads/",
|
1345 |
+
"license": [
|
1346 |
+
"BSD-3-Clause"
|
1347 |
+
],
|
1348 |
+
"authors": [
|
1349 |
+
{
|
1350 |
+
"name": "Jeff Welch",
|
1351 |
+
"email": "whatthejeff@gmail.com"
|
1352 |
+
},
|
1353 |
+
{
|
1354 |
+
"name": "Sebastian Bergmann",
|
1355 |
+
"email": "sebastian@phpunit.de"
|
1356 |
+
},
|
1357 |
+
{
|
1358 |
+
"name": "Adam Harvey",
|
1359 |
+
"email": "aharvey@php.net"
|
1360 |
+
}
|
1361 |
+
],
|
1362 |
+
"description": "Provides functionality to recursively process PHP variables",
|
1363 |
+
"homepage": "http://www.github.com/sebastianbergmann/recursion-context",
|
1364 |
+
"time": "2016-10-03T07:41:43+00:00"
|
1365 |
+
},
|
1366 |
+
{
|
1367 |
+
"name": "sebastian/version",
|
1368 |
+
"version": "1.0.6",
|
1369 |
+
"source": {
|
1370 |
+
"type": "git",
|
1371 |
+
"url": "https://github.com/sebastianbergmann/version.git",
|
1372 |
+
"reference": "58b3a85e7999757d6ad81c787a1fbf5ff6c628c6"
|
1373 |
+
},
|
1374 |
+
"dist": {
|
1375 |
+
"type": "zip",
|
1376 |
+
"url": "https://api.github.com/repos/sebastianbergmann/version/zipball/58b3a85e7999757d6ad81c787a1fbf5ff6c628c6",
|
1377 |
+
"reference": "58b3a85e7999757d6ad81c787a1fbf5ff6c628c6",
|
1378 |
+
"shasum": ""
|
1379 |
+
},
|
1380 |
+
"type": "library",
|
1381 |
+
"autoload": {
|
1382 |
+
"classmap": [
|
1383 |
+
"src/"
|
1384 |
+
]
|
1385 |
+
},
|
1386 |
+
"notification-url": "https://packagist.org/downloads/",
|
1387 |
+
"license": [
|
1388 |
+
"BSD-3-Clause"
|
1389 |
+
],
|
1390 |
+
"authors": [
|
1391 |
+
{
|
1392 |
+
"name": "Sebastian Bergmann",
|
1393 |
+
"email": "sebastian@phpunit.de",
|
1394 |
+
"role": "lead"
|
1395 |
+
}
|
1396 |
+
],
|
1397 |
+
"description": "Library that helps with managing the version number of Git-hosted PHP projects",
|
1398 |
+
"homepage": "https://github.com/sebastianbergmann/version",
|
1399 |
+
"time": "2015-06-21T13:59:46+00:00"
|
1400 |
+
},
|
1401 |
+
{
|
1402 |
+
"name": "squizlabs/php_codesniffer",
|
1403 |
+
"version": "2.9.2",
|
1404 |
+
"source": {
|
1405 |
+
"type": "git",
|
1406 |
+
"url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
|
1407 |
+
"reference": "2acf168de78487db620ab4bc524135a13cfe6745"
|
1408 |
+
},
|
1409 |
+
"dist": {
|
1410 |
+
"type": "zip",
|
1411 |
+
"url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/2acf168de78487db620ab4bc524135a13cfe6745",
|
1412 |
+
"reference": "2acf168de78487db620ab4bc524135a13cfe6745",
|
1413 |
+
"shasum": ""
|
1414 |
+
},
|
1415 |
+
"require": {
|
1416 |
+
"ext-simplexml": "*",
|
1417 |
+
"ext-tokenizer": "*",
|
1418 |
+
"ext-xmlwriter": "*",
|
1419 |
+
"php": ">=5.1.2"
|
1420 |
+
},
|
1421 |
+
"require-dev": {
|
1422 |
+
"phpunit/phpunit": "~4.0"
|
1423 |
+
},
|
1424 |
+
"bin": [
|
1425 |
+
"scripts/phpcs",
|
1426 |
+
"scripts/phpcbf"
|
1427 |
+
],
|
1428 |
+
"type": "library",
|
1429 |
+
"extra": {
|
1430 |
+
"branch-alias": {
|
1431 |
+
"dev-master": "2.x-dev"
|
1432 |
+
}
|
1433 |
+
},
|
1434 |
+
"autoload": {
|
1435 |
+
"classmap": [
|
1436 |
+
"CodeSniffer.php",
|
1437 |
+
"CodeSniffer/CLI.php",
|
1438 |
+
"CodeSniffer/Exception.php",
|
1439 |
+
"CodeSniffer/File.php",
|
1440 |
+
"CodeSniffer/Fixer.php",
|
1441 |
+
"CodeSniffer/Report.php",
|
1442 |
+
"CodeSniffer/Reporting.php",
|
1443 |
+
"CodeSniffer/Sniff.php",
|
1444 |
+
"CodeSniffer/Tokens.php",
|
1445 |
+
"CodeSniffer/Reports/",
|
1446 |
+
"CodeSniffer/Tokenizers/",
|
1447 |
+
"CodeSniffer/DocGenerators/",
|
1448 |
+
"CodeSniffer/Standards/AbstractPatternSniff.php",
|
1449 |
+
"CodeSniffer/Standards/AbstractScopeSniff.php",
|
1450 |
+
"CodeSniffer/Standards/AbstractVariableSniff.php",
|
1451 |
+
"CodeSniffer/Standards/IncorrectPatternException.php",
|
1452 |
+
"CodeSniffer/Standards/Generic/Sniffs/",
|
1453 |
+
"CodeSniffer/Standards/MySource/Sniffs/",
|
1454 |
+
"CodeSniffer/Standards/PEAR/Sniffs/",
|
1455 |
+
"CodeSniffer/Standards/PSR1/Sniffs/",
|
1456 |
+
"CodeSniffer/Standards/PSR2/Sniffs/",
|
1457 |
+
"CodeSniffer/Standards/Squiz/Sniffs/",
|
1458 |
+
"CodeSniffer/Standards/Zend/Sniffs/"
|
1459 |
+
]
|
1460 |
+
},
|
1461 |
+
"notification-url": "https://packagist.org/downloads/",
|
1462 |
+
"license": [
|
1463 |
+
"BSD-3-Clause"
|
1464 |
+
],
|
1465 |
+
"authors": [
|
1466 |
+
{
|
1467 |
+
"name": "Greg Sherwood",
|
1468 |
+
"role": "lead"
|
1469 |
+
}
|
1470 |
+
],
|
1471 |
+
"description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
|
1472 |
+
"homepage": "http://www.squizlabs.com/php-codesniffer",
|
1473 |
+
"keywords": [
|
1474 |
+
"phpcs",
|
1475 |
+
"standards"
|
1476 |
+
],
|
1477 |
+
"time": "2018-11-07T22:31:41+00:00"
|
1478 |
+
},
|
1479 |
+
{
|
1480 |
+
"name": "symfony/console",
|
1481 |
+
"version": "v3.4.26",
|
1482 |
+
"source": {
|
1483 |
+
"type": "git",
|
1484 |
+
"url": "https://github.com/symfony/console.git",
|
1485 |
+
"reference": "15a9104356436cb26e08adab97706654799d31d8"
|
1486 |
+
},
|
1487 |
+
"dist": {
|
1488 |
+
"type": "zip",
|
1489 |
+
"url": "https://api.github.com/repos/symfony/console/zipball/15a9104356436cb26e08adab97706654799d31d8",
|
1490 |
+
"reference": "15a9104356436cb26e08adab97706654799d31d8",
|
1491 |
+
"shasum": ""
|
1492 |
+
},
|
1493 |
+
"require": {
|
1494 |
+
"php": "^5.5.9|>=7.0.8",
|
1495 |
+
"symfony/debug": "~2.8|~3.0|~4.0",
|
1496 |
+
"symfony/polyfill-mbstring": "~1.0"
|
1497 |
+
},
|
1498 |
+
"conflict": {
|
1499 |
+
"symfony/dependency-injection": "<3.4",
|
1500 |
+
"symfony/process": "<3.3"
|
1501 |
+
},
|
1502 |
+
"provide": {
|
1503 |
+
"psr/log-implementation": "1.0"
|
1504 |
+
},
|
1505 |
+
"require-dev": {
|
1506 |
+
"psr/log": "~1.0",
|
1507 |
+
"symfony/config": "~3.3|~4.0",
|
1508 |
+
"symfony/dependency-injection": "~3.4|~4.0",
|
1509 |
+
"symfony/event-dispatcher": "~2.8|~3.0|~4.0",
|
1510 |
+
"symfony/lock": "~3.4|~4.0",
|
1511 |
+
"symfony/process": "~3.3|~4.0"
|
1512 |
+
},
|
1513 |
+
"suggest": {
|
1514 |
+
"psr/log": "For using the console logger",
|
1515 |
+
"symfony/event-dispatcher": "",
|
1516 |
+
"symfony/lock": "",
|
1517 |
+
"symfony/process": ""
|
1518 |
+
},
|
1519 |
+
"type": "library",
|
1520 |
+
"extra": {
|
1521 |
+
"branch-alias": {
|
1522 |
+
"dev-master": "3.4-dev"
|
1523 |
+
}
|
1524 |
+
},
|
1525 |
+
"autoload": {
|
1526 |
+
"psr-4": {
|
1527 |
+
"Symfony\\Component\\Console\\": ""
|
1528 |
+
},
|
1529 |
+
"exclude-from-classmap": [
|
1530 |
+
"/Tests/"
|
1531 |
+
]
|
1532 |
+
},
|
1533 |
+
"notification-url": "https://packagist.org/downloads/",
|
1534 |
+
"license": [
|
1535 |
+
"MIT"
|
1536 |
+
],
|
1537 |
+
"authors": [
|
1538 |
+
{
|
1539 |
+
"name": "Fabien Potencier",
|
1540 |
+
"email": "fabien@symfony.com"
|
1541 |
+
},
|
1542 |
+
{
|
1543 |
+
"name": "Symfony Community",
|
1544 |
+
"homepage": "https://symfony.com/contributors"
|
1545 |
+
}
|
1546 |
+
],
|
1547 |
+
"description": "Symfony Console Component",
|
1548 |
+
"homepage": "https://symfony.com",
|
1549 |
+
"time": "2019-04-08T09:29:13+00:00"
|
1550 |
+
},
|
1551 |
+
{
|
1552 |
+
"name": "symfony/debug",
|
1553 |
+
"version": "v3.4.26",
|
1554 |
+
"source": {
|
1555 |
+
"type": "git",
|
1556 |
+
"url": "https://github.com/symfony/debug.git",
|
1557 |
+
"reference": "681afbb26488903c5ac15e63734f1d8ac430c9b9"
|
1558 |
+
},
|
1559 |
+
"dist": {
|
1560 |
+
"type": "zip",
|
1561 |
+
"url": "https://api.github.com/repos/symfony/debug/zipball/681afbb26488903c5ac15e63734f1d8ac430c9b9",
|
1562 |
+
"reference": "681afbb26488903c5ac15e63734f1d8ac430c9b9",
|
1563 |
+
"shasum": ""
|
1564 |
+
},
|
1565 |
+
"require": {
|
1566 |
+
"php": "^5.5.9|>=7.0.8",
|
1567 |
+
"psr/log": "~1.0"
|
1568 |
+
},
|
1569 |
+
"conflict": {
|
1570 |
+
"symfony/http-kernel": ">=2.3,<2.3.24|~2.4.0|>=2.5,<2.5.9|>=2.6,<2.6.2"
|
1571 |
+
},
|
1572 |
+
"require-dev": {
|
1573 |
+
"symfony/http-kernel": "~2.8|~3.0|~4.0"
|
1574 |
+
},
|
1575 |
+
"type": "library",
|
1576 |
+
"extra": {
|
1577 |
+
"branch-alias": {
|
1578 |
+
"dev-master": "3.4-dev"
|
1579 |
+
}
|
1580 |
+
},
|
1581 |
+
"autoload": {
|
1582 |
+
"psr-4": {
|
1583 |
+
"Symfony\\Component\\Debug\\": ""
|
1584 |
+
},
|
1585 |
+
"exclude-from-classmap": [
|
1586 |
+
"/Tests/"
|
1587 |
+
]
|
1588 |
+
},
|
1589 |
+
"notification-url": "https://packagist.org/downloads/",
|
1590 |
+
"license": [
|
1591 |
+
"MIT"
|
1592 |
+
],
|
1593 |
+
"authors": [
|
1594 |
+
{
|
1595 |
+
"name": "Fabien Potencier",
|
1596 |
+
"email": "fabien@symfony.com"
|
1597 |
+
},
|
1598 |
+
{
|
1599 |
+
"name": "Symfony Community",
|
1600 |
+
"homepage": "https://symfony.com/contributors"
|
1601 |
+
}
|
1602 |
+
],
|
1603 |
+
"description": "Symfony Debug Component",
|
1604 |
+
"homepage": "https://symfony.com",
|
1605 |
+
"time": "2019-04-11T09:48:14+00:00"
|
1606 |
+
},
|
1607 |
+
{
|
1608 |
+
"name": "symfony/event-dispatcher",
|
1609 |
+
"version": "v3.4.26",
|
1610 |
+
"source": {
|
1611 |
+
"type": "git",
|
1612 |
+
"url": "https://github.com/symfony/event-dispatcher.git",
|
1613 |
+
"reference": "a088aafcefb4eef2520a290ed82e4374092a6dff"
|
1614 |
+
},
|
1615 |
+
"dist": {
|
1616 |
+
"type": "zip",
|
1617 |
+
"url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/a088aafcefb4eef2520a290ed82e4374092a6dff",
|
1618 |
+
"reference": "a088aafcefb4eef2520a290ed82e4374092a6dff",
|
1619 |
+
"shasum": ""
|
1620 |
+
},
|
1621 |
+
"require": {
|
1622 |
+
"php": "^5.5.9|>=7.0.8"
|
1623 |
+
},
|
1624 |
+
"conflict": {
|
1625 |
+
"symfony/dependency-injection": "<3.3"
|
1626 |
+
},
|
1627 |
+
"require-dev": {
|
1628 |
+
"psr/log": "~1.0",
|
1629 |
+
"symfony/config": "~2.8|~3.0|~4.0",
|
1630 |
+
"symfony/dependency-injection": "~3.3|~4.0",
|
1631 |
+
"symfony/expression-language": "~2.8|~3.0|~4.0",
|
1632 |
+
"symfony/stopwatch": "~2.8|~3.0|~4.0"
|
1633 |
+
},
|
1634 |
+
"suggest": {
|
1635 |
+
"symfony/dependency-injection": "",
|
1636 |
+
"symfony/http-kernel": ""
|
1637 |
+
},
|
1638 |
+
"type": "library",
|
1639 |
+
"extra": {
|
1640 |
+
"branch-alias": {
|
1641 |
+
"dev-master": "3.4-dev"
|
1642 |
+
}
|
1643 |
+
},
|
1644 |
+
"autoload": {
|
1645 |
+
"psr-4": {
|
1646 |
+
"Symfony\\Component\\EventDispatcher\\": ""
|
1647 |
+
},
|
1648 |
+
"exclude-from-classmap": [
|
1649 |
+
"/Tests/"
|
1650 |
+
]
|
1651 |
+
},
|
1652 |
+
"notification-url": "https://packagist.org/downloads/",
|
1653 |
+
"license": [
|
1654 |
+
"MIT"
|
1655 |
+
],
|
1656 |
+
"authors": [
|
1657 |
+
{
|
1658 |
+
"name": "Fabien Potencier",
|
1659 |
+
"email": "fabien@symfony.com"
|
1660 |
+
},
|
1661 |
+
{
|
1662 |
+
"name": "Symfony Community",
|
1663 |
+
"homepage": "https://symfony.com/contributors"
|
1664 |
+
}
|
1665 |
+
],
|
1666 |
+
"description": "Symfony EventDispatcher Component",
|
1667 |
+
"homepage": "https://symfony.com",
|
1668 |
+
"time": "2019-04-02T08:51:52+00:00"
|
1669 |
+
},
|
1670 |
+
{
|
1671 |
+
"name": "symfony/filesystem",
|
1672 |
+
"version": "v3.4.26",
|
1673 |
+
"source": {
|
1674 |
+
"type": "git",
|
1675 |
+
"url": "https://github.com/symfony/filesystem.git",
|
1676 |
+
"reference": "acf99758b1df8e9295e6b85aa69f294565c9fedb"
|
1677 |
+
},
|
1678 |
+
"dist": {
|
1679 |
+
"type": "zip",
|
1680 |
+
"url": "https://api.github.com/repos/symfony/filesystem/zipball/acf99758b1df8e9295e6b85aa69f294565c9fedb",
|
1681 |
+
"reference": "acf99758b1df8e9295e6b85aa69f294565c9fedb",
|
1682 |
+
"shasum": ""
|
1683 |
+
},
|
1684 |
+
"require": {
|
1685 |
+
"php": "^5.5.9|>=7.0.8",
|
1686 |
+
"symfony/polyfill-ctype": "~1.8"
|
1687 |
+
},
|
1688 |
+
"type": "library",
|
1689 |
+
"extra": {
|
1690 |
+
"branch-alias": {
|
1691 |
+
"dev-master": "3.4-dev"
|
1692 |
+
}
|
1693 |
+
},
|
1694 |
+
"autoload": {
|
1695 |
+
"psr-4": {
|
1696 |
+
"Symfony\\Component\\Filesystem\\": ""
|
1697 |
+
},
|
1698 |
+
"exclude-from-classmap": [
|
1699 |
+
"/Tests/"
|
1700 |
+
]
|
1701 |
+
},
|
1702 |
+
"notification-url": "https://packagist.org/downloads/",
|
1703 |
+
"license": [
|
1704 |
+
"MIT"
|
1705 |
+
],
|
1706 |
+
"authors": [
|
1707 |
+
{
|
1708 |
+
"name": "Fabien Potencier",
|
1709 |
+
"email": "fabien@symfony.com"
|
1710 |
+
},
|
1711 |
+
{
|
1712 |
+
"name": "Symfony Community",
|
1713 |
+
"homepage": "https://symfony.com/contributors"
|
1714 |
+
}
|
1715 |
+
],
|
1716 |
+
"description": "Symfony Filesystem Component",
|
1717 |
+
"homepage": "https://symfony.com",
|
1718 |
+
"time": "2019-02-04T21:34:32+00:00"
|
1719 |
+
},
|
1720 |
+
{
|
1721 |
+
"name": "symfony/finder",
|
1722 |
+
"version": "v3.4.26",
|
1723 |
+
"source": {
|
1724 |
+
"type": "git",
|
1725 |
+
"url": "https://github.com/symfony/finder.git",
|
1726 |
+
"reference": "61af5ce0b34b942d414fe8f1b11950d0e9a90e98"
|
1727 |
+
},
|
1728 |
+
"dist": {
|
1729 |
+
"type": "zip",
|
1730 |
+
"url": "https://api.github.com/repos/symfony/finder/zipball/61af5ce0b34b942d414fe8f1b11950d0e9a90e98",
|
1731 |
+
"reference": "61af5ce0b34b942d414fe8f1b11950d0e9a90e98",
|
1732 |
+
"shasum": ""
|
1733 |
+
},
|
1734 |
+
"require": {
|
1735 |
+
"php": "^5.5.9|>=7.0.8"
|
1736 |
+
},
|
1737 |
+
"type": "library",
|
1738 |
+
"extra": {
|
1739 |
+
"branch-alias": {
|
1740 |
+
"dev-master": "3.4-dev"
|
1741 |
+
}
|
1742 |
+
},
|
1743 |
+
"autoload": {
|
1744 |
+
"psr-4": {
|
1745 |
+
"Symfony\\Component\\Finder\\": ""
|
1746 |
+
},
|
1747 |
+
"exclude-from-classmap": [
|
1748 |
+
"/Tests/"
|
1749 |
+
]
|
1750 |
+
},
|
1751 |
+
"notification-url": "https://packagist.org/downloads/",
|
1752 |
+
"license": [
|
1753 |
+
"MIT"
|
1754 |
+
],
|
1755 |
+
"authors": [
|
1756 |
+
{
|
1757 |
+
"name": "Fabien Potencier",
|
1758 |
+
"email": "fabien@symfony.com"
|
1759 |
+
},
|
1760 |
+
{
|
1761 |
+
"name": "Symfony Community",
|
1762 |
+
"homepage": "https://symfony.com/contributors"
|
1763 |
+
}
|
1764 |
+
],
|
1765 |
+
"description": "Symfony Finder Component",
|
1766 |
+
"homepage": "https://symfony.com",
|
1767 |
+
"time": "2019-04-02T19:54:57+00:00"
|
1768 |
+
},
|
1769 |
+
{
|
1770 |
+
"name": "symfony/polyfill-ctype",
|
1771 |
+
"version": "v1.11.0",
|
1772 |
+
"source": {
|
1773 |
+
"type": "git",
|
1774 |
+
"url": "https://github.com/symfony/polyfill-ctype.git",
|
1775 |
+
"reference": "82ebae02209c21113908c229e9883c419720738a"
|
1776 |
+
},
|
1777 |
+
"dist": {
|
1778 |
+
"type": "zip",
|
1779 |
+
"url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/82ebae02209c21113908c229e9883c419720738a",
|
1780 |
+
"reference": "82ebae02209c21113908c229e9883c419720738a",
|
1781 |
+
"shasum": ""
|
1782 |
+
},
|
1783 |
+
"require": {
|
1784 |
+
"php": ">=5.3.3"
|
1785 |
+
},
|
1786 |
+
"suggest": {
|
1787 |
+
"ext-ctype": "For best performance"
|
1788 |
+
},
|
1789 |
+
"type": "library",
|
1790 |
+
"extra": {
|
1791 |
+
"branch-alias": {
|
1792 |
+
"dev-master": "1.11-dev"
|
1793 |
+
}
|
1794 |
+
},
|
1795 |
+
"autoload": {
|
1796 |
+
"psr-4": {
|
1797 |
+
"Symfony\\Polyfill\\Ctype\\": ""
|
1798 |
+
},
|
1799 |
+
"files": [
|
1800 |
+
"bootstrap.php"
|
1801 |
+
]
|
1802 |
+
},
|
1803 |
+
"notification-url": "https://packagist.org/downloads/",
|
1804 |
+
"license": [
|
1805 |
+
"MIT"
|
1806 |
+
],
|
1807 |
+
"authors": [
|
1808 |
+
{
|
1809 |
+
"name": "Symfony Community",
|
1810 |
+
"homepage": "https://symfony.com/contributors"
|
1811 |
+
},
|
1812 |
+
{
|
1813 |
+
"name": "Gert de Pagter",
|
1814 |
+
"email": "backendtea@gmail.com"
|
1815 |
+
}
|
1816 |
+
],
|
1817 |
+
"description": "Symfony polyfill for ctype functions",
|
1818 |
+
"homepage": "https://symfony.com",
|
1819 |
+
"keywords": [
|
1820 |
+
"compatibility",
|
1821 |
+
"ctype",
|
1822 |
+
"polyfill",
|
1823 |
+
"portable"
|
1824 |
+
],
|
1825 |
+
"time": "2019-02-06T07:57:58+00:00"
|
1826 |
+
},
|
1827 |
+
{
|
1828 |
+
"name": "symfony/polyfill-mbstring",
|
1829 |
+
"version": "v1.11.0",
|
1830 |
+
"source": {
|
1831 |
+
"type": "git",
|
1832 |
+
"url": "https://github.com/symfony/polyfill-mbstring.git",
|
1833 |
+
"reference": "fe5e94c604826c35a32fa832f35bd036b6799609"
|
1834 |
+
},
|
1835 |
+
"dist": {
|
1836 |
+
"type": "zip",
|
1837 |
+
"url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/fe5e94c604826c35a32fa832f35bd036b6799609",
|
1838 |
+
"reference": "fe5e94c604826c35a32fa832f35bd036b6799609",
|
1839 |
+
"shasum": ""
|
1840 |
+
},
|
1841 |
+
"require": {
|
1842 |
+
"php": ">=5.3.3"
|
1843 |
+
},
|
1844 |
+
"suggest": {
|
1845 |
+
"ext-mbstring": "For best performance"
|
1846 |
+
},
|
1847 |
+
"type": "library",
|
1848 |
+
"extra": {
|
1849 |
+
"branch-alias": {
|
1850 |
+
"dev-master": "1.11-dev"
|
1851 |
+
}
|
1852 |
+
},
|
1853 |
+
"autoload": {
|
1854 |
+
"psr-4": {
|
1855 |
+
"Symfony\\Polyfill\\Mbstring\\": ""
|
1856 |
+
},
|
1857 |
+
"files": [
|
1858 |
+
"bootstrap.php"
|
1859 |
+
]
|
1860 |
+
},
|
1861 |
+
"notification-url": "https://packagist.org/downloads/",
|
1862 |
+
"license": [
|
1863 |
+
"MIT"
|
1864 |
+
],
|
1865 |
+
"authors": [
|
1866 |
+
{
|
1867 |
+
"name": "Nicolas Grekas",
|
1868 |
+
"email": "p@tchwork.com"
|
1869 |
+
},
|
1870 |
+
{
|
1871 |
+
"name": "Symfony Community",
|
1872 |
+
"homepage": "https://symfony.com/contributors"
|
1873 |
+
}
|
1874 |
+
],
|
1875 |
+
"description": "Symfony polyfill for the Mbstring extension",
|
1876 |
+
"homepage": "https://symfony.com",
|
1877 |
+
"keywords": [
|
1878 |
+
"compatibility",
|
1879 |
+
"mbstring",
|
1880 |
+
"polyfill",
|
1881 |
+
"portable",
|
1882 |
+
"shim"
|
1883 |
+
],
|
1884 |
+
"time": "2019-02-06T07:57:58+00:00"
|
1885 |
+
},
|
1886 |
+
{
|
1887 |
+
"name": "symfony/process",
|
1888 |
+
"version": "v3.4.26",
|
1889 |
+
"source": {
|
1890 |
+
"type": "git",
|
1891 |
+
"url": "https://github.com/symfony/process.git",
|
1892 |
+
"reference": "a9c4dfbf653023b668c282e4e02609d131f4057a"
|
1893 |
+
},
|
1894 |
+
"dist": {
|
1895 |
+
"type": "zip",
|
1896 |
+
"url": "https://api.github.com/repos/symfony/process/zipball/a9c4dfbf653023b668c282e4e02609d131f4057a",
|
1897 |
+
"reference": "a9c4dfbf653023b668c282e4e02609d131f4057a",
|
1898 |
+
"shasum": ""
|
1899 |
+
},
|
1900 |
+
"require": {
|
1901 |
+
"php": "^5.5.9|>=7.0.8"
|
1902 |
+
},
|
1903 |
+
"type": "library",
|
1904 |
+
"extra": {
|
1905 |
+
"branch-alias": {
|
1906 |
+
"dev-master": "3.4-dev"
|
1907 |
+
}
|
1908 |
+
},
|
1909 |
+
"autoload": {
|
1910 |
+
"psr-4": {
|
1911 |
+
"Symfony\\Component\\Process\\": ""
|
1912 |
+
},
|
1913 |
+
"exclude-from-classmap": [
|
1914 |
+
"/Tests/"
|
1915 |
+
]
|
1916 |
+
},
|
1917 |
+
"notification-url": "https://packagist.org/downloads/",
|
1918 |
+
"license": [
|
1919 |
+
"MIT"
|
1920 |
+
],
|
1921 |
+
"authors": [
|
1922 |
+
{
|
1923 |
+
"name": "Fabien Potencier",
|
1924 |
+
"email": "fabien@symfony.com"
|
1925 |
+
},
|
1926 |
+
{
|
1927 |
+
"name": "Symfony Community",
|
1928 |
+
"homepage": "https://symfony.com/contributors"
|
1929 |
+
}
|
1930 |
+
],
|
1931 |
+
"description": "Symfony Process Component",
|
1932 |
+
"homepage": "https://symfony.com",
|
1933 |
+
"time": "2019-04-08T16:15:54+00:00"
|
1934 |
+
},
|
1935 |
+
{
|
1936 |
+
"name": "symfony/stopwatch",
|
1937 |
+
"version": "v3.4.26",
|
1938 |
+
"source": {
|
1939 |
+
"type": "git",
|
1940 |
+
"url": "https://github.com/symfony/stopwatch.git",
|
1941 |
+
"reference": "2a651c2645c10bbedd21170771f122d935e0dd58"
|
1942 |
+
},
|
1943 |
+
"dist": {
|
1944 |
+
"type": "zip",
|
1945 |
+
"url": "https://api.github.com/repos/symfony/stopwatch/zipball/2a651c2645c10bbedd21170771f122d935e0dd58",
|
1946 |
+
"reference": "2a651c2645c10bbedd21170771f122d935e0dd58",
|
1947 |
+
"shasum": ""
|
1948 |
+
},
|
1949 |
+
"require": {
|
1950 |
+
"php": "^5.5.9|>=7.0.8"
|
1951 |
+
},
|
1952 |
+
"type": "library",
|
1953 |
+
"extra": {
|
1954 |
+
"branch-alias": {
|
1955 |
+
"dev-master": "3.4-dev"
|
1956 |
+
}
|
1957 |
+
},
|
1958 |
+
"autoload": {
|
1959 |
+
"psr-4": {
|
1960 |
+
"Symfony\\Component\\Stopwatch\\": ""
|
1961 |
+
},
|
1962 |
+
"exclude-from-classmap": [
|
1963 |
+
"/Tests/"
|
1964 |
+
]
|
1965 |
+
},
|
1966 |
+
"notification-url": "https://packagist.org/downloads/",
|
1967 |
+
"license": [
|
1968 |
+
"MIT"
|
1969 |
+
],
|
1970 |
+
"authors": [
|
1971 |
+
{
|
1972 |
+
"name": "Fabien Potencier",
|
1973 |
+
"email": "fabien@symfony.com"
|
1974 |
+
},
|
1975 |
+
{
|
1976 |
+
"name": "Symfony Community",
|
1977 |
+
"homepage": "https://symfony.com/contributors"
|
1978 |
+
}
|
1979 |
+
],
|
1980 |
+
"description": "Symfony Stopwatch Component",
|
1981 |
+
"homepage": "https://symfony.com",
|
1982 |
+
"time": "2019-01-16T09:39:14+00:00"
|
1983 |
+
},
|
1984 |
+
{
|
1985 |
+
"name": "symfony/yaml",
|
1986 |
+
"version": "v3.4.26",
|
1987 |
+
"source": {
|
1988 |
+
"type": "git",
|
1989 |
+
"url": "https://github.com/symfony/yaml.git",
|
1990 |
+
"reference": "212a27b731e5bfb735679d1ffaac82bd6a1dc996"
|
1991 |
+
},
|
1992 |
+
"dist": {
|
1993 |
+
"type": "zip",
|
1994 |
+
"url": "https://api.github.com/repos/symfony/yaml/zipball/212a27b731e5bfb735679d1ffaac82bd6a1dc996",
|
1995 |
+
"reference": "212a27b731e5bfb735679d1ffaac82bd6a1dc996",
|
1996 |
+
"shasum": ""
|
1997 |
+
},
|
1998 |
+
"require": {
|
1999 |
+
"php": "^5.5.9|>=7.0.8",
|
2000 |
+
"symfony/polyfill-ctype": "~1.8"
|
2001 |
+
},
|
2002 |
+
"conflict": {
|
2003 |
+
"symfony/console": "<3.4"
|
2004 |
+
},
|
2005 |
+
"require-dev": {
|
2006 |
+
"symfony/console": "~3.4|~4.0"
|
2007 |
+
},
|
2008 |
+
"suggest": {
|
2009 |
+
"symfony/console": "For validating YAML files using the lint command"
|
2010 |
+
},
|
2011 |
+
"type": "library",
|
2012 |
+
"extra": {
|
2013 |
+
"branch-alias": {
|
2014 |
+
"dev-master": "3.4-dev"
|
2015 |
+
}
|
2016 |
+
},
|
2017 |
+
"autoload": {
|
2018 |
+
"psr-4": {
|
2019 |
+
"Symfony\\Component\\Yaml\\": ""
|
2020 |
+
},
|
2021 |
+
"exclude-from-classmap": [
|
2022 |
+
"/Tests/"
|
2023 |
+
]
|
2024 |
+
},
|
2025 |
+
"notification-url": "https://packagist.org/downloads/",
|
2026 |
+
"license": [
|
2027 |
+
"MIT"
|
2028 |
+
],
|
2029 |
+
"authors": [
|
2030 |
+
{
|
2031 |
+
"name": "Fabien Potencier",
|
2032 |
+
"email": "fabien@symfony.com"
|
2033 |
+
},
|
2034 |
+
{
|
2035 |
+
"name": "Symfony Community",
|
2036 |
+
"homepage": "https://symfony.com/contributors"
|
2037 |
+
}
|
2038 |
+
],
|
2039 |
+
"description": "Symfony Yaml Component",
|
2040 |
+
"homepage": "https://symfony.com",
|
2041 |
+
"time": "2019-03-25T07:48:46+00:00"
|
2042 |
+
},
|
2043 |
+
{
|
2044 |
+
"name": "webmozart/assert",
|
2045 |
+
"version": "1.4.0",
|
2046 |
+
"source": {
|
2047 |
+
"type": "git",
|
2048 |
+
"url": "https://github.com/webmozart/assert.git",
|
2049 |
+
"reference": "83e253c8e0be5b0257b881e1827274667c5c17a9"
|
2050 |
+
},
|
2051 |
+
"dist": {
|
2052 |
+
"type": "zip",
|
2053 |
+
"url": "https://api.github.com/repos/webmozart/assert/zipball/83e253c8e0be5b0257b881e1827274667c5c17a9",
|
2054 |
+
"reference": "83e253c8e0be5b0257b881e1827274667c5c17a9",
|
2055 |
+
"shasum": ""
|
2056 |
+
},
|
2057 |
+
"require": {
|
2058 |
+
"php": "^5.3.3 || ^7.0",
|
2059 |
+
"symfony/polyfill-ctype": "^1.8"
|
2060 |
+
},
|
2061 |
+
"require-dev": {
|
2062 |
+
"phpunit/phpunit": "^4.6",
|
2063 |
+
"sebastian/version": "^1.0.1"
|
2064 |
+
},
|
2065 |
+
"type": "library",
|
2066 |
+
"extra": {
|
2067 |
+
"branch-alias": {
|
2068 |
+
"dev-master": "1.3-dev"
|
2069 |
+
}
|
2070 |
+
},
|
2071 |
+
"autoload": {
|
2072 |
+
"psr-4": {
|
2073 |
+
"Webmozart\\Assert\\": "src/"
|
2074 |
+
}
|
2075 |
+
},
|
2076 |
+
"notification-url": "https://packagist.org/downloads/",
|
2077 |
+
"license": [
|
2078 |
+
"MIT"
|
2079 |
+
],
|
2080 |
+
"authors": [
|
2081 |
+
{
|
2082 |
+
"name": "Bernhard Schussek",
|
2083 |
+
"email": "bschussek@gmail.com"
|
2084 |
+
}
|
2085 |
+
],
|
2086 |
+
"description": "Assertions to validate method input/output with nice error messages.",
|
2087 |
+
"keywords": [
|
2088 |
+
"assert",
|
2089 |
+
"check",
|
2090 |
+
"validate"
|
2091 |
+
],
|
2092 |
+
"time": "2018-12-25T11:19:39+00:00"
|
2093 |
+
}
|
2094 |
+
],
|
2095 |
+
"aliases": [],
|
2096 |
+
"minimum-stability": "stable",
|
2097 |
+
"stability-flags": [],
|
2098 |
+
"prefer-stable": false,
|
2099 |
+
"prefer-lowest": false,
|
2100 |
+
"platform": {
|
2101 |
+
"php": ">=5.6",
|
2102 |
+
"ext-curl": "*",
|
2103 |
+
"ext-json": "*",
|
2104 |
+
"ext-mbstring": "*"
|
2105 |
+
},
|
2106 |
+
"platform-dev": []
|
2107 |
+
}
|
Postman/Postman-Mail/sendinblue/docs/Api/AccountApi.md
ADDED
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\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 |
+
# **getAccount**
|
11 |
+
> \SendinBlue\Client\Model\GetAccount getAccount()
|
12 |
+
|
13 |
+
Get your account information, plan and credits details
|
14 |
+
|
15 |
+
### Example
|
16 |
+
```php
|
17 |
+
<?php
|
18 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
19 |
+
|
20 |
+
// Configure API key authorization: api-key
|
21 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
22 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
23 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
24 |
+
// Configure API key authorization: partner-key
|
25 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
26 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
27 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
28 |
+
|
29 |
+
$apiInstance = new SendinBlue\Client\Api\AccountApi(
|
30 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
31 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
32 |
+
new GuzzleHttp\Client(),
|
33 |
+
$config
|
34 |
+
);
|
35 |
+
|
36 |
+
try {
|
37 |
+
$result = $apiInstance->getAccount();
|
38 |
+
print_r($result);
|
39 |
+
} catch (Exception $e) {
|
40 |
+
echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
|
41 |
+
}
|
42 |
+
?>
|
43 |
+
```
|
44 |
+
|
45 |
+
### Parameters
|
46 |
+
This endpoint does not need any parameter.
|
47 |
+
|
48 |
+
### Return type
|
49 |
+
|
50 |
+
[**\SendinBlue\Client\Model\GetAccount**](../Model/GetAccount.md)
|
51 |
+
|
52 |
+
### Authorization
|
53 |
+
|
54 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
55 |
+
|
56 |
+
### HTTP request headers
|
57 |
+
|
58 |
+
- **Content-Type**: application/json
|
59 |
+
- **Accept**: application/json
|
60 |
+
|
61 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
62 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/AttributesApi.md
ADDED
@@ -0,0 +1,243 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\AttributesApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
8 |
+
[**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
9 |
+
[**getAttributes**](AttributesApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
|
10 |
+
[**updateAttribute**](AttributesApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
11 |
+
|
12 |
+
|
13 |
+
# **createAttribute**
|
14 |
+
> createAttribute($attributeCategory, $attributeName, $createAttribute)
|
15 |
+
|
16 |
+
Create contact attribute
|
17 |
+
|
18 |
+
### Example
|
19 |
+
```php
|
20 |
+
<?php
|
21 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
22 |
+
|
23 |
+
// Configure API key authorization: api-key
|
24 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
25 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
26 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
27 |
+
// Configure API key authorization: partner-key
|
28 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
29 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
30 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
31 |
+
|
32 |
+
$apiInstance = new SendinBlue\Client\Api\AttributesApi(
|
33 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
34 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
35 |
+
new GuzzleHttp\Client(),
|
36 |
+
$config
|
37 |
+
);
|
38 |
+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
39 |
+
$attributeName = "attributeName_example"; // string | Name of the attribute
|
40 |
+
$createAttribute = new \SendinBlue\Client\Model\CreateAttribute(); // \SendinBlue\Client\Model\CreateAttribute | Values to create an attribute
|
41 |
+
|
42 |
+
try {
|
43 |
+
$apiInstance->createAttribute($attributeCategory, $attributeName, $createAttribute);
|
44 |
+
} catch (Exception $e) {
|
45 |
+
echo 'Exception when calling AttributesApi->createAttribute: ', $e->getMessage(), PHP_EOL;
|
46 |
+
}
|
47 |
+
?>
|
48 |
+
```
|
49 |
+
|
50 |
+
### Parameters
|
51 |
+
|
52 |
+
Name | Type | Description | Notes
|
53 |
+
------------- | ------------- | ------------- | -------------
|
54 |
+
**attributeCategory** | **string**| Category of the attribute |
|
55 |
+
**attributeName** | **string**| Name of the attribute |
|
56 |
+
**createAttribute** | [**\SendinBlue\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute |
|
57 |
+
|
58 |
+
### Return type
|
59 |
+
|
60 |
+
void (empty response body)
|
61 |
+
|
62 |
+
### Authorization
|
63 |
+
|
64 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
65 |
+
|
66 |
+
### HTTP request headers
|
67 |
+
|
68 |
+
- **Content-Type**: application/json
|
69 |
+
- **Accept**: application/json
|
70 |
+
|
71 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
72 |
+
|
73 |
+
# **deleteAttribute**
|
74 |
+
> deleteAttribute($attributeCategory, $attributeName)
|
75 |
+
|
76 |
+
Delete an attribute
|
77 |
+
|
78 |
+
### Example
|
79 |
+
```php
|
80 |
+
<?php
|
81 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
82 |
+
|
83 |
+
// Configure API key authorization: api-key
|
84 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
85 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
86 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
87 |
+
// Configure API key authorization: partner-key
|
88 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
89 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
90 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
91 |
+
|
92 |
+
$apiInstance = new SendinBlue\Client\Api\AttributesApi(
|
93 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
94 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
95 |
+
new GuzzleHttp\Client(),
|
96 |
+
$config
|
97 |
+
);
|
98 |
+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
99 |
+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
|
100 |
+
|
101 |
+
try {
|
102 |
+
$apiInstance->deleteAttribute($attributeCategory, $attributeName);
|
103 |
+
} catch (Exception $e) {
|
104 |
+
echo 'Exception when calling AttributesApi->deleteAttribute: ', $e->getMessage(), PHP_EOL;
|
105 |
+
}
|
106 |
+
?>
|
107 |
+
```
|
108 |
+
|
109 |
+
### Parameters
|
110 |
+
|
111 |
+
Name | Type | Description | Notes
|
112 |
+
------------- | ------------- | ------------- | -------------
|
113 |
+
**attributeCategory** | **string**| Category of the attribute |
|
114 |
+
**attributeName** | **string**| Name of the existing attribute |
|
115 |
+
|
116 |
+
### Return type
|
117 |
+
|
118 |
+
void (empty response body)
|
119 |
+
|
120 |
+
### Authorization
|
121 |
+
|
122 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
123 |
+
|
124 |
+
### HTTP request headers
|
125 |
+
|
126 |
+
- **Content-Type**: application/json
|
127 |
+
- **Accept**: application/json
|
128 |
+
|
129 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
130 |
+
|
131 |
+
# **getAttributes**
|
132 |
+
> \SendinBlue\Client\Model\GetAttributes getAttributes()
|
133 |
+
|
134 |
+
List all attributes
|
135 |
+
|
136 |
+
### Example
|
137 |
+
```php
|
138 |
+
<?php
|
139 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
140 |
+
|
141 |
+
// Configure API key authorization: api-key
|
142 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
143 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
144 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
145 |
+
// Configure API key authorization: partner-key
|
146 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
147 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
148 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
149 |
+
|
150 |
+
$apiInstance = new SendinBlue\Client\Api\AttributesApi(
|
151 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
152 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
153 |
+
new GuzzleHttp\Client(),
|
154 |
+
$config
|
155 |
+
);
|
156 |
+
|
157 |
+
try {
|
158 |
+
$result = $apiInstance->getAttributes();
|
159 |
+
print_r($result);
|
160 |
+
} catch (Exception $e) {
|
161 |
+
echo 'Exception when calling AttributesApi->getAttributes: ', $e->getMessage(), PHP_EOL;
|
162 |
+
}
|
163 |
+
?>
|
164 |
+
```
|
165 |
+
|
166 |
+
### Parameters
|
167 |
+
This endpoint does not need any parameter.
|
168 |
+
|
169 |
+
### Return type
|
170 |
+
|
171 |
+
[**\SendinBlue\Client\Model\GetAttributes**](../Model/GetAttributes.md)
|
172 |
+
|
173 |
+
### Authorization
|
174 |
+
|
175 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
176 |
+
|
177 |
+
### HTTP request headers
|
178 |
+
|
179 |
+
- **Content-Type**: application/json
|
180 |
+
- **Accept**: application/json
|
181 |
+
|
182 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
183 |
+
|
184 |
+
# **updateAttribute**
|
185 |
+
> updateAttribute($attributeCategory, $attributeName, $updateAttribute)
|
186 |
+
|
187 |
+
Update contact attribute
|
188 |
+
|
189 |
+
### Example
|
190 |
+
```php
|
191 |
+
<?php
|
192 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
193 |
+
|
194 |
+
// Configure API key authorization: api-key
|
195 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
196 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
197 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
198 |
+
// Configure API key authorization: partner-key
|
199 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
200 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
201 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
202 |
+
|
203 |
+
$apiInstance = new SendinBlue\Client\Api\AttributesApi(
|
204 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
205 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
206 |
+
new GuzzleHttp\Client(),
|
207 |
+
$config
|
208 |
+
);
|
209 |
+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
210 |
+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
|
211 |
+
$updateAttribute = new \SendinBlue\Client\Model\UpdateAttribute(); // \SendinBlue\Client\Model\UpdateAttribute | Values to update an attribute
|
212 |
+
|
213 |
+
try {
|
214 |
+
$apiInstance->updateAttribute($attributeCategory, $attributeName, $updateAttribute);
|
215 |
+
} catch (Exception $e) {
|
216 |
+
echo 'Exception when calling AttributesApi->updateAttribute: ', $e->getMessage(), PHP_EOL;
|
217 |
+
}
|
218 |
+
?>
|
219 |
+
```
|
220 |
+
|
221 |
+
### Parameters
|
222 |
+
|
223 |
+
Name | Type | Description | Notes
|
224 |
+
------------- | ------------- | ------------- | -------------
|
225 |
+
**attributeCategory** | **string**| Category of the attribute |
|
226 |
+
**attributeName** | **string**| Name of the existing attribute |
|
227 |
+
**updateAttribute** | [**\SendinBlue\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute |
|
228 |
+
|
229 |
+
### Return type
|
230 |
+
|
231 |
+
void (empty response body)
|
232 |
+
|
233 |
+
### Authorization
|
234 |
+
|
235 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
236 |
+
|
237 |
+
### HTTP request headers
|
238 |
+
|
239 |
+
- **Content-Type**: application/json
|
240 |
+
- **Accept**: application/json
|
241 |
+
|
242 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
243 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/CRMApi.md
ADDED
@@ -0,0 +1,760 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\CRMApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**crmFilesIdDataGet**](CRMApi.md#crmFilesIdDataGet) | **GET** /crm/files/{id}/data | Get file details
|
8 |
+
[**crmFilesIdDelete**](CRMApi.md#crmFilesIdDelete) | **DELETE** /crm/files/{id} | Delete a file
|
9 |
+
[**crmFilesIdGet**](CRMApi.md#crmFilesIdGet) | **GET** /crm/files/{id} | Download a file
|
10 |
+
[**crmFilesPost**](CRMApi.md#crmFilesPost) | **POST** /crm/files | Upload a file
|
11 |
+
[**crmNotesIdDelete**](CRMApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note
|
12 |
+
[**crmNotesIdGet**](CRMApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note
|
13 |
+
[**crmNotesIdPatch**](CRMApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note
|
14 |
+
[**crmNotesPost**](CRMApi.md#crmNotesPost) | **POST** /crm/notes | Create a note
|
15 |
+
[**crmTasksIdDelete**](CRMApi.md#crmTasksIdDelete) | **DELETE** /crm/tasks/{id} | Delete a task
|
16 |
+
[**crmTasksIdGet**](CRMApi.md#crmTasksIdGet) | **GET** /crm/tasks/{id} | Get a task
|
17 |
+
[**crmTasksIdPatch**](CRMApi.md#crmTasksIdPatch) | **PATCH** /crm/tasks/{id} | Update a task
|
18 |
+
[**crmTasksPost**](CRMApi.md#crmTasksPost) | **POST** /crm/tasks | Create a task
|
19 |
+
[**crmTasktypesGet**](CRMApi.md#crmTasktypesGet) | **GET** /crm/tasktypes | Get all task types
|
20 |
+
|
21 |
+
|
22 |
+
# **crmFilesIdDataGet**
|
23 |
+
> \SendinBlue\Client\Model\FileData crmFilesIdDataGet($id)
|
24 |
+
|
25 |
+
Get file details
|
26 |
+
|
27 |
+
### Example
|
28 |
+
```php
|
29 |
+
<?php
|
30 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
31 |
+
|
32 |
+
// Configure API key authorization: api-key
|
33 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
34 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
35 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
36 |
+
// Configure API key authorization: partner-key
|
37 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
38 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
39 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
40 |
+
|
41 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
42 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
43 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
44 |
+
new GuzzleHttp\Client(),
|
45 |
+
$config
|
46 |
+
);
|
47 |
+
$id = "id_example"; // string | File id to get file data.
|
48 |
+
|
49 |
+
try {
|
50 |
+
$result = $apiInstance->crmFilesIdDataGet($id);
|
51 |
+
print_r($result);
|
52 |
+
} catch (Exception $e) {
|
53 |
+
echo 'Exception when calling CRMApi->crmFilesIdDataGet: ', $e->getMessage(), PHP_EOL;
|
54 |
+
}
|
55 |
+
?>
|
56 |
+
```
|
57 |
+
|
58 |
+
### Parameters
|
59 |
+
|
60 |
+
Name | Type | Description | Notes
|
61 |
+
------------- | ------------- | ------------- | -------------
|
62 |
+
**id** | **string**| File id to get file data. |
|
63 |
+
|
64 |
+
### Return type
|
65 |
+
|
66 |
+
[**\SendinBlue\Client\Model\FileData**](../Model/FileData.md)
|
67 |
+
|
68 |
+
### Authorization
|
69 |
+
|
70 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
71 |
+
|
72 |
+
### HTTP request headers
|
73 |
+
|
74 |
+
- **Content-Type**: application/json
|
75 |
+
- **Accept**: application/json
|
76 |
+
|
77 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
78 |
+
|
79 |
+
# **crmFilesIdDelete**
|
80 |
+
> crmFilesIdDelete($id)
|
81 |
+
|
82 |
+
Delete a file
|
83 |
+
|
84 |
+
### Example
|
85 |
+
```php
|
86 |
+
<?php
|
87 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
88 |
+
|
89 |
+
// Configure API key authorization: api-key
|
90 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
91 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
92 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
93 |
+
// Configure API key authorization: partner-key
|
94 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
95 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
96 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
97 |
+
|
98 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
99 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
100 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
101 |
+
new GuzzleHttp\Client(),
|
102 |
+
$config
|
103 |
+
);
|
104 |
+
$id = "id_example"; // string | File id to delete.
|
105 |
+
|
106 |
+
try {
|
107 |
+
$apiInstance->crmFilesIdDelete($id);
|
108 |
+
} catch (Exception $e) {
|
109 |
+
echo 'Exception when calling CRMApi->crmFilesIdDelete: ', $e->getMessage(), PHP_EOL;
|
110 |
+
}
|
111 |
+
?>
|
112 |
+
```
|
113 |
+
|
114 |
+
### Parameters
|
115 |
+
|
116 |
+
Name | Type | Description | Notes
|
117 |
+
------------- | ------------- | ------------- | -------------
|
118 |
+
**id** | **string**| File id to delete. |
|
119 |
+
|
120 |
+
### Return type
|
121 |
+
|
122 |
+
void (empty response body)
|
123 |
+
|
124 |
+
### Authorization
|
125 |
+
|
126 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
127 |
+
|
128 |
+
### HTTP request headers
|
129 |
+
|
130 |
+
- **Content-Type**: application/json
|
131 |
+
- **Accept**: application/json
|
132 |
+
|
133 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
134 |
+
|
135 |
+
# **crmFilesIdGet**
|
136 |
+
> crmFilesIdGet($id)
|
137 |
+
|
138 |
+
Download a file
|
139 |
+
|
140 |
+
### Example
|
141 |
+
```php
|
142 |
+
<?php
|
143 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
144 |
+
|
145 |
+
// Configure API key authorization: api-key
|
146 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
147 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
148 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
149 |
+
// Configure API key authorization: partner-key
|
150 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
151 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
152 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
153 |
+
|
154 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
155 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
156 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
157 |
+
new GuzzleHttp\Client(),
|
158 |
+
$config
|
159 |
+
);
|
160 |
+
$id = "id_example"; // string | File id to download.
|
161 |
+
|
162 |
+
try {
|
163 |
+
$apiInstance->crmFilesIdGet($id);
|
164 |
+
} catch (Exception $e) {
|
165 |
+
echo 'Exception when calling CRMApi->crmFilesIdGet: ', $e->getMessage(), PHP_EOL;
|
166 |
+
}
|
167 |
+
?>
|
168 |
+
```
|
169 |
+
|
170 |
+
### Parameters
|
171 |
+
|
172 |
+
Name | Type | Description | Notes
|
173 |
+
------------- | ------------- | ------------- | -------------
|
174 |
+
**id** | **string**| File id to download. |
|
175 |
+
|
176 |
+
### Return type
|
177 |
+
|
178 |
+
void (empty response body)
|
179 |
+
|
180 |
+
### Authorization
|
181 |
+
|
182 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
183 |
+
|
184 |
+
### HTTP request headers
|
185 |
+
|
186 |
+
- **Content-Type**: application/json
|
187 |
+
- **Accept**: application/json
|
188 |
+
|
189 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
190 |
+
|
191 |
+
# **crmFilesPost**
|
192 |
+
> \SendinBlue\Client\Model\FileData crmFilesPost($file, $dealsIds)
|
193 |
+
|
194 |
+
Upload a file
|
195 |
+
|
196 |
+
### Example
|
197 |
+
```php
|
198 |
+
<?php
|
199 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
200 |
+
|
201 |
+
// Configure API key authorization: api-key
|
202 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
203 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
204 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
205 |
+
// Configure API key authorization: partner-key
|
206 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
207 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
208 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
209 |
+
|
210 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
211 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
212 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
213 |
+
new GuzzleHttp\Client(),
|
214 |
+
$config
|
215 |
+
);
|
216 |
+
$file = "/path/to/file.txt"; // \SplFileObject | File data to create a file.
|
217 |
+
$dealsIds = array("dealsIds_example"); // string[] | Deal ids linked to a file
|
218 |
+
|
219 |
+
try {
|
220 |
+
$result = $apiInstance->crmFilesPost($file, $dealsIds);
|
221 |
+
print_r($result);
|
222 |
+
} catch (Exception $e) {
|
223 |
+
echo 'Exception when calling CRMApi->crmFilesPost: ', $e->getMessage(), PHP_EOL;
|
224 |
+
}
|
225 |
+
?>
|
226 |
+
```
|
227 |
+
|
228 |
+
### Parameters
|
229 |
+
|
230 |
+
Name | Type | Description | Notes
|
231 |
+
------------- | ------------- | ------------- | -------------
|
232 |
+
**file** | **\SplFileObject**| File data to create a file. |
|
233 |
+
**dealsIds** | [**string[]**](../Model/string.md)| Deal ids linked to a file | [optional]
|
234 |
+
|
235 |
+
### Return type
|
236 |
+
|
237 |
+
[**\SendinBlue\Client\Model\FileData**](../Model/FileData.md)
|
238 |
+
|
239 |
+
### Authorization
|
240 |
+
|
241 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
242 |
+
|
243 |
+
### HTTP request headers
|
244 |
+
|
245 |
+
- **Content-Type**: multipart/form-data
|
246 |
+
- **Accept**: application/json
|
247 |
+
|
248 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
249 |
+
|
250 |
+
# **crmNotesIdDelete**
|
251 |
+
> crmNotesIdDelete($id)
|
252 |
+
|
253 |
+
Delete a note
|
254 |
+
|
255 |
+
### Example
|
256 |
+
```php
|
257 |
+
<?php
|
258 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
259 |
+
|
260 |
+
// Configure API key authorization: api-key
|
261 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
262 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
263 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
264 |
+
// Configure API key authorization: partner-key
|
265 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
266 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
267 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
268 |
+
|
269 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
270 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
271 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
272 |
+
new GuzzleHttp\Client(),
|
273 |
+
$config
|
274 |
+
);
|
275 |
+
$id = "id_example"; // string | Note ID to delete
|
276 |
+
|
277 |
+
try {
|
278 |
+
$apiInstance->crmNotesIdDelete($id);
|
279 |
+
} catch (Exception $e) {
|
280 |
+
echo 'Exception when calling CRMApi->crmNotesIdDelete: ', $e->getMessage(), PHP_EOL;
|
281 |
+
}
|
282 |
+
?>
|
283 |
+
```
|
284 |
+
|
285 |
+
### Parameters
|
286 |
+
|
287 |
+
Name | Type | Description | Notes
|
288 |
+
------------- | ------------- | ------------- | -------------
|
289 |
+
**id** | **string**| Note ID to delete |
|
290 |
+
|
291 |
+
### Return type
|
292 |
+
|
293 |
+
void (empty response body)
|
294 |
+
|
295 |
+
### Authorization
|
296 |
+
|
297 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
298 |
+
|
299 |
+
### HTTP request headers
|
300 |
+
|
301 |
+
- **Content-Type**: application/json
|
302 |
+
- **Accept**: application/json
|
303 |
+
|
304 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
305 |
+
|
306 |
+
# **crmNotesIdGet**
|
307 |
+
> \SendinBlue\Client\Model\Note crmNotesIdGet($id)
|
308 |
+
|
309 |
+
Get a note
|
310 |
+
|
311 |
+
### Example
|
312 |
+
```php
|
313 |
+
<?php
|
314 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
315 |
+
|
316 |
+
// Configure API key authorization: api-key
|
317 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
318 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
319 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
320 |
+
// Configure API key authorization: partner-key
|
321 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
322 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
323 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
324 |
+
|
325 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
326 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
327 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
328 |
+
new GuzzleHttp\Client(),
|
329 |
+
$config
|
330 |
+
);
|
331 |
+
$id = "id_example"; // string | Note ID to get
|
332 |
+
|
333 |
+
try {
|
334 |
+
$result = $apiInstance->crmNotesIdGet($id);
|
335 |
+
print_r($result);
|
336 |
+
} catch (Exception $e) {
|
337 |
+
echo 'Exception when calling CRMApi->crmNotesIdGet: ', $e->getMessage(), PHP_EOL;
|
338 |
+
}
|
339 |
+
?>
|
340 |
+
```
|
341 |
+
|
342 |
+
### Parameters
|
343 |
+
|
344 |
+
Name | Type | Description | Notes
|
345 |
+
------------- | ------------- | ------------- | -------------
|
346 |
+
**id** | **string**| Note ID to get |
|
347 |
+
|
348 |
+
### Return type
|
349 |
+
|
350 |
+
[**\SendinBlue\Client\Model\Note**](../Model/Note.md)
|
351 |
+
|
352 |
+
### Authorization
|
353 |
+
|
354 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
355 |
+
|
356 |
+
### HTTP request headers
|
357 |
+
|
358 |
+
- **Content-Type**: application/json
|
359 |
+
- **Accept**: application/json
|
360 |
+
|
361 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
362 |
+
|
363 |
+
# **crmNotesIdPatch**
|
364 |
+
> \SendinBlue\Client\Model\Note crmNotesIdPatch($id, $body)
|
365 |
+
|
366 |
+
Update a note
|
367 |
+
|
368 |
+
### Example
|
369 |
+
```php
|
370 |
+
<?php
|
371 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
372 |
+
|
373 |
+
// Configure API key authorization: api-key
|
374 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
375 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
376 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
377 |
+
// Configure API key authorization: partner-key
|
378 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
379 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
380 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
381 |
+
|
382 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
383 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
384 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
385 |
+
new GuzzleHttp\Client(),
|
386 |
+
$config
|
387 |
+
);
|
388 |
+
$id = "id_example"; // string | Note ID to update
|
389 |
+
$body = new \SendinBlue\Client\Model\NoteData(); // \SendinBlue\Client\Model\NoteData | Note data to update a note
|
390 |
+
|
391 |
+
try {
|
392 |
+
$result = $apiInstance->crmNotesIdPatch($id, $body);
|
393 |
+
print_r($result);
|
394 |
+
} catch (Exception $e) {
|
395 |
+
echo 'Exception when calling CRMApi->crmNotesIdPatch: ', $e->getMessage(), PHP_EOL;
|
396 |
+
}
|
397 |
+
?>
|
398 |
+
```
|
399 |
+
|
400 |
+
### Parameters
|
401 |
+
|
402 |
+
Name | Type | Description | Notes
|
403 |
+
------------- | ------------- | ------------- | -------------
|
404 |
+
**id** | **string**| Note ID to update |
|
405 |
+
**body** | [**\SendinBlue\Client\Model\NoteData**](../Model/NoteData.md)| Note data to update a note |
|
406 |
+
|
407 |
+
### Return type
|
408 |
+
|
409 |
+
[**\SendinBlue\Client\Model\Note**](../Model/Note.md)
|
410 |
+
|
411 |
+
### Authorization
|
412 |
+
|
413 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
414 |
+
|
415 |
+
### HTTP request headers
|
416 |
+
|
417 |
+
- **Content-Type**: application/json
|
418 |
+
- **Accept**: application/json
|
419 |
+
|
420 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
421 |
+
|
422 |
+
# **crmNotesPost**
|
423 |
+
> \SendinBlue\Client\Model\Note crmNotesPost($body)
|
424 |
+
|
425 |
+
Create a note
|
426 |
+
|
427 |
+
### Example
|
428 |
+
```php
|
429 |
+
<?php
|
430 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
431 |
+
|
432 |
+
// Configure API key authorization: api-key
|
433 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
434 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
435 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
436 |
+
// Configure API key authorization: partner-key
|
437 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
438 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
439 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
440 |
+
|
441 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
442 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
443 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
444 |
+
new GuzzleHttp\Client(),
|
445 |
+
$config
|
446 |
+
);
|
447 |
+
$body = new \SendinBlue\Client\Model\NoteData(); // \SendinBlue\Client\Model\NoteData | Note data to create a note.
|
448 |
+
|
449 |
+
try {
|
450 |
+
$result = $apiInstance->crmNotesPost($body);
|
451 |
+
print_r($result);
|
452 |
+
} catch (Exception $e) {
|
453 |
+
echo 'Exception when calling CRMApi->crmNotesPost: ', $e->getMessage(), PHP_EOL;
|
454 |
+
}
|
455 |
+
?>
|
456 |
+
```
|
457 |
+
|
458 |
+
### Parameters
|
459 |
+
|
460 |
+
Name | Type | Description | Notes
|
461 |
+
------------- | ------------- | ------------- | -------------
|
462 |
+
**body** | [**\SendinBlue\Client\Model\NoteData**](../Model/NoteData.md)| Note data to create a note. |
|
463 |
+
|
464 |
+
### Return type
|
465 |
+
|
466 |
+
[**\SendinBlue\Client\Model\Note**](../Model/Note.md)
|
467 |
+
|
468 |
+
### Authorization
|
469 |
+
|
470 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
471 |
+
|
472 |
+
### HTTP request headers
|
473 |
+
|
474 |
+
- **Content-Type**: application/json
|
475 |
+
- **Accept**: application/json
|
476 |
+
|
477 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
478 |
+
|
479 |
+
# **crmTasksIdDelete**
|
480 |
+
> crmTasksIdDelete($id)
|
481 |
+
|
482 |
+
Delete a task
|
483 |
+
|
484 |
+
### Example
|
485 |
+
```php
|
486 |
+
<?php
|
487 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
488 |
+
|
489 |
+
// Configure API key authorization: api-key
|
490 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
491 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
492 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
493 |
+
// Configure API key authorization: partner-key
|
494 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
495 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
496 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
497 |
+
|
498 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
499 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
500 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
501 |
+
new GuzzleHttp\Client(),
|
502 |
+
$config
|
503 |
+
);
|
504 |
+
$id = "id_example"; // string |
|
505 |
+
|
506 |
+
try {
|
507 |
+
$apiInstance->crmTasksIdDelete($id);
|
508 |
+
} catch (Exception $e) {
|
509 |
+
echo 'Exception when calling CRMApi->crmTasksIdDelete: ', $e->getMessage(), PHP_EOL;
|
510 |
+
}
|
511 |
+
?>
|
512 |
+
```
|
513 |
+
|
514 |
+
### Parameters
|
515 |
+
|
516 |
+
Name | Type | Description | Notes
|
517 |
+
------------- | ------------- | ------------- | -------------
|
518 |
+
**id** | **string**| |
|
519 |
+
|
520 |
+
### Return type
|
521 |
+
|
522 |
+
void (empty response body)
|
523 |
+
|
524 |
+
### Authorization
|
525 |
+
|
526 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
527 |
+
|
528 |
+
### HTTP request headers
|
529 |
+
|
530 |
+
- **Content-Type**: application/json
|
531 |
+
- **Accept**: application/json
|
532 |
+
|
533 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
534 |
+
|
535 |
+
# **crmTasksIdGet**
|
536 |
+
> \SendinBlue\Client\Model\Task crmTasksIdGet($id)
|
537 |
+
|
538 |
+
Get a task
|
539 |
+
|
540 |
+
### Example
|
541 |
+
```php
|
542 |
+
<?php
|
543 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
544 |
+
|
545 |
+
// Configure API key authorization: api-key
|
546 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
547 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
548 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
549 |
+
// Configure API key authorization: partner-key
|
550 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
551 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
552 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
553 |
+
|
554 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
555 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
556 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
557 |
+
new GuzzleHttp\Client(),
|
558 |
+
$config
|
559 |
+
);
|
560 |
+
$id = "id_example"; // string |
|
561 |
+
|
562 |
+
try {
|
563 |
+
$result = $apiInstance->crmTasksIdGet($id);
|
564 |
+
print_r($result);
|
565 |
+
} catch (Exception $e) {
|
566 |
+
echo 'Exception when calling CRMApi->crmTasksIdGet: ', $e->getMessage(), PHP_EOL;
|
567 |
+
}
|
568 |
+
?>
|
569 |
+
```
|
570 |
+
|
571 |
+
### Parameters
|
572 |
+
|
573 |
+
Name | Type | Description | Notes
|
574 |
+
------------- | ------------- | ------------- | -------------
|
575 |
+
**id** | **string**| |
|
576 |
+
|
577 |
+
### Return type
|
578 |
+
|
579 |
+
[**\SendinBlue\Client\Model\Task**](../Model/Task.md)
|
580 |
+
|
581 |
+
### Authorization
|
582 |
+
|
583 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
584 |
+
|
585 |
+
### HTTP request headers
|
586 |
+
|
587 |
+
- **Content-Type**: application/json
|
588 |
+
- **Accept**: application/json
|
589 |
+
|
590 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
591 |
+
|
592 |
+
# **crmTasksIdPatch**
|
593 |
+
> \SendinBlue\Client\Model\Task crmTasksIdPatch($id, $body)
|
594 |
+
|
595 |
+
Update a task
|
596 |
+
|
597 |
+
### Example
|
598 |
+
```php
|
599 |
+
<?php
|
600 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
601 |
+
|
602 |
+
// Configure API key authorization: api-key
|
603 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
604 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
605 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
606 |
+
// Configure API key authorization: partner-key
|
607 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
608 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
609 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
610 |
+
|
611 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
612 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
613 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
614 |
+
new GuzzleHttp\Client(),
|
615 |
+
$config
|
616 |
+
);
|
617 |
+
$id = "id_example"; // string |
|
618 |
+
$body = new \SendinBlue\Client\Model\Body1(); // \SendinBlue\Client\Model\Body1 | Updated task details.
|
619 |
+
|
620 |
+
try {
|
621 |
+
$result = $apiInstance->crmTasksIdPatch($id, $body);
|
622 |
+
print_r($result);
|
623 |
+
} catch (Exception $e) {
|
624 |
+
echo 'Exception when calling CRMApi->crmTasksIdPatch: ', $e->getMessage(), PHP_EOL;
|
625 |
+
}
|
626 |
+
?>
|
627 |
+
```
|
628 |
+
|
629 |
+
### Parameters
|
630 |
+
|
631 |
+
Name | Type | Description | Notes
|
632 |
+
------------- | ------------- | ------------- | -------------
|
633 |
+
**id** | **string**| |
|
634 |
+
**body** | [**\SendinBlue\Client\Model\Body1**](../Model/Body1.md)| Updated task details. |
|
635 |
+
|
636 |
+
### Return type
|
637 |
+
|
638 |
+
[**\SendinBlue\Client\Model\Task**](../Model/Task.md)
|
639 |
+
|
640 |
+
### Authorization
|
641 |
+
|
642 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
643 |
+
|
644 |
+
### HTTP request headers
|
645 |
+
|
646 |
+
- **Content-Type**: application/json
|
647 |
+
- **Accept**: application/json
|
648 |
+
|
649 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
650 |
+
|
651 |
+
# **crmTasksPost**
|
652 |
+
> \SendinBlue\Client\Model\InlineResponse201 crmTasksPost($body)
|
653 |
+
|
654 |
+
Create a task
|
655 |
+
|
656 |
+
### Example
|
657 |
+
```php
|
658 |
+
<?php
|
659 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
660 |
+
|
661 |
+
// Configure API key authorization: api-key
|
662 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
663 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
664 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
665 |
+
// Configure API key authorization: partner-key
|
666 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
667 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
668 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
669 |
+
|
670 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
671 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
672 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
673 |
+
new GuzzleHttp\Client(),
|
674 |
+
$config
|
675 |
+
);
|
676 |
+
$body = new \SendinBlue\Client\Model\Body(); // \SendinBlue\Client\Model\Body | Task name.
|
677 |
+
|
678 |
+
try {
|
679 |
+
$result = $apiInstance->crmTasksPost($body);
|
680 |
+
print_r($result);
|
681 |
+
} catch (Exception $e) {
|
682 |
+
echo 'Exception when calling CRMApi->crmTasksPost: ', $e->getMessage(), PHP_EOL;
|
683 |
+
}
|
684 |
+
?>
|
685 |
+
```
|
686 |
+
|
687 |
+
### Parameters
|
688 |
+
|
689 |
+
Name | Type | Description | Notes
|
690 |
+
------------- | ------------- | ------------- | -------------
|
691 |
+
**body** | [**\SendinBlue\Client\Model\Body**](../Model/Body.md)| Task name. |
|
692 |
+
|
693 |
+
### Return type
|
694 |
+
|
695 |
+
[**\SendinBlue\Client\Model\InlineResponse201**](../Model/InlineResponse201.md)
|
696 |
+
|
697 |
+
### Authorization
|
698 |
+
|
699 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
700 |
+
|
701 |
+
### HTTP request headers
|
702 |
+
|
703 |
+
- **Content-Type**: application/json
|
704 |
+
- **Accept**: application/json
|
705 |
+
|
706 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
707 |
+
|
708 |
+
# **crmTasktypesGet**
|
709 |
+
> \SendinBlue\Client\Model\TaskTypes crmTasktypesGet()
|
710 |
+
|
711 |
+
Get all task types
|
712 |
+
|
713 |
+
### Example
|
714 |
+
```php
|
715 |
+
<?php
|
716 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
717 |
+
|
718 |
+
// Configure API key authorization: api-key
|
719 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
720 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
721 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
722 |
+
// Configure API key authorization: partner-key
|
723 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
724 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
725 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
726 |
+
|
727 |
+
$apiInstance = new SendinBlue\Client\Api\CRMApi(
|
728 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
729 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
730 |
+
new GuzzleHttp\Client(),
|
731 |
+
$config
|
732 |
+
);
|
733 |
+
|
734 |
+
try {
|
735 |
+
$result = $apiInstance->crmTasktypesGet();
|
736 |
+
print_r($result);
|
737 |
+
} catch (Exception $e) {
|
738 |
+
echo 'Exception when calling CRMApi->crmTasktypesGet: ', $e->getMessage(), PHP_EOL;
|
739 |
+
}
|
740 |
+
?>
|
741 |
+
```
|
742 |
+
|
743 |
+
### Parameters
|
744 |
+
This endpoint does not need any parameter.
|
745 |
+
|
746 |
+
### Return type
|
747 |
+
|
748 |
+
[**\SendinBlue\Client\Model\TaskTypes**](../Model/TaskTypes.md)
|
749 |
+
|
750 |
+
### Authorization
|
751 |
+
|
752 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
753 |
+
|
754 |
+
### HTTP request headers
|
755 |
+
|
756 |
+
- **Content-Type**: application/json
|
757 |
+
- **Accept**: application/json
|
758 |
+
|
759 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
760 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/ContactsApi.md
ADDED
@@ -0,0 +1,1675 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\ContactsApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**addContactToList**](ContactsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
8 |
+
[**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
9 |
+
[**createContact**](ContactsApi.md#createContact) | **POST** /contacts | Create a contact
|
10 |
+
[**createDoiContact**](ContactsApi.md#createDoiContact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
|
11 |
+
[**createFolder**](ContactsApi.md#createFolder) | **POST** /contacts/folders | Create a folder
|
12 |
+
[**createList**](ContactsApi.md#createList) | **POST** /contacts/lists | Create a list
|
13 |
+
[**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
14 |
+
[**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /contacts/{identifier} | Delete a contact
|
15 |
+
[**deleteFolder**](ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
16 |
+
[**deleteList**](ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
|
17 |
+
[**getAttributes**](ContactsApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
|
18 |
+
[**getContactInfo**](ContactsApi.md#getContactInfo) | **GET** /contacts/{identifier} | Get a contact's details
|
19 |
+
[**getContactStats**](ContactsApi.md#getContactStats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
|
20 |
+
[**getContacts**](ContactsApi.md#getContacts) | **GET** /contacts | Get all the contacts
|
21 |
+
[**getContactsFromList**](ContactsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
22 |
+
[**getFolder**](ContactsApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
23 |
+
[**getFolderLists**](ContactsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
24 |
+
[**getFolders**](ContactsApi.md#getFolders) | **GET** /contacts/folders | Get all folders
|
25 |
+
[**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details
|
26 |
+
[**getLists**](ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
|
27 |
+
[**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
|
28 |
+
[**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
29 |
+
[**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
|
30 |
+
[**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
31 |
+
[**updateBatchContacts**](ContactsApi.md#updateBatchContacts) | **POST** /contacts/batch | Update multiple contacts
|
32 |
+
[**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{identifier} | Update a contact
|
33 |
+
[**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
34 |
+
[**updateList**](ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
|
35 |
+
|
36 |
+
|
37 |
+
# **addContactToList**
|
38 |
+
> \SendinBlue\Client\Model\PostContactInfo addContactToList($listId, $contactEmails)
|
39 |
+
|
40 |
+
Add existing contacts to a list
|
41 |
+
|
42 |
+
### Example
|
43 |
+
```php
|
44 |
+
<?php
|
45 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
46 |
+
|
47 |
+
// Configure API key authorization: api-key
|
48 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
49 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
50 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
51 |
+
// Configure API key authorization: partner-key
|
52 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
53 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
54 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
55 |
+
|
56 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
57 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
58 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
59 |
+
new GuzzleHttp\Client(),
|
60 |
+
$config
|
61 |
+
);
|
62 |
+
$listId = 789; // int | Id of the list
|
63 |
+
$contactEmails = new \SendinBlue\Client\Model\AddContactToList(); // \SendinBlue\Client\Model\AddContactToList | Emails addresses OR IDs of the contacts
|
64 |
+
|
65 |
+
try {
|
66 |
+
$result = $apiInstance->addContactToList($listId, $contactEmails);
|
67 |
+
print_r($result);
|
68 |
+
} catch (Exception $e) {
|
69 |
+
echo 'Exception when calling ContactsApi->addContactToList: ', $e->getMessage(), PHP_EOL;
|
70 |
+
}
|
71 |
+
?>
|
72 |
+
```
|
73 |
+
|
74 |
+
### Parameters
|
75 |
+
|
76 |
+
Name | Type | Description | Notes
|
77 |
+
------------- | ------------- | ------------- | -------------
|
78 |
+
**listId** | **int**| Id of the list |
|
79 |
+
**contactEmails** | [**\SendinBlue\Client\Model\AddContactToList**](../Model/AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
80 |
+
|
81 |
+
### Return type
|
82 |
+
|
83 |
+
[**\SendinBlue\Client\Model\PostContactInfo**](../Model/PostContactInfo.md)
|
84 |
+
|
85 |
+
### Authorization
|
86 |
+
|
87 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
88 |
+
|
89 |
+
### HTTP request headers
|
90 |
+
|
91 |
+
- **Content-Type**: application/json
|
92 |
+
- **Accept**: application/json
|
93 |
+
|
94 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
95 |
+
|
96 |
+
# **createAttribute**
|
97 |
+
> createAttribute($attributeCategory, $attributeName, $createAttribute)
|
98 |
+
|
99 |
+
Create contact attribute
|
100 |
+
|
101 |
+
### Example
|
102 |
+
```php
|
103 |
+
<?php
|
104 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
105 |
+
|
106 |
+
// Configure API key authorization: api-key
|
107 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
108 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
109 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
110 |
+
// Configure API key authorization: partner-key
|
111 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
112 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
113 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
114 |
+
|
115 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
116 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
117 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
118 |
+
new GuzzleHttp\Client(),
|
119 |
+
$config
|
120 |
+
);
|
121 |
+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
122 |
+
$attributeName = "attributeName_example"; // string | Name of the attribute
|
123 |
+
$createAttribute = new \SendinBlue\Client\Model\CreateAttribute(); // \SendinBlue\Client\Model\CreateAttribute | Values to create an attribute
|
124 |
+
|
125 |
+
try {
|
126 |
+
$apiInstance->createAttribute($attributeCategory, $attributeName, $createAttribute);
|
127 |
+
} catch (Exception $e) {
|
128 |
+
echo 'Exception when calling ContactsApi->createAttribute: ', $e->getMessage(), PHP_EOL;
|
129 |
+
}
|
130 |
+
?>
|
131 |
+
```
|
132 |
+
|
133 |
+
### Parameters
|
134 |
+
|
135 |
+
Name | Type | Description | Notes
|
136 |
+
------------- | ------------- | ------------- | -------------
|
137 |
+
**attributeCategory** | **string**| Category of the attribute |
|
138 |
+
**attributeName** | **string**| Name of the attribute |
|
139 |
+
**createAttribute** | [**\SendinBlue\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute |
|
140 |
+
|
141 |
+
### Return type
|
142 |
+
|
143 |
+
void (empty response body)
|
144 |
+
|
145 |
+
### Authorization
|
146 |
+
|
147 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
148 |
+
|
149 |
+
### HTTP request headers
|
150 |
+
|
151 |
+
- **Content-Type**: application/json
|
152 |
+
- **Accept**: application/json
|
153 |
+
|
154 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
155 |
+
|
156 |
+
# **createContact**
|
157 |
+
> \SendinBlue\Client\Model\CreateUpdateContactModel createContact($createContact)
|
158 |
+
|
159 |
+
Create a contact
|
160 |
+
|
161 |
+
### Example
|
162 |
+
```php
|
163 |
+
<?php
|
164 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
165 |
+
|
166 |
+
// Configure API key authorization: api-key
|
167 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
168 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
169 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
170 |
+
// Configure API key authorization: partner-key
|
171 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
172 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
173 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
174 |
+
|
175 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
176 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
177 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
178 |
+
new GuzzleHttp\Client(),
|
179 |
+
$config
|
180 |
+
);
|
181 |
+
$createContact = new \SendinBlue\Client\Model\CreateContact(); // \SendinBlue\Client\Model\CreateContact | Values to create a contact
|
182 |
+
|
183 |
+
try {
|
184 |
+
$result = $apiInstance->createContact($createContact);
|
185 |
+
print_r($result);
|
186 |
+
} catch (Exception $e) {
|
187 |
+
echo 'Exception when calling ContactsApi->createContact: ', $e->getMessage(), PHP_EOL;
|
188 |
+
}
|
189 |
+
?>
|
190 |
+
```
|
191 |
+
|
192 |
+
### Parameters
|
193 |
+
|
194 |
+
Name | Type | Description | Notes
|
195 |
+
------------- | ------------- | ------------- | -------------
|
196 |
+
**createContact** | [**\SendinBlue\Client\Model\CreateContact**](../Model/CreateContact.md)| Values to create a contact |
|
197 |
+
|
198 |
+
### Return type
|
199 |
+
|
200 |
+
[**\SendinBlue\Client\Model\CreateUpdateContactModel**](../Model/CreateUpdateContactModel.md)
|
201 |
+
|
202 |
+
### Authorization
|
203 |
+
|
204 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
205 |
+
|
206 |
+
### HTTP request headers
|
207 |
+
|
208 |
+
- **Content-Type**: application/json
|
209 |
+
- **Accept**: application/json
|
210 |
+
|
211 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
212 |
+
|
213 |
+
# **createDoiContact**
|
214 |
+
> createDoiContact($createDoiContact)
|
215 |
+
|
216 |
+
Create Contact via DOI (Double-Opt-In) Flow
|
217 |
+
|
218 |
+
### Example
|
219 |
+
```php
|
220 |
+
<?php
|
221 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
222 |
+
|
223 |
+
// Configure API key authorization: api-key
|
224 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
225 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
226 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
227 |
+
// Configure API key authorization: partner-key
|
228 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
229 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
230 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
231 |
+
|
232 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
233 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
234 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
235 |
+
new GuzzleHttp\Client(),
|
236 |
+
$config
|
237 |
+
);
|
238 |
+
$createDoiContact = new \SendinBlue\Client\Model\CreateDoiContact(); // \SendinBlue\Client\Model\CreateDoiContact | Values to create the Double opt-in (DOI) contact
|
239 |
+
|
240 |
+
try {
|
241 |
+
$apiInstance->createDoiContact($createDoiContact);
|
242 |
+
} catch (Exception $e) {
|
243 |
+
echo 'Exception when calling ContactsApi->createDoiContact: ', $e->getMessage(), PHP_EOL;
|
244 |
+
}
|
245 |
+
?>
|
246 |
+
```
|
247 |
+
|
248 |
+
### Parameters
|
249 |
+
|
250 |
+
Name | Type | Description | Notes
|
251 |
+
------------- | ------------- | ------------- | -------------
|
252 |
+
**createDoiContact** | [**\SendinBlue\Client\Model\CreateDoiContact**](../Model/CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
|
253 |
+
|
254 |
+
### Return type
|
255 |
+
|
256 |
+
void (empty response body)
|
257 |
+
|
258 |
+
### Authorization
|
259 |
+
|
260 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
261 |
+
|
262 |
+
### HTTP request headers
|
263 |
+
|
264 |
+
- **Content-Type**: application/json
|
265 |
+
- **Accept**: application/json
|
266 |
+
|
267 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
268 |
+
|
269 |
+
# **createFolder**
|
270 |
+
> \SendinBlue\Client\Model\CreateModel createFolder($createFolder)
|
271 |
+
|
272 |
+
Create a folder
|
273 |
+
|
274 |
+
### Example
|
275 |
+
```php
|
276 |
+
<?php
|
277 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
278 |
+
|
279 |
+
// Configure API key authorization: api-key
|
280 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
281 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
282 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
283 |
+
// Configure API key authorization: partner-key
|
284 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
285 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
286 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
287 |
+
|
288 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
289 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
290 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
291 |
+
new GuzzleHttp\Client(),
|
292 |
+
$config
|
293 |
+
);
|
294 |
+
$createFolder = new \SendinBlue\Client\Model\CreateUpdateFolder(); // \SendinBlue\Client\Model\CreateUpdateFolder | Name of the folder
|
295 |
+
|
296 |
+
try {
|
297 |
+
$result = $apiInstance->createFolder($createFolder);
|
298 |
+
print_r($result);
|
299 |
+
} catch (Exception $e) {
|
300 |
+
echo 'Exception when calling ContactsApi->createFolder: ', $e->getMessage(), PHP_EOL;
|
301 |
+
}
|
302 |
+
?>
|
303 |
+
```
|
304 |
+
|
305 |
+
### Parameters
|
306 |
+
|
307 |
+
Name | Type | Description | Notes
|
308 |
+
------------- | ------------- | ------------- | -------------
|
309 |
+
**createFolder** | [**\SendinBlue\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder |
|
310 |
+
|
311 |
+
### Return type
|
312 |
+
|
313 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
314 |
+
|
315 |
+
### Authorization
|
316 |
+
|
317 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
318 |
+
|
319 |
+
### HTTP request headers
|
320 |
+
|
321 |
+
- **Content-Type**: application/json
|
322 |
+
- **Accept**: application/json
|
323 |
+
|
324 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
325 |
+
|
326 |
+
# **createList**
|
327 |
+
> \SendinBlue\Client\Model\CreateModel createList($createList)
|
328 |
+
|
329 |
+
Create a list
|
330 |
+
|
331 |
+
### Example
|
332 |
+
```php
|
333 |
+
<?php
|
334 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
335 |
+
|
336 |
+
// Configure API key authorization: api-key
|
337 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
338 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
339 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
340 |
+
// Configure API key authorization: partner-key
|
341 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
342 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
343 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
344 |
+
|
345 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
346 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
347 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
348 |
+
new GuzzleHttp\Client(),
|
349 |
+
$config
|
350 |
+
);
|
351 |
+
$createList = new \SendinBlue\Client\Model\CreateList(); // \SendinBlue\Client\Model\CreateList | Values to create a list
|
352 |
+
|
353 |
+
try {
|
354 |
+
$result = $apiInstance->createList($createList);
|
355 |
+
print_r($result);
|
356 |
+
} catch (Exception $e) {
|
357 |
+
echo 'Exception when calling ContactsApi->createList: ', $e->getMessage(), PHP_EOL;
|
358 |
+
}
|
359 |
+
?>
|
360 |
+
```
|
361 |
+
|
362 |
+
### Parameters
|
363 |
+
|
364 |
+
Name | Type | Description | Notes
|
365 |
+
------------- | ------------- | ------------- | -------------
|
366 |
+
**createList** | [**\SendinBlue\Client\Model\CreateList**](../Model/CreateList.md)| Values to create a list |
|
367 |
+
|
368 |
+
### Return type
|
369 |
+
|
370 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
371 |
+
|
372 |
+
### Authorization
|
373 |
+
|
374 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
375 |
+
|
376 |
+
### HTTP request headers
|
377 |
+
|
378 |
+
- **Content-Type**: application/json
|
379 |
+
- **Accept**: application/json
|
380 |
+
|
381 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
382 |
+
|
383 |
+
# **deleteAttribute**
|
384 |
+
> deleteAttribute($attributeCategory, $attributeName)
|
385 |
+
|
386 |
+
Delete an attribute
|
387 |
+
|
388 |
+
### Example
|
389 |
+
```php
|
390 |
+
<?php
|
391 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
392 |
+
|
393 |
+
// Configure API key authorization: api-key
|
394 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
395 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
396 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
397 |
+
// Configure API key authorization: partner-key
|
398 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
399 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
400 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
401 |
+
|
402 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
403 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
404 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
405 |
+
new GuzzleHttp\Client(),
|
406 |
+
$config
|
407 |
+
);
|
408 |
+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
409 |
+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
|
410 |
+
|
411 |
+
try {
|
412 |
+
$apiInstance->deleteAttribute($attributeCategory, $attributeName);
|
413 |
+
} catch (Exception $e) {
|
414 |
+
echo 'Exception when calling ContactsApi->deleteAttribute: ', $e->getMessage(), PHP_EOL;
|
415 |
+
}
|
416 |
+
?>
|
417 |
+
```
|
418 |
+
|
419 |
+
### Parameters
|
420 |
+
|
421 |
+
Name | Type | Description | Notes
|
422 |
+
------------- | ------------- | ------------- | -------------
|
423 |
+
**attributeCategory** | **string**| Category of the attribute |
|
424 |
+
**attributeName** | **string**| Name of the existing attribute |
|
425 |
+
|
426 |
+
### Return type
|
427 |
+
|
428 |
+
void (empty response body)
|
429 |
+
|
430 |
+
### Authorization
|
431 |
+
|
432 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
433 |
+
|
434 |
+
### HTTP request headers
|
435 |
+
|
436 |
+
- **Content-Type**: application/json
|
437 |
+
- **Accept**: application/json
|
438 |
+
|
439 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
440 |
+
|
441 |
+
# **deleteContact**
|
442 |
+
> deleteContact($identifier)
|
443 |
+
|
444 |
+
Delete a contact
|
445 |
+
|
446 |
+
### Example
|
447 |
+
```php
|
448 |
+
<?php
|
449 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
450 |
+
|
451 |
+
// Configure API key authorization: api-key
|
452 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
453 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
454 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
455 |
+
// Configure API key authorization: partner-key
|
456 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
457 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
458 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
459 |
+
|
460 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
461 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
462 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
463 |
+
new GuzzleHttp\Client(),
|
464 |
+
$config
|
465 |
+
);
|
466 |
+
$identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact
|
467 |
+
|
468 |
+
try {
|
469 |
+
$apiInstance->deleteContact($identifier);
|
470 |
+
} catch (Exception $e) {
|
471 |
+
echo 'Exception when calling ContactsApi->deleteContact: ', $e->getMessage(), PHP_EOL;
|
472 |
+
}
|
473 |
+
?>
|
474 |
+
```
|
475 |
+
|
476 |
+
### Parameters
|
477 |
+
|
478 |
+
Name | Type | Description | Notes
|
479 |
+
------------- | ------------- | ------------- | -------------
|
480 |
+
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
|
481 |
+
|
482 |
+
### Return type
|
483 |
+
|
484 |
+
void (empty response body)
|
485 |
+
|
486 |
+
### Authorization
|
487 |
+
|
488 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
489 |
+
|
490 |
+
### HTTP request headers
|
491 |
+
|
492 |
+
- **Content-Type**: application/json
|
493 |
+
- **Accept**: application/json
|
494 |
+
|
495 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
496 |
+
|
497 |
+
# **deleteFolder**
|
498 |
+
> deleteFolder($folderId)
|
499 |
+
|
500 |
+
Delete a folder (and all its lists)
|
501 |
+
|
502 |
+
### Example
|
503 |
+
```php
|
504 |
+
<?php
|
505 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
506 |
+
|
507 |
+
// Configure API key authorization: api-key
|
508 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
509 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
510 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
511 |
+
// Configure API key authorization: partner-key
|
512 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
513 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
514 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
515 |
+
|
516 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
517 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
518 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
519 |
+
new GuzzleHttp\Client(),
|
520 |
+
$config
|
521 |
+
);
|
522 |
+
$folderId = 789; // int | Id of the folder
|
523 |
+
|
524 |
+
try {
|
525 |
+
$apiInstance->deleteFolder($folderId);
|
526 |
+
} catch (Exception $e) {
|
527 |
+
echo 'Exception when calling ContactsApi->deleteFolder: ', $e->getMessage(), PHP_EOL;
|
528 |
+
}
|
529 |
+
?>
|
530 |
+
```
|
531 |
+
|
532 |
+
### Parameters
|
533 |
+
|
534 |
+
Name | Type | Description | Notes
|
535 |
+
------------- | ------------- | ------------- | -------------
|
536 |
+
**folderId** | **int**| Id of the folder |
|
537 |
+
|
538 |
+
### Return type
|
539 |
+
|
540 |
+
void (empty response body)
|
541 |
+
|
542 |
+
### Authorization
|
543 |
+
|
544 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
545 |
+
|
546 |
+
### HTTP request headers
|
547 |
+
|
548 |
+
- **Content-Type**: application/json
|
549 |
+
- **Accept**: application/json
|
550 |
+
|
551 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
552 |
+
|
553 |
+
# **deleteList**
|
554 |
+
> deleteList($listId)
|
555 |
+
|
556 |
+
Delete a list
|
557 |
+
|
558 |
+
### Example
|
559 |
+
```php
|
560 |
+
<?php
|
561 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
562 |
+
|
563 |
+
// Configure API key authorization: api-key
|
564 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
565 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
566 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
567 |
+
// Configure API key authorization: partner-key
|
568 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
569 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
570 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
571 |
+
|
572 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
573 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
574 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
575 |
+
new GuzzleHttp\Client(),
|
576 |
+
$config
|
577 |
+
);
|
578 |
+
$listId = 789; // int | Id of the list
|
579 |
+
|
580 |
+
try {
|
581 |
+
$apiInstance->deleteList($listId);
|
582 |
+
} catch (Exception $e) {
|
583 |
+
echo 'Exception when calling ContactsApi->deleteList: ', $e->getMessage(), PHP_EOL;
|
584 |
+
}
|
585 |
+
?>
|
586 |
+
```
|
587 |
+
|
588 |
+
### Parameters
|
589 |
+
|
590 |
+
Name | Type | Description | Notes
|
591 |
+
------------- | ------------- | ------------- | -------------
|
592 |
+
**listId** | **int**| Id of the list |
|
593 |
+
|
594 |
+
### Return type
|
595 |
+
|
596 |
+
void (empty response body)
|
597 |
+
|
598 |
+
### Authorization
|
599 |
+
|
600 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
601 |
+
|
602 |
+
### HTTP request headers
|
603 |
+
|
604 |
+
- **Content-Type**: application/json
|
605 |
+
- **Accept**: application/json
|
606 |
+
|
607 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
608 |
+
|
609 |
+
# **getAttributes**
|
610 |
+
> \SendinBlue\Client\Model\GetAttributes getAttributes()
|
611 |
+
|
612 |
+
List all attributes
|
613 |
+
|
614 |
+
### Example
|
615 |
+
```php
|
616 |
+
<?php
|
617 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
618 |
+
|
619 |
+
// Configure API key authorization: api-key
|
620 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
621 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
622 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
623 |
+
// Configure API key authorization: partner-key
|
624 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
625 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
626 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
627 |
+
|
628 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
629 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
630 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
631 |
+
new GuzzleHttp\Client(),
|
632 |
+
$config
|
633 |
+
);
|
634 |
+
|
635 |
+
try {
|
636 |
+
$result = $apiInstance->getAttributes();
|
637 |
+
print_r($result);
|
638 |
+
} catch (Exception $e) {
|
639 |
+
echo 'Exception when calling ContactsApi->getAttributes: ', $e->getMessage(), PHP_EOL;
|
640 |
+
}
|
641 |
+
?>
|
642 |
+
```
|
643 |
+
|
644 |
+
### Parameters
|
645 |
+
This endpoint does not need any parameter.
|
646 |
+
|
647 |
+
### Return type
|
648 |
+
|
649 |
+
[**\SendinBlue\Client\Model\GetAttributes**](../Model/GetAttributes.md)
|
650 |
+
|
651 |
+
### Authorization
|
652 |
+
|
653 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
654 |
+
|
655 |
+
### HTTP request headers
|
656 |
+
|
657 |
+
- **Content-Type**: application/json
|
658 |
+
- **Accept**: application/json
|
659 |
+
|
660 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
661 |
+
|
662 |
+
# **getContactInfo**
|
663 |
+
> \SendinBlue\Client\Model\GetExtendedContactDetails getContactInfo($identifier)
|
664 |
+
|
665 |
+
Get a contact's details
|
666 |
+
|
667 |
+
Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
668 |
+
|
669 |
+
### Example
|
670 |
+
```php
|
671 |
+
<?php
|
672 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
673 |
+
|
674 |
+
// Configure API key authorization: api-key
|
675 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
676 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
677 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
678 |
+
// Configure API key authorization: partner-key
|
679 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
680 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
681 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
682 |
+
|
683 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
684 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
685 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
686 |
+
new GuzzleHttp\Client(),
|
687 |
+
$config
|
688 |
+
);
|
689 |
+
$identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
690 |
+
|
691 |
+
try {
|
692 |
+
$result = $apiInstance->getContactInfo($identifier);
|
693 |
+
print_r($result);
|
694 |
+
} catch (Exception $e) {
|
695 |
+
echo 'Exception when calling ContactsApi->getContactInfo: ', $e->getMessage(), PHP_EOL;
|
696 |
+
}
|
697 |
+
?>
|
698 |
+
```
|
699 |
+
|
700 |
+
### Parameters
|
701 |
+
|
702 |
+
Name | Type | Description | Notes
|
703 |
+
------------- | ------------- | ------------- | -------------
|
704 |
+
**identifier** | **string**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
|
705 |
+
|
706 |
+
### Return type
|
707 |
+
|
708 |
+
[**\SendinBlue\Client\Model\GetExtendedContactDetails**](../Model/GetExtendedContactDetails.md)
|
709 |
+
|
710 |
+
### Authorization
|
711 |
+
|
712 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
713 |
+
|
714 |
+
### HTTP request headers
|
715 |
+
|
716 |
+
- **Content-Type**: application/json
|
717 |
+
- **Accept**: application/json
|
718 |
+
|
719 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
720 |
+
|
721 |
+
# **getContactStats**
|
722 |
+
> \SendinBlue\Client\Model\GetContactCampaignStats getContactStats($identifier, $startDate, $endDate)
|
723 |
+
|
724 |
+
Get email campaigns' statistics for a contact
|
725 |
+
|
726 |
+
### Example
|
727 |
+
```php
|
728 |
+
<?php
|
729 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
730 |
+
|
731 |
+
// Configure API key authorization: api-key
|
732 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
733 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
734 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
735 |
+
// Configure API key authorization: partner-key
|
736 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
737 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
738 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
739 |
+
|
740 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
741 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
742 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
743 |
+
new GuzzleHttp\Client(),
|
744 |
+
$config
|
745 |
+
);
|
746 |
+
$identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact
|
747 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
748 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
|
749 |
+
|
750 |
+
try {
|
751 |
+
$result = $apiInstance->getContactStats($identifier, $startDate, $endDate);
|
752 |
+
print_r($result);
|
753 |
+
} catch (Exception $e) {
|
754 |
+
echo 'Exception when calling ContactsApi->getContactStats: ', $e->getMessage(), PHP_EOL;
|
755 |
+
}
|
756 |
+
?>
|
757 |
+
```
|
758 |
+
|
759 |
+
### Parameters
|
760 |
+
|
761 |
+
Name | Type | Description | Notes
|
762 |
+
------------- | ------------- | ------------- | -------------
|
763 |
+
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
|
764 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
|
765 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional]
|
766 |
+
|
767 |
+
### Return type
|
768 |
+
|
769 |
+
[**\SendinBlue\Client\Model\GetContactCampaignStats**](../Model/GetContactCampaignStats.md)
|
770 |
+
|
771 |
+
### Authorization
|
772 |
+
|
773 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
774 |
+
|
775 |
+
### HTTP request headers
|
776 |
+
|
777 |
+
- **Content-Type**: application/json
|
778 |
+
- **Accept**: application/json
|
779 |
+
|
780 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
781 |
+
|
782 |
+
# **getContacts**
|
783 |
+
> \SendinBlue\Client\Model\GetContacts getContacts($limit, $offset, $modifiedSince, $sort)
|
784 |
+
|
785 |
+
Get all the contacts
|
786 |
+
|
787 |
+
### Example
|
788 |
+
```php
|
789 |
+
<?php
|
790 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
791 |
+
|
792 |
+
// Configure API key authorization: api-key
|
793 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
794 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
795 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
796 |
+
// Configure API key authorization: partner-key
|
797 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
798 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
799 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
800 |
+
|
801 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
802 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
803 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
804 |
+
new GuzzleHttp\Client(),
|
805 |
+
$config
|
806 |
+
);
|
807 |
+
$limit = 50; // int | Number of documents per page
|
808 |
+
$offset = 0; // int | Index of the first document of the page
|
809 |
+
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
810 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
811 |
+
|
812 |
+
try {
|
813 |
+
$result = $apiInstance->getContacts($limit, $offset, $modifiedSince, $sort);
|
814 |
+
print_r($result);
|
815 |
+
} catch (Exception $e) {
|
816 |
+
echo 'Exception when calling ContactsApi->getContacts: ', $e->getMessage(), PHP_EOL;
|
817 |
+
}
|
818 |
+
?>
|
819 |
+
```
|
820 |
+
|
821 |
+
### Parameters
|
822 |
+
|
823 |
+
Name | Type | Description | Notes
|
824 |
+
------------- | ------------- | ------------- | -------------
|
825 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
826 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
827 |
+
**modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
828 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
829 |
+
|
830 |
+
### Return type
|
831 |
+
|
832 |
+
[**\SendinBlue\Client\Model\GetContacts**](../Model/GetContacts.md)
|
833 |
+
|
834 |
+
### Authorization
|
835 |
+
|
836 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
837 |
+
|
838 |
+
### HTTP request headers
|
839 |
+
|
840 |
+
- **Content-Type**: application/json
|
841 |
+
- **Accept**: application/json
|
842 |
+
|
843 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
844 |
+
|
845 |
+
# **getContactsFromList**
|
846 |
+
> \SendinBlue\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort)
|
847 |
+
|
848 |
+
Get contacts in a list
|
849 |
+
|
850 |
+
### Example
|
851 |
+
```php
|
852 |
+
<?php
|
853 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
854 |
+
|
855 |
+
// Configure API key authorization: api-key
|
856 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
857 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
858 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
859 |
+
// Configure API key authorization: partner-key
|
860 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
861 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
862 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
863 |
+
|
864 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
865 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
866 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
867 |
+
new GuzzleHttp\Client(),
|
868 |
+
$config
|
869 |
+
);
|
870 |
+
$listId = 789; // int | Id of the list
|
871 |
+
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
872 |
+
$limit = 50; // int | Number of documents per page
|
873 |
+
$offset = 0; // int | Index of the first document of the page
|
874 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
875 |
+
|
876 |
+
try {
|
877 |
+
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
|
878 |
+
print_r($result);
|
879 |
+
} catch (Exception $e) {
|
880 |
+
echo 'Exception when calling ContactsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL;
|
881 |
+
}
|
882 |
+
?>
|
883 |
+
```
|
884 |
+
|
885 |
+
### Parameters
|
886 |
+
|
887 |
+
Name | Type | Description | Notes
|
888 |
+
------------- | ------------- | ------------- | -------------
|
889 |
+
**listId** | **int**| Id of the list |
|
890 |
+
**modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
891 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
892 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
893 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
894 |
+
|
895 |
+
### Return type
|
896 |
+
|
897 |
+
[**\SendinBlue\Client\Model\GetContacts**](../Model/GetContacts.md)
|
898 |
+
|
899 |
+
### Authorization
|
900 |
+
|
901 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
902 |
+
|
903 |
+
### HTTP request headers
|
904 |
+
|
905 |
+
- **Content-Type**: application/json
|
906 |
+
- **Accept**: application/json
|
907 |
+
|
908 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
909 |
+
|
910 |
+
# **getFolder**
|
911 |
+
> \SendinBlue\Client\Model\GetFolder getFolder($folderId)
|
912 |
+
|
913 |
+
Returns a folder's details
|
914 |
+
|
915 |
+
### Example
|
916 |
+
```php
|
917 |
+
<?php
|
918 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
919 |
+
|
920 |
+
// Configure API key authorization: api-key
|
921 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
922 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
923 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
924 |
+
// Configure API key authorization: partner-key
|
925 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
926 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
927 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
928 |
+
|
929 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
930 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
931 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
932 |
+
new GuzzleHttp\Client(),
|
933 |
+
$config
|
934 |
+
);
|
935 |
+
$folderId = 789; // int | id of the folder
|
936 |
+
|
937 |
+
try {
|
938 |
+
$result = $apiInstance->getFolder($folderId);
|
939 |
+
print_r($result);
|
940 |
+
} catch (Exception $e) {
|
941 |
+
echo 'Exception when calling ContactsApi->getFolder: ', $e->getMessage(), PHP_EOL;
|
942 |
+
}
|
943 |
+
?>
|
944 |
+
```
|
945 |
+
|
946 |
+
### Parameters
|
947 |
+
|
948 |
+
Name | Type | Description | Notes
|
949 |
+
------------- | ------------- | ------------- | -------------
|
950 |
+
**folderId** | **int**| id of the folder |
|
951 |
+
|
952 |
+
### Return type
|
953 |
+
|
954 |
+
[**\SendinBlue\Client\Model\GetFolder**](../Model/GetFolder.md)
|
955 |
+
|
956 |
+
### Authorization
|
957 |
+
|
958 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
959 |
+
|
960 |
+
### HTTP request headers
|
961 |
+
|
962 |
+
- **Content-Type**: application/json
|
963 |
+
- **Accept**: application/json
|
964 |
+
|
965 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
966 |
+
|
967 |
+
# **getFolderLists**
|
968 |
+
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
|
969 |
+
|
970 |
+
Get lists in a folder
|
971 |
+
|
972 |
+
### Example
|
973 |
+
```php
|
974 |
+
<?php
|
975 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
976 |
+
|
977 |
+
// Configure API key authorization: api-key
|
978 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
979 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
980 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
981 |
+
// Configure API key authorization: partner-key
|
982 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
983 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
984 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
985 |
+
|
986 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
987 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
988 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
989 |
+
new GuzzleHttp\Client(),
|
990 |
+
$config
|
991 |
+
);
|
992 |
+
$folderId = 789; // int | Id of the folder
|
993 |
+
$limit = 10; // int | Number of documents per page
|
994 |
+
$offset = 0; // int | Index of the first document of the page
|
995 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
996 |
+
|
997 |
+
try {
|
998 |
+
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
|
999 |
+
print_r($result);
|
1000 |
+
} catch (Exception $e) {
|
1001 |
+
echo 'Exception when calling ContactsApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
|
1002 |
+
}
|
1003 |
+
?>
|
1004 |
+
```
|
1005 |
+
|
1006 |
+
### Parameters
|
1007 |
+
|
1008 |
+
Name | Type | Description | Notes
|
1009 |
+
------------- | ------------- | ------------- | -------------
|
1010 |
+
**folderId** | **int**| Id of the folder |
|
1011 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
1012 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
1013 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1014 |
+
|
1015 |
+
### Return type
|
1016 |
+
|
1017 |
+
[**\SendinBlue\Client\Model\GetFolderLists**](../Model/GetFolderLists.md)
|
1018 |
+
|
1019 |
+
### Authorization
|
1020 |
+
|
1021 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1022 |
+
|
1023 |
+
### HTTP request headers
|
1024 |
+
|
1025 |
+
- **Content-Type**: application/json
|
1026 |
+
- **Accept**: application/json
|
1027 |
+
|
1028 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1029 |
+
|
1030 |
+
# **getFolders**
|
1031 |
+
> \SendinBlue\Client\Model\GetFolders getFolders($limit, $offset, $sort)
|
1032 |
+
|
1033 |
+
Get all folders
|
1034 |
+
|
1035 |
+
### Example
|
1036 |
+
```php
|
1037 |
+
<?php
|
1038 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1039 |
+
|
1040 |
+
// Configure API key authorization: api-key
|
1041 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1042 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1043 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1044 |
+
// Configure API key authorization: partner-key
|
1045 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1046 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1047 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1048 |
+
|
1049 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1050 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1051 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1052 |
+
new GuzzleHttp\Client(),
|
1053 |
+
$config
|
1054 |
+
);
|
1055 |
+
$limit = 10; // int | Number of documents per page
|
1056 |
+
$offset = 0; // int | Index of the first document of the page
|
1057 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1058 |
+
|
1059 |
+
try {
|
1060 |
+
$result = $apiInstance->getFolders($limit, $offset, $sort);
|
1061 |
+
print_r($result);
|
1062 |
+
} catch (Exception $e) {
|
1063 |
+
echo 'Exception when calling ContactsApi->getFolders: ', $e->getMessage(), PHP_EOL;
|
1064 |
+
}
|
1065 |
+
?>
|
1066 |
+
```
|
1067 |
+
|
1068 |
+
### Parameters
|
1069 |
+
|
1070 |
+
Name | Type | Description | Notes
|
1071 |
+
------------- | ------------- | ------------- | -------------
|
1072 |
+
**limit** | **int**| Number of documents per page | [default to 10]
|
1073 |
+
**offset** | **int**| Index of the first document of the page | [default to 0]
|
1074 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1075 |
+
|
1076 |
+
### Return type
|
1077 |
+
|
1078 |
+
[**\SendinBlue\Client\Model\GetFolders**](../Model/GetFolders.md)
|
1079 |
+
|
1080 |
+
### Authorization
|
1081 |
+
|
1082 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1083 |
+
|
1084 |
+
### HTTP request headers
|
1085 |
+
|
1086 |
+
- **Content-Type**: application/json
|
1087 |
+
- **Accept**: application/json
|
1088 |
+
|
1089 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1090 |
+
|
1091 |
+
# **getList**
|
1092 |
+
> \SendinBlue\Client\Model\GetExtendedList getList($listId)
|
1093 |
+
|
1094 |
+
Get a list's details
|
1095 |
+
|
1096 |
+
### Example
|
1097 |
+
```php
|
1098 |
+
<?php
|
1099 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1100 |
+
|
1101 |
+
// Configure API key authorization: api-key
|
1102 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1103 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1104 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1105 |
+
// Configure API key authorization: partner-key
|
1106 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1107 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1108 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1109 |
+
|
1110 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1111 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1112 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1113 |
+
new GuzzleHttp\Client(),
|
1114 |
+
$config
|
1115 |
+
);
|
1116 |
+
$listId = 789; // int | Id of the list
|
1117 |
+
|
1118 |
+
try {
|
1119 |
+
$result = $apiInstance->getList($listId);
|
1120 |
+
print_r($result);
|
1121 |
+
} catch (Exception $e) {
|
1122 |
+
echo 'Exception when calling ContactsApi->getList: ', $e->getMessage(), PHP_EOL;
|
1123 |
+
}
|
1124 |
+
?>
|
1125 |
+
```
|
1126 |
+
|
1127 |
+
### Parameters
|
1128 |
+
|
1129 |
+
Name | Type | Description | Notes
|
1130 |
+
------------- | ------------- | ------------- | -------------
|
1131 |
+
**listId** | **int**| Id of the list |
|
1132 |
+
|
1133 |
+
### Return type
|
1134 |
+
|
1135 |
+
[**\SendinBlue\Client\Model\GetExtendedList**](../Model/GetExtendedList.md)
|
1136 |
+
|
1137 |
+
### Authorization
|
1138 |
+
|
1139 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1140 |
+
|
1141 |
+
### HTTP request headers
|
1142 |
+
|
1143 |
+
- **Content-Type**: application/json
|
1144 |
+
- **Accept**: application/json
|
1145 |
+
|
1146 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1147 |
+
|
1148 |
+
# **getLists**
|
1149 |
+
> \SendinBlue\Client\Model\GetLists getLists($limit, $offset, $sort)
|
1150 |
+
|
1151 |
+
Get all the lists
|
1152 |
+
|
1153 |
+
### Example
|
1154 |
+
```php
|
1155 |
+
<?php
|
1156 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1157 |
+
|
1158 |
+
// Configure API key authorization: api-key
|
1159 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1160 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1161 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1162 |
+
// Configure API key authorization: partner-key
|
1163 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1164 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1165 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1166 |
+
|
1167 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1168 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1169 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1170 |
+
new GuzzleHttp\Client(),
|
1171 |
+
$config
|
1172 |
+
);
|
1173 |
+
$limit = 10; // int | Number of documents per page
|
1174 |
+
$offset = 0; // int | Index of the first document of the page
|
1175 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1176 |
+
|
1177 |
+
try {
|
1178 |
+
$result = $apiInstance->getLists($limit, $offset, $sort);
|
1179 |
+
print_r($result);
|
1180 |
+
} catch (Exception $e) {
|
1181 |
+
echo 'Exception when calling ContactsApi->getLists: ', $e->getMessage(), PHP_EOL;
|
1182 |
+
}
|
1183 |
+
?>
|
1184 |
+
```
|
1185 |
+
|
1186 |
+
### Parameters
|
1187 |
+
|
1188 |
+
Name | Type | Description | Notes
|
1189 |
+
------------- | ------------- | ------------- | -------------
|
1190 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
1191 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
1192 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1193 |
+
|
1194 |
+
### Return type
|
1195 |
+
|
1196 |
+
[**\SendinBlue\Client\Model\GetLists**](../Model/GetLists.md)
|
1197 |
+
|
1198 |
+
### Authorization
|
1199 |
+
|
1200 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1201 |
+
|
1202 |
+
### HTTP request headers
|
1203 |
+
|
1204 |
+
- **Content-Type**: application/json
|
1205 |
+
- **Accept**: application/json
|
1206 |
+
|
1207 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1208 |
+
|
1209 |
+
# **importContacts**
|
1210 |
+
> \SendinBlue\Client\Model\CreatedProcessId importContacts($requestContactImport)
|
1211 |
+
|
1212 |
+
Import contacts
|
1213 |
+
|
1214 |
+
It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
1215 |
+
|
1216 |
+
### Example
|
1217 |
+
```php
|
1218 |
+
<?php
|
1219 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1220 |
+
|
1221 |
+
// Configure API key authorization: api-key
|
1222 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1223 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1224 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1225 |
+
// Configure API key authorization: partner-key
|
1226 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1227 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1228 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1229 |
+
|
1230 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1231 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1232 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1233 |
+
new GuzzleHttp\Client(),
|
1234 |
+
$config
|
1235 |
+
);
|
1236 |
+
$requestContactImport = new \SendinBlue\Client\Model\RequestContactImport(); // \SendinBlue\Client\Model\RequestContactImport | Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
|
1237 |
+
|
1238 |
+
try {
|
1239 |
+
$result = $apiInstance->importContacts($requestContactImport);
|
1240 |
+
print_r($result);
|
1241 |
+
} catch (Exception $e) {
|
1242 |
+
echo 'Exception when calling ContactsApi->importContacts: ', $e->getMessage(), PHP_EOL;
|
1243 |
+
}
|
1244 |
+
?>
|
1245 |
+
```
|
1246 |
+
|
1247 |
+
### Parameters
|
1248 |
+
|
1249 |
+
Name | Type | Description | Notes
|
1250 |
+
------------- | ------------- | ------------- | -------------
|
1251 |
+
**requestContactImport** | [**\SendinBlue\Client\Model\RequestContactImport**](../Model/RequestContactImport.md)| Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` |
|
1252 |
+
|
1253 |
+
### Return type
|
1254 |
+
|
1255 |
+
[**\SendinBlue\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
1256 |
+
|
1257 |
+
### Authorization
|
1258 |
+
|
1259 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1260 |
+
|
1261 |
+
### HTTP request headers
|
1262 |
+
|
1263 |
+
- **Content-Type**: application/json
|
1264 |
+
- **Accept**: application/json
|
1265 |
+
|
1266 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1267 |
+
|
1268 |
+
# **removeContactFromList**
|
1269 |
+
> \SendinBlue\Client\Model\PostContactInfo removeContactFromList($listId, $contactEmails)
|
1270 |
+
|
1271 |
+
Delete a contact from a list
|
1272 |
+
|
1273 |
+
### Example
|
1274 |
+
```php
|
1275 |
+
<?php
|
1276 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1277 |
+
|
1278 |
+
// Configure API key authorization: api-key
|
1279 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1280 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1281 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1282 |
+
// Configure API key authorization: partner-key
|
1283 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1284 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1285 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1286 |
+
|
1287 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1288 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1289 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1290 |
+
new GuzzleHttp\Client(),
|
1291 |
+
$config
|
1292 |
+
);
|
1293 |
+
$listId = 789; // int | Id of the list
|
1294 |
+
$contactEmails = new \SendinBlue\Client\Model\RemoveContactFromList(); // \SendinBlue\Client\Model\RemoveContactFromList | Emails addresses OR IDs of the contacts
|
1295 |
+
|
1296 |
+
try {
|
1297 |
+
$result = $apiInstance->removeContactFromList($listId, $contactEmails);
|
1298 |
+
print_r($result);
|
1299 |
+
} catch (Exception $e) {
|
1300 |
+
echo 'Exception when calling ContactsApi->removeContactFromList: ', $e->getMessage(), PHP_EOL;
|
1301 |
+
}
|
1302 |
+
?>
|
1303 |
+
```
|
1304 |
+
|
1305 |
+
### Parameters
|
1306 |
+
|
1307 |
+
Name | Type | Description | Notes
|
1308 |
+
------------- | ------------- | ------------- | -------------
|
1309 |
+
**listId** | **int**| Id of the list |
|
1310 |
+
**contactEmails** | [**\SendinBlue\Client\Model\RemoveContactFromList**](../Model/RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
1311 |
+
|
1312 |
+
### Return type
|
1313 |
+
|
1314 |
+
[**\SendinBlue\Client\Model\PostContactInfo**](../Model/PostContactInfo.md)
|
1315 |
+
|
1316 |
+
### Authorization
|
1317 |
+
|
1318 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1319 |
+
|
1320 |
+
### HTTP request headers
|
1321 |
+
|
1322 |
+
- **Content-Type**: application/json
|
1323 |
+
- **Accept**: application/json
|
1324 |
+
|
1325 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1326 |
+
|
1327 |
+
# **requestContactExport**
|
1328 |
+
> \SendinBlue\Client\Model\CreatedProcessId requestContactExport($requestContactExport)
|
1329 |
+
|
1330 |
+
Export contacts
|
1331 |
+
|
1332 |
+
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
|
1333 |
+
|
1334 |
+
### Example
|
1335 |
+
```php
|
1336 |
+
<?php
|
1337 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1338 |
+
|
1339 |
+
// Configure API key authorization: api-key
|
1340 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1341 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1342 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1343 |
+
// Configure API key authorization: partner-key
|
1344 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1345 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1346 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1347 |
+
|
1348 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1349 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1350 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1351 |
+
new GuzzleHttp\Client(),
|
1352 |
+
$config
|
1353 |
+
);
|
1354 |
+
$requestContactExport = new \SendinBlue\Client\Model\RequestContactExport(); // \SendinBlue\Client\Model\RequestContactExport | Values to request a contact export
|
1355 |
+
|
1356 |
+
try {
|
1357 |
+
$result = $apiInstance->requestContactExport($requestContactExport);
|
1358 |
+
print_r($result);
|
1359 |
+
} catch (Exception $e) {
|
1360 |
+
echo 'Exception when calling ContactsApi->requestContactExport: ', $e->getMessage(), PHP_EOL;
|
1361 |
+
}
|
1362 |
+
?>
|
1363 |
+
```
|
1364 |
+
|
1365 |
+
### Parameters
|
1366 |
+
|
1367 |
+
Name | Type | Description | Notes
|
1368 |
+
------------- | ------------- | ------------- | -------------
|
1369 |
+
**requestContactExport** | [**\SendinBlue\Client\Model\RequestContactExport**](../Model/RequestContactExport.md)| Values to request a contact export |
|
1370 |
+
|
1371 |
+
### Return type
|
1372 |
+
|
1373 |
+
[**\SendinBlue\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
1374 |
+
|
1375 |
+
### Authorization
|
1376 |
+
|
1377 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1378 |
+
|
1379 |
+
### HTTP request headers
|
1380 |
+
|
1381 |
+
- **Content-Type**: application/json
|
1382 |
+
- **Accept**: application/json
|
1383 |
+
|
1384 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1385 |
+
|
1386 |
+
# **updateAttribute**
|
1387 |
+
> updateAttribute($attributeCategory, $attributeName, $updateAttribute)
|
1388 |
+
|
1389 |
+
Update contact attribute
|
1390 |
+
|
1391 |
+
### Example
|
1392 |
+
```php
|
1393 |
+
<?php
|
1394 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1395 |
+
|
1396 |
+
// Configure API key authorization: api-key
|
1397 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1398 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1399 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1400 |
+
// Configure API key authorization: partner-key
|
1401 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1402 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1403 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1404 |
+
|
1405 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1406 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1407 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1408 |
+
new GuzzleHttp\Client(),
|
1409 |
+
$config
|
1410 |
+
);
|
1411 |
+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
1412 |
+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
|
1413 |
+
$updateAttribute = new \SendinBlue\Client\Model\UpdateAttribute(); // \SendinBlue\Client\Model\UpdateAttribute | Values to update an attribute
|
1414 |
+
|
1415 |
+
try {
|
1416 |
+
$apiInstance->updateAttribute($attributeCategory, $attributeName, $updateAttribute);
|
1417 |
+
} catch (Exception $e) {
|
1418 |
+
echo 'Exception when calling ContactsApi->updateAttribute: ', $e->getMessage(), PHP_EOL;
|
1419 |
+
}
|
1420 |
+
?>
|
1421 |
+
```
|
1422 |
+
|
1423 |
+
### Parameters
|
1424 |
+
|
1425 |
+
Name | Type | Description | Notes
|
1426 |
+
------------- | ------------- | ------------- | -------------
|
1427 |
+
**attributeCategory** | **string**| Category of the attribute |
|
1428 |
+
**attributeName** | **string**| Name of the existing attribute |
|
1429 |
+
**updateAttribute** | [**\SendinBlue\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute |
|
1430 |
+
|
1431 |
+
### Return type
|
1432 |
+
|
1433 |
+
void (empty response body)
|
1434 |
+
|
1435 |
+
### Authorization
|
1436 |
+
|
1437 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1438 |
+
|
1439 |
+
### HTTP request headers
|
1440 |
+
|
1441 |
+
- **Content-Type**: application/json
|
1442 |
+
- **Accept**: application/json
|
1443 |
+
|
1444 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1445 |
+
|
1446 |
+
# **updateBatchContacts**
|
1447 |
+
> updateBatchContacts($updateBatchContacts)
|
1448 |
+
|
1449 |
+
Update multiple contacts
|
1450 |
+
|
1451 |
+
### Example
|
1452 |
+
```php
|
1453 |
+
<?php
|
1454 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1455 |
+
|
1456 |
+
// Configure API key authorization: api-key
|
1457 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1458 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1459 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1460 |
+
// Configure API key authorization: partner-key
|
1461 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1462 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1463 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1464 |
+
|
1465 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1466 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1467 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1468 |
+
new GuzzleHttp\Client(),
|
1469 |
+
$config
|
1470 |
+
);
|
1471 |
+
$updateBatchContacts = new \SendinBlue\Client\Model\UpdateBatchContacts(); // \SendinBlue\Client\Model\UpdateBatchContacts | Values to update multiple contacts
|
1472 |
+
|
1473 |
+
try {
|
1474 |
+
$apiInstance->updateBatchContacts($updateBatchContacts);
|
1475 |
+
} catch (Exception $e) {
|
1476 |
+
echo 'Exception when calling ContactsApi->updateBatchContacts: ', $e->getMessage(), PHP_EOL;
|
1477 |
+
}
|
1478 |
+
?>
|
1479 |
+
```
|
1480 |
+
|
1481 |
+
### Parameters
|
1482 |
+
|
1483 |
+
Name | Type | Description | Notes
|
1484 |
+
------------- | ------------- | ------------- | -------------
|
1485 |
+
**updateBatchContacts** | [**\SendinBlue\Client\Model\UpdateBatchContacts**](../Model/UpdateBatchContacts.md)| Values to update multiple contacts |
|
1486 |
+
|
1487 |
+
### Return type
|
1488 |
+
|
1489 |
+
void (empty response body)
|
1490 |
+
|
1491 |
+
### Authorization
|
1492 |
+
|
1493 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1494 |
+
|
1495 |
+
### HTTP request headers
|
1496 |
+
|
1497 |
+
- **Content-Type**: application/json
|
1498 |
+
- **Accept**: application/json
|
1499 |
+
|
1500 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1501 |
+
|
1502 |
+
# **updateContact**
|
1503 |
+
> updateContact($identifier, $updateContact)
|
1504 |
+
|
1505 |
+
Update a contact
|
1506 |
+
|
1507 |
+
### Example
|
1508 |
+
```php
|
1509 |
+
<?php
|
1510 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1511 |
+
|
1512 |
+
// Configure API key authorization: api-key
|
1513 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1514 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1515 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1516 |
+
// Configure API key authorization: partner-key
|
1517 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1518 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1519 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1520 |
+
|
1521 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1522 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1523 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1524 |
+
new GuzzleHttp\Client(),
|
1525 |
+
$config
|
1526 |
+
);
|
1527 |
+
$identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact
|
1528 |
+
$updateContact = new \SendinBlue\Client\Model\UpdateContact(); // \SendinBlue\Client\Model\UpdateContact | Values to update a contact
|
1529 |
+
|
1530 |
+
try {
|
1531 |
+
$apiInstance->updateContact($identifier, $updateContact);
|
1532 |
+
} catch (Exception $e) {
|
1533 |
+
echo 'Exception when calling ContactsApi->updateContact: ', $e->getMessage(), PHP_EOL;
|
1534 |
+
}
|
1535 |
+
?>
|
1536 |
+
```
|
1537 |
+
|
1538 |
+
### Parameters
|
1539 |
+
|
1540 |
+
Name | Type | Description | Notes
|
1541 |
+
------------- | ------------- | ------------- | -------------
|
1542 |
+
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
|
1543 |
+
**updateContact** | [**\SendinBlue\Client\Model\UpdateContact**](../Model/UpdateContact.md)| Values to update a contact |
|
1544 |
+
|
1545 |
+
### Return type
|
1546 |
+
|
1547 |
+
void (empty response body)
|
1548 |
+
|
1549 |
+
### Authorization
|
1550 |
+
|
1551 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1552 |
+
|
1553 |
+
### HTTP request headers
|
1554 |
+
|
1555 |
+
- **Content-Type**: application/json
|
1556 |
+
- **Accept**: application/json
|
1557 |
+
|
1558 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1559 |
+
|
1560 |
+
# **updateFolder**
|
1561 |
+
> updateFolder($folderId, $updateFolder)
|
1562 |
+
|
1563 |
+
Update a folder
|
1564 |
+
|
1565 |
+
### Example
|
1566 |
+
```php
|
1567 |
+
<?php
|
1568 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1569 |
+
|
1570 |
+
// Configure API key authorization: api-key
|
1571 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1572 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1573 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1574 |
+
// Configure API key authorization: partner-key
|
1575 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1576 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1577 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1578 |
+
|
1579 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1580 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1581 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1582 |
+
new GuzzleHttp\Client(),
|
1583 |
+
$config
|
1584 |
+
);
|
1585 |
+
$folderId = 789; // int | Id of the folder
|
1586 |
+
$updateFolder = new \SendinBlue\Client\Model\CreateUpdateFolder(); // \SendinBlue\Client\Model\CreateUpdateFolder | Name of the folder
|
1587 |
+
|
1588 |
+
try {
|
1589 |
+
$apiInstance->updateFolder($folderId, $updateFolder);
|
1590 |
+
} catch (Exception $e) {
|
1591 |
+
echo 'Exception when calling ContactsApi->updateFolder: ', $e->getMessage(), PHP_EOL;
|
1592 |
+
}
|
1593 |
+
?>
|
1594 |
+
```
|
1595 |
+
|
1596 |
+
### Parameters
|
1597 |
+
|
1598 |
+
Name | Type | Description | Notes
|
1599 |
+
------------- | ------------- | ------------- | -------------
|
1600 |
+
**folderId** | **int**| Id of the folder |
|
1601 |
+
**updateFolder** | [**\SendinBlue\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder |
|
1602 |
+
|
1603 |
+
### Return type
|
1604 |
+
|
1605 |
+
void (empty response body)
|
1606 |
+
|
1607 |
+
### Authorization
|
1608 |
+
|
1609 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1610 |
+
|
1611 |
+
### HTTP request headers
|
1612 |
+
|
1613 |
+
- **Content-Type**: application/json
|
1614 |
+
- **Accept**: application/json
|
1615 |
+
|
1616 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1617 |
+
|
1618 |
+
# **updateList**
|
1619 |
+
> updateList($listId, $updateList)
|
1620 |
+
|
1621 |
+
Update a list
|
1622 |
+
|
1623 |
+
### Example
|
1624 |
+
```php
|
1625 |
+
<?php
|
1626 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1627 |
+
|
1628 |
+
// Configure API key authorization: api-key
|
1629 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1630 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1631 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1632 |
+
// Configure API key authorization: partner-key
|
1633 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1634 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1635 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1636 |
+
|
1637 |
+
$apiInstance = new SendinBlue\Client\Api\ContactsApi(
|
1638 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1639 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1640 |
+
new GuzzleHttp\Client(),
|
1641 |
+
$config
|
1642 |
+
);
|
1643 |
+
$listId = 789; // int | Id of the list
|
1644 |
+
$updateList = new \SendinBlue\Client\Model\UpdateList(); // \SendinBlue\Client\Model\UpdateList | Values to update a list
|
1645 |
+
|
1646 |
+
try {
|
1647 |
+
$apiInstance->updateList($listId, $updateList);
|
1648 |
+
} catch (Exception $e) {
|
1649 |
+
echo 'Exception when calling ContactsApi->updateList: ', $e->getMessage(), PHP_EOL;
|
1650 |
+
}
|
1651 |
+
?>
|
1652 |
+
```
|
1653 |
+
|
1654 |
+
### Parameters
|
1655 |
+
|
1656 |
+
Name | Type | Description | Notes
|
1657 |
+
------------- | ------------- | ------------- | -------------
|
1658 |
+
**listId** | **int**| Id of the list |
|
1659 |
+
**updateList** | [**\SendinBlue\Client\Model\UpdateList**](../Model/UpdateList.md)| Values to update a list |
|
1660 |
+
|
1661 |
+
### Return type
|
1662 |
+
|
1663 |
+
void (empty response body)
|
1664 |
+
|
1665 |
+
### Authorization
|
1666 |
+
|
1667 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1668 |
+
|
1669 |
+
### HTTP request headers
|
1670 |
+
|
1671 |
+
- **Content-Type**: application/json
|
1672 |
+
- **Accept**: application/json
|
1673 |
+
|
1674 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1675 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/EmailCampaignsApi.md
ADDED
@@ -0,0 +1,783 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\EmailCampaignsApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**createEmailCampaign**](EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign
|
8 |
+
[**deleteEmailCampaign**](EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
9 |
+
[**emailExportRecipients**](EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
10 |
+
[**getAbTestCampaignResult**](EmailCampaignsApi.md#getAbTestCampaignResult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
11 |
+
[**getEmailCampaign**](EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
12 |
+
[**getEmailCampaigns**](EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
13 |
+
[**getSharedTemplateUrl**](EmailCampaignsApi.md#getSharedTemplateUrl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
14 |
+
[**sendEmailCampaignNow**](EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
15 |
+
[**sendReport**](EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
16 |
+
[**sendTestEmail**](EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
17 |
+
[**updateCampaignStatus**](EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
18 |
+
[**updateEmailCampaign**](EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
19 |
+
[**uploadImageToGallery**](EmailCampaignsApi.md#uploadImageToGallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
20 |
+
|
21 |
+
|
22 |
+
# **createEmailCampaign**
|
23 |
+
> \SendinBlue\Client\Model\CreateModel createEmailCampaign($emailCampaigns)
|
24 |
+
|
25 |
+
Create an email campaign
|
26 |
+
|
27 |
+
### Example
|
28 |
+
```php
|
29 |
+
<?php
|
30 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
31 |
+
|
32 |
+
// Configure API key authorization: api-key
|
33 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
34 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
35 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
36 |
+
// Configure API key authorization: partner-key
|
37 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
38 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
39 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
40 |
+
|
41 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
42 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
43 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
44 |
+
new GuzzleHttp\Client(),
|
45 |
+
$config
|
46 |
+
);
|
47 |
+
$emailCampaigns = new \SendinBlue\Client\Model\CreateEmailCampaign(); // \SendinBlue\Client\Model\CreateEmailCampaign | Values to create a campaign
|
48 |
+
|
49 |
+
try {
|
50 |
+
$result = $apiInstance->createEmailCampaign($emailCampaigns);
|
51 |
+
print_r($result);
|
52 |
+
} catch (Exception $e) {
|
53 |
+
echo 'Exception when calling EmailCampaignsApi->createEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
54 |
+
}
|
55 |
+
?>
|
56 |
+
```
|
57 |
+
|
58 |
+
### Parameters
|
59 |
+
|
60 |
+
Name | Type | Description | Notes
|
61 |
+
------------- | ------------- | ------------- | -------------
|
62 |
+
**emailCampaigns** | [**\SendinBlue\Client\Model\CreateEmailCampaign**](../Model/CreateEmailCampaign.md)| Values to create a campaign |
|
63 |
+
|
64 |
+
### Return type
|
65 |
+
|
66 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
67 |
+
|
68 |
+
### Authorization
|
69 |
+
|
70 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
71 |
+
|
72 |
+
### HTTP request headers
|
73 |
+
|
74 |
+
- **Content-Type**: application/json
|
75 |
+
- **Accept**: application/json
|
76 |
+
|
77 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
78 |
+
|
79 |
+
# **deleteEmailCampaign**
|
80 |
+
> deleteEmailCampaign($campaignId)
|
81 |
+
|
82 |
+
Delete an email campaign
|
83 |
+
|
84 |
+
### Example
|
85 |
+
```php
|
86 |
+
<?php
|
87 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
88 |
+
|
89 |
+
// Configure API key authorization: api-key
|
90 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
91 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
92 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
93 |
+
// Configure API key authorization: partner-key
|
94 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
95 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
96 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
97 |
+
|
98 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
99 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
100 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
101 |
+
new GuzzleHttp\Client(),
|
102 |
+
$config
|
103 |
+
);
|
104 |
+
$campaignId = 789; // int | id of the campaign
|
105 |
+
|
106 |
+
try {
|
107 |
+
$apiInstance->deleteEmailCampaign($campaignId);
|
108 |
+
} catch (Exception $e) {
|
109 |
+
echo 'Exception when calling EmailCampaignsApi->deleteEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
110 |
+
}
|
111 |
+
?>
|
112 |
+
```
|
113 |
+
|
114 |
+
### Parameters
|
115 |
+
|
116 |
+
Name | Type | Description | Notes
|
117 |
+
------------- | ------------- | ------------- | -------------
|
118 |
+
**campaignId** | **int**| id of the campaign |
|
119 |
+
|
120 |
+
### Return type
|
121 |
+
|
122 |
+
void (empty response body)
|
123 |
+
|
124 |
+
### Authorization
|
125 |
+
|
126 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
127 |
+
|
128 |
+
### HTTP request headers
|
129 |
+
|
130 |
+
- **Content-Type**: application/json
|
131 |
+
- **Accept**: application/json
|
132 |
+
|
133 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
134 |
+
|
135 |
+
# **emailExportRecipients**
|
136 |
+
> \SendinBlue\Client\Model\CreatedProcessId emailExportRecipients($campaignId, $recipientExport)
|
137 |
+
|
138 |
+
Export the recipients of an email campaign
|
139 |
+
|
140 |
+
### Example
|
141 |
+
```php
|
142 |
+
<?php
|
143 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
144 |
+
|
145 |
+
// Configure API key authorization: api-key
|
146 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
147 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
148 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
149 |
+
// Configure API key authorization: partner-key
|
150 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
151 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
152 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
153 |
+
|
154 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
155 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
156 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
157 |
+
new GuzzleHttp\Client(),
|
158 |
+
$config
|
159 |
+
);
|
160 |
+
$campaignId = 789; // int | Id of the campaign
|
161 |
+
$recipientExport = new \SendinBlue\Client\Model\EmailExportRecipients(); // \SendinBlue\Client\Model\EmailExportRecipients | Values to send for a recipient export request
|
162 |
+
|
163 |
+
try {
|
164 |
+
$result = $apiInstance->emailExportRecipients($campaignId, $recipientExport);
|
165 |
+
print_r($result);
|
166 |
+
} catch (Exception $e) {
|
167 |
+
echo 'Exception when calling EmailCampaignsApi->emailExportRecipients: ', $e->getMessage(), PHP_EOL;
|
168 |
+
}
|
169 |
+
?>
|
170 |
+
```
|
171 |
+
|
172 |
+
### Parameters
|
173 |
+
|
174 |
+
Name | Type | Description | Notes
|
175 |
+
------------- | ------------- | ------------- | -------------
|
176 |
+
**campaignId** | **int**| Id of the campaign |
|
177 |
+
**recipientExport** | [**\SendinBlue\Client\Model\EmailExportRecipients**](../Model/EmailExportRecipients.md)| Values to send for a recipient export request | [optional]
|
178 |
+
|
179 |
+
### Return type
|
180 |
+
|
181 |
+
[**\SendinBlue\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
182 |
+
|
183 |
+
### Authorization
|
184 |
+
|
185 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
186 |
+
|
187 |
+
### HTTP request headers
|
188 |
+
|
189 |
+
- **Content-Type**: application/json
|
190 |
+
- **Accept**: application/json
|
191 |
+
|
192 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
193 |
+
|
194 |
+
# **getAbTestCampaignResult**
|
195 |
+
> \SendinBlue\Client\Model\AbTestCampaignResult getAbTestCampaignResult($campaignId)
|
196 |
+
|
197 |
+
Get an A/B test email campaign results
|
198 |
+
|
199 |
+
Obtain winning version of an A/B test email campaign
|
200 |
+
|
201 |
+
### Example
|
202 |
+
```php
|
203 |
+
<?php
|
204 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
205 |
+
|
206 |
+
// Configure API key authorization: api-key
|
207 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
208 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
209 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
210 |
+
// Configure API key authorization: partner-key
|
211 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
212 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
213 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
214 |
+
|
215 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
216 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
217 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
218 |
+
new GuzzleHttp\Client(),
|
219 |
+
$config
|
220 |
+
);
|
221 |
+
$campaignId = 789; // int | Id of the A/B test campaign
|
222 |
+
|
223 |
+
try {
|
224 |
+
$result = $apiInstance->getAbTestCampaignResult($campaignId);
|
225 |
+
print_r($result);
|
226 |
+
} catch (Exception $e) {
|
227 |
+
echo 'Exception when calling EmailCampaignsApi->getAbTestCampaignResult: ', $e->getMessage(), PHP_EOL;
|
228 |
+
}
|
229 |
+
?>
|
230 |
+
```
|
231 |
+
|
232 |
+
### Parameters
|
233 |
+
|
234 |
+
Name | Type | Description | Notes
|
235 |
+
------------- | ------------- | ------------- | -------------
|
236 |
+
**campaignId** | **int**| Id of the A/B test campaign |
|
237 |
+
|
238 |
+
### Return type
|
239 |
+
|
240 |
+
[**\SendinBlue\Client\Model\AbTestCampaignResult**](../Model/AbTestCampaignResult.md)
|
241 |
+
|
242 |
+
### Authorization
|
243 |
+
|
244 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
245 |
+
|
246 |
+
### HTTP request headers
|
247 |
+
|
248 |
+
- **Content-Type**: application/json
|
249 |
+
- **Accept**: application/json
|
250 |
+
|
251 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
252 |
+
|
253 |
+
# **getEmailCampaign**
|
254 |
+
> \SendinBlue\Client\Model\GetEmailCampaign getEmailCampaign($campaignId)
|
255 |
+
|
256 |
+
Get an email campaign report
|
257 |
+
|
258 |
+
### Example
|
259 |
+
```php
|
260 |
+
<?php
|
261 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
262 |
+
|
263 |
+
// Configure API key authorization: api-key
|
264 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
265 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
266 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
267 |
+
// Configure API key authorization: partner-key
|
268 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
269 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
270 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
271 |
+
|
272 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
273 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
274 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
275 |
+
new GuzzleHttp\Client(),
|
276 |
+
$config
|
277 |
+
);
|
278 |
+
$campaignId = 789; // int | Id of the campaign
|
279 |
+
|
280 |
+
try {
|
281 |
+
$result = $apiInstance->getEmailCampaign($campaignId);
|
282 |
+
print_r($result);
|
283 |
+
} catch (Exception $e) {
|
284 |
+
echo 'Exception when calling EmailCampaignsApi->getEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
285 |
+
}
|
286 |
+
?>
|
287 |
+
```
|
288 |
+
|
289 |
+
### Parameters
|
290 |
+
|
291 |
+
Name | Type | Description | Notes
|
292 |
+
------------- | ------------- | ------------- | -------------
|
293 |
+
**campaignId** | **int**| Id of the campaign |
|
294 |
+
|
295 |
+
### Return type
|
296 |
+
|
297 |
+
[**\SendinBlue\Client\Model\GetEmailCampaign**](../Model/GetEmailCampaign.md)
|
298 |
+
|
299 |
+
### Authorization
|
300 |
+
|
301 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
302 |
+
|
303 |
+
### HTTP request headers
|
304 |
+
|
305 |
+
- **Content-Type**: application/json
|
306 |
+
- **Accept**: application/json
|
307 |
+
|
308 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
309 |
+
|
310 |
+
# **getEmailCampaigns**
|
311 |
+
> \SendinBlue\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset, $sort)
|
312 |
+
|
313 |
+
Return all your created email campaigns
|
314 |
+
|
315 |
+
### Example
|
316 |
+
```php
|
317 |
+
<?php
|
318 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
319 |
+
|
320 |
+
// Configure API key authorization: api-key
|
321 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
322 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
323 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
324 |
+
// Configure API key authorization: partner-key
|
325 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
326 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
327 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
328 |
+
|
329 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
330 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
331 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
332 |
+
new GuzzleHttp\Client(),
|
333 |
+
$config
|
334 |
+
);
|
335 |
+
$type = "type_example"; // string | Filter on the type of the campaigns
|
336 |
+
$status = "status_example"; // string | Filter on the status of the campaign
|
337 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
338 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
339 |
+
$limit = 500; // int | Number of documents per page
|
340 |
+
$offset = 0; // int | Index of the first document in the page
|
341 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
342 |
+
|
343 |
+
try {
|
344 |
+
$result = $apiInstance->getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset, $sort);
|
345 |
+
print_r($result);
|
346 |
+
} catch (Exception $e) {
|
347 |
+
echo 'Exception when calling EmailCampaignsApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL;
|
348 |
+
}
|
349 |
+
?>
|
350 |
+
```
|
351 |
+
|
352 |
+
### Parameters
|
353 |
+
|
354 |
+
Name | Type | Description | Notes
|
355 |
+
------------- | ------------- | ------------- | -------------
|
356 |
+
**type** | **string**| Filter on the type of the campaigns | [optional]
|
357 |
+
**status** | **string**| Filter on the status of the campaign | [optional]
|
358 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
359 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
360 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 500]
|
361 |
+
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
362 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
363 |
+
|
364 |
+
### Return type
|
365 |
+
|
366 |
+
[**\SendinBlue\Client\Model\GetEmailCampaigns**](../Model/GetEmailCampaigns.md)
|
367 |
+
|
368 |
+
### Authorization
|
369 |
+
|
370 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
371 |
+
|
372 |
+
### HTTP request headers
|
373 |
+
|
374 |
+
- **Content-Type**: application/json
|
375 |
+
- **Accept**: application/json
|
376 |
+
|
377 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
378 |
+
|
379 |
+
# **getSharedTemplateUrl**
|
380 |
+
> \SendinBlue\Client\Model\GetSharedTemplateUrl getSharedTemplateUrl($campaignId)
|
381 |
+
|
382 |
+
Get a shared template url
|
383 |
+
|
384 |
+
Get a unique URL to share & import an email template from one Sendinblue account to another.
|
385 |
+
|
386 |
+
### Example
|
387 |
+
```php
|
388 |
+
<?php
|
389 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
390 |
+
|
391 |
+
// Configure API key authorization: api-key
|
392 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
393 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
394 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
395 |
+
// Configure API key authorization: partner-key
|
396 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
397 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
398 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
399 |
+
|
400 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
401 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
402 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
403 |
+
new GuzzleHttp\Client(),
|
404 |
+
$config
|
405 |
+
);
|
406 |
+
$campaignId = 789; // int | Id of the campaign or template
|
407 |
+
|
408 |
+
try {
|
409 |
+
$result = $apiInstance->getSharedTemplateUrl($campaignId);
|
410 |
+
print_r($result);
|
411 |
+
} catch (Exception $e) {
|
412 |
+
echo 'Exception when calling EmailCampaignsApi->getSharedTemplateUrl: ', $e->getMessage(), PHP_EOL;
|
413 |
+
}
|
414 |
+
?>
|
415 |
+
```
|
416 |
+
|
417 |
+
### Parameters
|
418 |
+
|
419 |
+
Name | Type | Description | Notes
|
420 |
+
------------- | ------------- | ------------- | -------------
|
421 |
+
**campaignId** | **int**| Id of the campaign or template |
|
422 |
+
|
423 |
+
### Return type
|
424 |
+
|
425 |
+
[**\SendinBlue\Client\Model\GetSharedTemplateUrl**](../Model/GetSharedTemplateUrl.md)
|
426 |
+
|
427 |
+
### Authorization
|
428 |
+
|
429 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
430 |
+
|
431 |
+
### HTTP request headers
|
432 |
+
|
433 |
+
- **Content-Type**: application/json
|
434 |
+
- **Accept**: application/json
|
435 |
+
|
436 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
437 |
+
|
438 |
+
# **sendEmailCampaignNow**
|
439 |
+
> sendEmailCampaignNow($campaignId)
|
440 |
+
|
441 |
+
Send an email campaign immediately, based on campaignId
|
442 |
+
|
443 |
+
### Example
|
444 |
+
```php
|
445 |
+
<?php
|
446 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
447 |
+
|
448 |
+
// Configure API key authorization: api-key
|
449 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
450 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
451 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
452 |
+
// Configure API key authorization: partner-key
|
453 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
454 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
455 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
456 |
+
|
457 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
458 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
459 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
460 |
+
new GuzzleHttp\Client(),
|
461 |
+
$config
|
462 |
+
);
|
463 |
+
$campaignId = 789; // int | Id of the campaign
|
464 |
+
|
465 |
+
try {
|
466 |
+
$apiInstance->sendEmailCampaignNow($campaignId);
|
467 |
+
} catch (Exception $e) {
|
468 |
+
echo 'Exception when calling EmailCampaignsApi->sendEmailCampaignNow: ', $e->getMessage(), PHP_EOL;
|
469 |
+
}
|
470 |
+
?>
|
471 |
+
```
|
472 |
+
|
473 |
+
### Parameters
|
474 |
+
|
475 |
+
Name | Type | Description | Notes
|
476 |
+
------------- | ------------- | ------------- | -------------
|
477 |
+
**campaignId** | **int**| Id of the campaign |
|
478 |
+
|
479 |
+
### Return type
|
480 |
+
|
481 |
+
void (empty response body)
|
482 |
+
|
483 |
+
### Authorization
|
484 |
+
|
485 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
486 |
+
|
487 |
+
### HTTP request headers
|
488 |
+
|
489 |
+
- **Content-Type**: application/json
|
490 |
+
- **Accept**: application/json
|
491 |
+
|
492 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
493 |
+
|
494 |
+
# **sendReport**
|
495 |
+
> sendReport($campaignId, $sendReport)
|
496 |
+
|
497 |
+
Send the report of a campaign
|
498 |
+
|
499 |
+
A PDF will be sent to the specified email addresses
|
500 |
+
|
501 |
+
### Example
|
502 |
+
```php
|
503 |
+
<?php
|
504 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
505 |
+
|
506 |
+
// Configure API key authorization: api-key
|
507 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
508 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
509 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
510 |
+
// Configure API key authorization: partner-key
|
511 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
512 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
513 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
514 |
+
|
515 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
516 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
517 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
518 |
+
new GuzzleHttp\Client(),
|
519 |
+
$config
|
520 |
+
);
|
521 |
+
$campaignId = 789; // int | Id of the campaign
|
522 |
+
$sendReport = new \SendinBlue\Client\Model\SendReport(); // \SendinBlue\Client\Model\SendReport | Values for send a report
|
523 |
+
|
524 |
+
try {
|
525 |
+
$apiInstance->sendReport($campaignId, $sendReport);
|
526 |
+
} catch (Exception $e) {
|
527 |
+
echo 'Exception when calling EmailCampaignsApi->sendReport: ', $e->getMessage(), PHP_EOL;
|
528 |
+
}
|
529 |
+
?>
|
530 |
+
```
|
531 |
+
|
532 |
+
### Parameters
|
533 |
+
|
534 |
+
Name | Type | Description | Notes
|
535 |
+
------------- | ------------- | ------------- | -------------
|
536 |
+
**campaignId** | **int**| Id of the campaign |
|
537 |
+
**sendReport** | [**\SendinBlue\Client\Model\SendReport**](../Model/SendReport.md)| Values for send a report |
|
538 |
+
|
539 |
+
### Return type
|
540 |
+
|
541 |
+
void (empty response body)
|
542 |
+
|
543 |
+
### Authorization
|
544 |
+
|
545 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
546 |
+
|
547 |
+
### HTTP request headers
|
548 |
+
|
549 |
+
- **Content-Type**: application/json
|
550 |
+
- **Accept**: application/json
|
551 |
+
|
552 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
553 |
+
|
554 |
+
# **sendTestEmail**
|
555 |
+
> sendTestEmail($campaignId, $emailTo)
|
556 |
+
|
557 |
+
Send an email campaign to your test list
|
558 |
+
|
559 |
+
### Example
|
560 |
+
```php
|
561 |
+
<?php
|
562 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
563 |
+
|
564 |
+
// Configure API key authorization: api-key
|
565 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
566 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
567 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
568 |
+
// Configure API key authorization: partner-key
|
569 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
570 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
571 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
572 |
+
|
573 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
574 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
575 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
576 |
+
new GuzzleHttp\Client(),
|
577 |
+
$config
|
578 |
+
);
|
579 |
+
$campaignId = 789; // int | Id of the campaign
|
580 |
+
$emailTo = new \SendinBlue\Client\Model\SendTestEmail(); // \SendinBlue\Client\Model\SendTestEmail |
|
581 |
+
|
582 |
+
try {
|
583 |
+
$apiInstance->sendTestEmail($campaignId, $emailTo);
|
584 |
+
} catch (Exception $e) {
|
585 |
+
echo 'Exception when calling EmailCampaignsApi->sendTestEmail: ', $e->getMessage(), PHP_EOL;
|
586 |
+
}
|
587 |
+
?>
|
588 |
+
```
|
589 |
+
|
590 |
+
### Parameters
|
591 |
+
|
592 |
+
Name | Type | Description | Notes
|
593 |
+
------------- | ------------- | ------------- | -------------
|
594 |
+
**campaignId** | **int**| Id of the campaign |
|
595 |
+
**emailTo** | [**\SendinBlue\Client\Model\SendTestEmail**](../Model/SendTestEmail.md)| |
|
596 |
+
|
597 |
+
### Return type
|
598 |
+
|
599 |
+
void (empty response body)
|
600 |
+
|
601 |
+
### Authorization
|
602 |
+
|
603 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
604 |
+
|
605 |
+
### HTTP request headers
|
606 |
+
|
607 |
+
- **Content-Type**: application/json
|
608 |
+
- **Accept**: application/json
|
609 |
+
|
610 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
611 |
+
|
612 |
+
# **updateCampaignStatus**
|
613 |
+
> updateCampaignStatus($campaignId, $status)
|
614 |
+
|
615 |
+
Update an email campaign status
|
616 |
+
|
617 |
+
### Example
|
618 |
+
```php
|
619 |
+
<?php
|
620 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
621 |
+
|
622 |
+
// Configure API key authorization: api-key
|
623 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
624 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
625 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
626 |
+
// Configure API key authorization: partner-key
|
627 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
628 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
629 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
630 |
+
|
631 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
632 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
633 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
634 |
+
new GuzzleHttp\Client(),
|
635 |
+
$config
|
636 |
+
);
|
637 |
+
$campaignId = 789; // int | Id of the campaign
|
638 |
+
$status = new \SendinBlue\Client\Model\UpdateCampaignStatus(); // \SendinBlue\Client\Model\UpdateCampaignStatus | Status of the campaign
|
639 |
+
|
640 |
+
try {
|
641 |
+
$apiInstance->updateCampaignStatus($campaignId, $status);
|
642 |
+
} catch (Exception $e) {
|
643 |
+
echo 'Exception when calling EmailCampaignsApi->updateCampaignStatus: ', $e->getMessage(), PHP_EOL;
|
644 |
+
}
|
645 |
+
?>
|
646 |
+
```
|
647 |
+
|
648 |
+
### Parameters
|
649 |
+
|
650 |
+
Name | Type | Description | Notes
|
651 |
+
------------- | ------------- | ------------- | -------------
|
652 |
+
**campaignId** | **int**| Id of the campaign |
|
653 |
+
**status** | [**\SendinBlue\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign |
|
654 |
+
|
655 |
+
### Return type
|
656 |
+
|
657 |
+
void (empty response body)
|
658 |
+
|
659 |
+
### Authorization
|
660 |
+
|
661 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
662 |
+
|
663 |
+
### HTTP request headers
|
664 |
+
|
665 |
+
- **Content-Type**: application/json
|
666 |
+
- **Accept**: application/json
|
667 |
+
|
668 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
669 |
+
|
670 |
+
# **updateEmailCampaign**
|
671 |
+
> updateEmailCampaign($campaignId, $emailCampaign)
|
672 |
+
|
673 |
+
Update an email campaign
|
674 |
+
|
675 |
+
### Example
|
676 |
+
```php
|
677 |
+
<?php
|
678 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
679 |
+
|
680 |
+
// Configure API key authorization: api-key
|
681 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
682 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
683 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
684 |
+
// Configure API key authorization: partner-key
|
685 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
686 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
687 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
688 |
+
|
689 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
690 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
691 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
692 |
+
new GuzzleHttp\Client(),
|
693 |
+
$config
|
694 |
+
);
|
695 |
+
$campaignId = 789; // int | Id of the campaign
|
696 |
+
$emailCampaign = new \SendinBlue\Client\Model\UpdateEmailCampaign(); // \SendinBlue\Client\Model\UpdateEmailCampaign | Values to update a campaign
|
697 |
+
|
698 |
+
try {
|
699 |
+
$apiInstance->updateEmailCampaign($campaignId, $emailCampaign);
|
700 |
+
} catch (Exception $e) {
|
701 |
+
echo 'Exception when calling EmailCampaignsApi->updateEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
702 |
+
}
|
703 |
+
?>
|
704 |
+
```
|
705 |
+
|
706 |
+
### Parameters
|
707 |
+
|
708 |
+
Name | Type | Description | Notes
|
709 |
+
------------- | ------------- | ------------- | -------------
|
710 |
+
**campaignId** | **int**| Id of the campaign |
|
711 |
+
**emailCampaign** | [**\SendinBlue\Client\Model\UpdateEmailCampaign**](../Model/UpdateEmailCampaign.md)| Values to update a campaign |
|
712 |
+
|
713 |
+
### Return type
|
714 |
+
|
715 |
+
void (empty response body)
|
716 |
+
|
717 |
+
### Authorization
|
718 |
+
|
719 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
720 |
+
|
721 |
+
### HTTP request headers
|
722 |
+
|
723 |
+
- **Content-Type**: application/json
|
724 |
+
- **Accept**: application/json
|
725 |
+
|
726 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
727 |
+
|
728 |
+
# **uploadImageToGallery**
|
729 |
+
> uploadImageToGallery($uploadImage)
|
730 |
+
|
731 |
+
Upload an image to your account's image gallery
|
732 |
+
|
733 |
+
### Example
|
734 |
+
```php
|
735 |
+
<?php
|
736 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
737 |
+
|
738 |
+
// Configure API key authorization: api-key
|
739 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
740 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
741 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
742 |
+
// Configure API key authorization: partner-key
|
743 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
744 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
745 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
746 |
+
|
747 |
+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
|
748 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
749 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
750 |
+
new GuzzleHttp\Client(),
|
751 |
+
$config
|
752 |
+
);
|
753 |
+
$uploadImage = new \SendinBlue\Client\Model\UploadImageToGallery(); // \SendinBlue\Client\Model\UploadImageToGallery | Parameters to upload an image
|
754 |
+
|
755 |
+
try {
|
756 |
+
$apiInstance->uploadImageToGallery($uploadImage);
|
757 |
+
} catch (Exception $e) {
|
758 |
+
echo 'Exception when calling EmailCampaignsApi->uploadImageToGallery: ', $e->getMessage(), PHP_EOL;
|
759 |
+
}
|
760 |
+
?>
|
761 |
+
```
|
762 |
+
|
763 |
+
### Parameters
|
764 |
+
|
765 |
+
Name | Type | Description | Notes
|
766 |
+
------------- | ------------- | ------------- | -------------
|
767 |
+
**uploadImage** | [**\SendinBlue\Client\Model\UploadImageToGallery**](../Model/UploadImageToGallery.md)| Parameters to upload an image |
|
768 |
+
|
769 |
+
### Return type
|
770 |
+
|
771 |
+
void (empty response body)
|
772 |
+
|
773 |
+
### Authorization
|
774 |
+
|
775 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
776 |
+
|
777 |
+
### HTTP request headers
|
778 |
+
|
779 |
+
- **Content-Type**: application/json
|
780 |
+
- **Accept**: application/json
|
781 |
+
|
782 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
783 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/FoldersApi.md
ADDED
@@ -0,0 +1,366 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\FoldersApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**createFolder**](FoldersApi.md#createFolder) | **POST** /contacts/folders | Create a folder
|
8 |
+
[**deleteFolder**](FoldersApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
9 |
+
[**getFolder**](FoldersApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
10 |
+
[**getFolderLists**](FoldersApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
11 |
+
[**getFolders**](FoldersApi.md#getFolders) | **GET** /contacts/folders | Get all folders
|
12 |
+
[**updateFolder**](FoldersApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
13 |
+
|
14 |
+
|
15 |
+
# **createFolder**
|
16 |
+
> \SendinBlue\Client\Model\CreateModel createFolder($createFolder)
|
17 |
+
|
18 |
+
Create a folder
|
19 |
+
|
20 |
+
### Example
|
21 |
+
```php
|
22 |
+
<?php
|
23 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
24 |
+
|
25 |
+
// Configure API key authorization: api-key
|
26 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
27 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
28 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
29 |
+
// Configure API key authorization: partner-key
|
30 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
31 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
32 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
33 |
+
|
34 |
+
$apiInstance = new SendinBlue\Client\Api\FoldersApi(
|
35 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
36 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
37 |
+
new GuzzleHttp\Client(),
|
38 |
+
$config
|
39 |
+
);
|
40 |
+
$createFolder = new \SendinBlue\Client\Model\CreateUpdateFolder(); // \SendinBlue\Client\Model\CreateUpdateFolder | Name of the folder
|
41 |
+
|
42 |
+
try {
|
43 |
+
$result = $apiInstance->createFolder($createFolder);
|
44 |
+
print_r($result);
|
45 |
+
} catch (Exception $e) {
|
46 |
+
echo 'Exception when calling FoldersApi->createFolder: ', $e->getMessage(), PHP_EOL;
|
47 |
+
}
|
48 |
+
?>
|
49 |
+
```
|
50 |
+
|
51 |
+
### Parameters
|
52 |
+
|
53 |
+
Name | Type | Description | Notes
|
54 |
+
------------- | ------------- | ------------- | -------------
|
55 |
+
**createFolder** | [**\SendinBlue\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder |
|
56 |
+
|
57 |
+
### Return type
|
58 |
+
|
59 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
60 |
+
|
61 |
+
### Authorization
|
62 |
+
|
63 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
64 |
+
|
65 |
+
### HTTP request headers
|
66 |
+
|
67 |
+
- **Content-Type**: application/json
|
68 |
+
- **Accept**: application/json
|
69 |
+
|
70 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
71 |
+
|
72 |
+
# **deleteFolder**
|
73 |
+
> deleteFolder($folderId)
|
74 |
+
|
75 |
+
Delete a folder (and all its lists)
|
76 |
+
|
77 |
+
### Example
|
78 |
+
```php
|
79 |
+
<?php
|
80 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
81 |
+
|
82 |
+
// Configure API key authorization: api-key
|
83 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
84 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
85 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
86 |
+
// Configure API key authorization: partner-key
|
87 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
88 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
89 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
90 |
+
|
91 |
+
$apiInstance = new SendinBlue\Client\Api\FoldersApi(
|
92 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
93 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
94 |
+
new GuzzleHttp\Client(),
|
95 |
+
$config
|
96 |
+
);
|
97 |
+
$folderId = 789; // int | Id of the folder
|
98 |
+
|
99 |
+
try {
|
100 |
+
$apiInstance->deleteFolder($folderId);
|
101 |
+
} catch (Exception $e) {
|
102 |
+
echo 'Exception when calling FoldersApi->deleteFolder: ', $e->getMessage(), PHP_EOL;
|
103 |
+
}
|
104 |
+
?>
|
105 |
+
```
|
106 |
+
|
107 |
+
### Parameters
|
108 |
+
|
109 |
+
Name | Type | Description | Notes
|
110 |
+
------------- | ------------- | ------------- | -------------
|
111 |
+
**folderId** | **int**| Id of the folder |
|
112 |
+
|
113 |
+
### Return type
|
114 |
+
|
115 |
+
void (empty response body)
|
116 |
+
|
117 |
+
### Authorization
|
118 |
+
|
119 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
120 |
+
|
121 |
+
### HTTP request headers
|
122 |
+
|
123 |
+
- **Content-Type**: application/json
|
124 |
+
- **Accept**: application/json
|
125 |
+
|
126 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
127 |
+
|
128 |
+
# **getFolder**
|
129 |
+
> \SendinBlue\Client\Model\GetFolder getFolder($folderId)
|
130 |
+
|
131 |
+
Returns a folder's details
|
132 |
+
|
133 |
+
### Example
|
134 |
+
```php
|
135 |
+
<?php
|
136 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
137 |
+
|
138 |
+
// Configure API key authorization: api-key
|
139 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
140 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
141 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
142 |
+
// Configure API key authorization: partner-key
|
143 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
144 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
145 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
146 |
+
|
147 |
+
$apiInstance = new SendinBlue\Client\Api\FoldersApi(
|
148 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
149 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
150 |
+
new GuzzleHttp\Client(),
|
151 |
+
$config
|
152 |
+
);
|
153 |
+
$folderId = 789; // int | id of the folder
|
154 |
+
|
155 |
+
try {
|
156 |
+
$result = $apiInstance->getFolder($folderId);
|
157 |
+
print_r($result);
|
158 |
+
} catch (Exception $e) {
|
159 |
+
echo 'Exception when calling FoldersApi->getFolder: ', $e->getMessage(), PHP_EOL;
|
160 |
+
}
|
161 |
+
?>
|
162 |
+
```
|
163 |
+
|
164 |
+
### Parameters
|
165 |
+
|
166 |
+
Name | Type | Description | Notes
|
167 |
+
------------- | ------------- | ------------- | -------------
|
168 |
+
**folderId** | **int**| id of the folder |
|
169 |
+
|
170 |
+
### Return type
|
171 |
+
|
172 |
+
[**\SendinBlue\Client\Model\GetFolder**](../Model/GetFolder.md)
|
173 |
+
|
174 |
+
### Authorization
|
175 |
+
|
176 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
177 |
+
|
178 |
+
### HTTP request headers
|
179 |
+
|
180 |
+
- **Content-Type**: application/json
|
181 |
+
- **Accept**: application/json
|
182 |
+
|
183 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
184 |
+
|
185 |
+
# **getFolderLists**
|
186 |
+
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
|
187 |
+
|
188 |
+
Get lists in a folder
|
189 |
+
|
190 |
+
### Example
|
191 |
+
```php
|
192 |
+
<?php
|
193 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
194 |
+
|
195 |
+
// Configure API key authorization: api-key
|
196 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
197 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
198 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
199 |
+
// Configure API key authorization: partner-key
|
200 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
201 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
202 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
203 |
+
|
204 |
+
$apiInstance = new SendinBlue\Client\Api\FoldersApi(
|
205 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
206 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
207 |
+
new GuzzleHttp\Client(),
|
208 |
+
$config
|
209 |
+
);
|
210 |
+
$folderId = 789; // int | Id of the folder
|
211 |
+
$limit = 10; // int | Number of documents per page
|
212 |
+
$offset = 0; // int | Index of the first document of the page
|
213 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
214 |
+
|
215 |
+
try {
|
216 |
+
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
|
217 |
+
print_r($result);
|
218 |
+
} catch (Exception $e) {
|
219 |
+
echo 'Exception when calling FoldersApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
|
220 |
+
}
|
221 |
+
?>
|
222 |
+
```
|
223 |
+
|
224 |
+
### Parameters
|
225 |
+
|
226 |
+
Name | Type | Description | Notes
|
227 |
+
------------- | ------------- | ------------- | -------------
|
228 |
+
**folderId** | **int**| Id of the folder |
|
229 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
230 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
231 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
232 |
+
|
233 |
+
### Return type
|
234 |
+
|
235 |
+
[**\SendinBlue\Client\Model\GetFolderLists**](../Model/GetFolderLists.md)
|
236 |
+
|
237 |
+
### Authorization
|
238 |
+
|
239 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
240 |
+
|
241 |
+
### HTTP request headers
|
242 |
+
|
243 |
+
- **Content-Type**: application/json
|
244 |
+
- **Accept**: application/json
|
245 |
+
|
246 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
247 |
+
|
248 |
+
# **getFolders**
|
249 |
+
> \SendinBlue\Client\Model\GetFolders getFolders($limit, $offset, $sort)
|
250 |
+
|
251 |
+
Get all folders
|
252 |
+
|
253 |
+
### Example
|
254 |
+
```php
|
255 |
+
<?php
|
256 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
257 |
+
|
258 |
+
// Configure API key authorization: api-key
|
259 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
260 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
261 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
262 |
+
// Configure API key authorization: partner-key
|
263 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
264 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
265 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
266 |
+
|
267 |
+
$apiInstance = new SendinBlue\Client\Api\FoldersApi(
|
268 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
269 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
270 |
+
new GuzzleHttp\Client(),
|
271 |
+
$config
|
272 |
+
);
|
273 |
+
$limit = 10; // int | Number of documents per page
|
274 |
+
$offset = 0; // int | Index of the first document of the page
|
275 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
276 |
+
|
277 |
+
try {
|
278 |
+
$result = $apiInstance->getFolders($limit, $offset, $sort);
|
279 |
+
print_r($result);
|
280 |
+
} catch (Exception $e) {
|
281 |
+
echo 'Exception when calling FoldersApi->getFolders: ', $e->getMessage(), PHP_EOL;
|
282 |
+
}
|
283 |
+
?>
|
284 |
+
```
|
285 |
+
|
286 |
+
### Parameters
|
287 |
+
|
288 |
+
Name | Type | Description | Notes
|
289 |
+
------------- | ------------- | ------------- | -------------
|
290 |
+
**limit** | **int**| Number of documents per page | [default to 10]
|
291 |
+
**offset** | **int**| Index of the first document of the page | [default to 0]
|
292 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
293 |
+
|
294 |
+
### Return type
|
295 |
+
|
296 |
+
[**\SendinBlue\Client\Model\GetFolders**](../Model/GetFolders.md)
|
297 |
+
|
298 |
+
### Authorization
|
299 |
+
|
300 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
301 |
+
|
302 |
+
### HTTP request headers
|
303 |
+
|
304 |
+
- **Content-Type**: application/json
|
305 |
+
- **Accept**: application/json
|
306 |
+
|
307 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
308 |
+
|
309 |
+
# **updateFolder**
|
310 |
+
> updateFolder($folderId, $updateFolder)
|
311 |
+
|
312 |
+
Update a folder
|
313 |
+
|
314 |
+
### Example
|
315 |
+
```php
|
316 |
+
<?php
|
317 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
318 |
+
|
319 |
+
// Configure API key authorization: api-key
|
320 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
321 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
322 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
323 |
+
// Configure API key authorization: partner-key
|
324 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
325 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
326 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
327 |
+
|
328 |
+
$apiInstance = new SendinBlue\Client\Api\FoldersApi(
|
329 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
330 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
331 |
+
new GuzzleHttp\Client(),
|
332 |
+
$config
|
333 |
+
);
|
334 |
+
$folderId = 789; // int | Id of the folder
|
335 |
+
$updateFolder = new \SendinBlue\Client\Model\CreateUpdateFolder(); // \SendinBlue\Client\Model\CreateUpdateFolder | Name of the folder
|
336 |
+
|
337 |
+
try {
|
338 |
+
$apiInstance->updateFolder($folderId, $updateFolder);
|
339 |
+
} catch (Exception $e) {
|
340 |
+
echo 'Exception when calling FoldersApi->updateFolder: ', $e->getMessage(), PHP_EOL;
|
341 |
+
}
|
342 |
+
?>
|
343 |
+
```
|
344 |
+
|
345 |
+
### Parameters
|
346 |
+
|
347 |
+
Name | Type | Description | Notes
|
348 |
+
------------- | ------------- | ------------- | -------------
|
349 |
+
**folderId** | **int**| Id of the folder |
|
350 |
+
**updateFolder** | [**\SendinBlue\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder |
|
351 |
+
|
352 |
+
### Return type
|
353 |
+
|
354 |
+
void (empty response body)
|
355 |
+
|
356 |
+
### Authorization
|
357 |
+
|
358 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
359 |
+
|
360 |
+
### HTTP request headers
|
361 |
+
|
362 |
+
- **Content-Type**: application/json
|
363 |
+
- **Accept**: application/json
|
364 |
+
|
365 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
366 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/InboundParsingApi.md
ADDED
@@ -0,0 +1,138 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\InboundParsingApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**getInboundEmailEvents**](InboundParsingApi.md#getInboundEmailEvents) | **GET** /inbound/events | Get the list of all the events for the received emails.
|
8 |
+
[**getInboundEmailEventsByUuid**](InboundParsingApi.md#getInboundEmailEventsByUuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
|
9 |
+
|
10 |
+
|
11 |
+
# **getInboundEmailEvents**
|
12 |
+
> \SendinBlue\Client\Model\GetInboundEmailEvents getInboundEmailEvents($sender, $startDate, $endDate, $limit, $offset, $sort)
|
13 |
+
|
14 |
+
Get the list of all the events for the received emails.
|
15 |
+
|
16 |
+
This endpoint will show the list of all the events for the received emails.
|
17 |
+
|
18 |
+
### Example
|
19 |
+
```php
|
20 |
+
<?php
|
21 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
22 |
+
|
23 |
+
// Configure API key authorization: api-key
|
24 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
25 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
26 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
27 |
+
// Configure API key authorization: partner-key
|
28 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
29 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
30 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
31 |
+
|
32 |
+
$apiInstance = new SendinBlue\Client\Api\InboundParsingApi(
|
33 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
34 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
35 |
+
new GuzzleHttp\Client(),
|
36 |
+
$config
|
37 |
+
);
|
38 |
+
$sender = "sender_example"; // string | Email address of the sender.
|
39 |
+
$startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
40 |
+
$endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
41 |
+
$limit = 100; // int | Number of documents returned per page
|
42 |
+
$offset = 0; // int | Index of the first document on the page
|
43 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
|
44 |
+
|
45 |
+
try {
|
46 |
+
$result = $apiInstance->getInboundEmailEvents($sender, $startDate, $endDate, $limit, $offset, $sort);
|
47 |
+
print_r($result);
|
48 |
+
} catch (Exception $e) {
|
49 |
+
echo 'Exception when calling InboundParsingApi->getInboundEmailEvents: ', $e->getMessage(), PHP_EOL;
|
50 |
+
}
|
51 |
+
?>
|
52 |
+
```
|
53 |
+
|
54 |
+
### Parameters
|
55 |
+
|
56 |
+
Name | Type | Description | Notes
|
57 |
+
------------- | ------------- | ------------- | -------------
|
58 |
+
**sender** | **string**| Email address of the sender. | [optional]
|
59 |
+
**startDate** | **\DateTime**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
60 |
+
**endDate** | **\DateTime**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
61 |
+
**limit** | **int**| Number of documents returned per page | [optional] [default to 100]
|
62 |
+
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
|
63 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
64 |
+
|
65 |
+
### Return type
|
66 |
+
|
67 |
+
[**\SendinBlue\Client\Model\GetInboundEmailEvents**](../Model/GetInboundEmailEvents.md)
|
68 |
+
|
69 |
+
### Authorization
|
70 |
+
|
71 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
72 |
+
|
73 |
+
### HTTP request headers
|
74 |
+
|
75 |
+
- **Content-Type**: application/json
|
76 |
+
- **Accept**: application/json
|
77 |
+
|
78 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
79 |
+
|
80 |
+
# **getInboundEmailEventsByUuid**
|
81 |
+
> \SendinBlue\Client\Model\GetInboundEmailEventsByUuid getInboundEmailEventsByUuid($uuid)
|
82 |
+
|
83 |
+
Fetch all events history for one particular received email.
|
84 |
+
|
85 |
+
This endpoint will show the list of all events history for one particular received email.
|
86 |
+
|
87 |
+
### Example
|
88 |
+
```php
|
89 |
+
<?php
|
90 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
91 |
+
|
92 |
+
// Configure API key authorization: api-key
|
93 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
94 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
95 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
96 |
+
// Configure API key authorization: partner-key
|
97 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
98 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
99 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
100 |
+
|
101 |
+
$apiInstance = new SendinBlue\Client\Api\InboundParsingApi(
|
102 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
103 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
104 |
+
new GuzzleHttp\Client(),
|
105 |
+
$config
|
106 |
+
);
|
107 |
+
$uuid = "uuid_example"; // string | UUID to fetch events specific to recieved email
|
108 |
+
|
109 |
+
try {
|
110 |
+
$result = $apiInstance->getInboundEmailEventsByUuid($uuid);
|
111 |
+
print_r($result);
|
112 |
+
} catch (Exception $e) {
|
113 |
+
echo 'Exception when calling InboundParsingApi->getInboundEmailEventsByUuid: ', $e->getMessage(), PHP_EOL;
|
114 |
+
}
|
115 |
+
?>
|
116 |
+
```
|
117 |
+
|
118 |
+
### Parameters
|
119 |
+
|
120 |
+
Name | Type | Description | Notes
|
121 |
+
------------- | ------------- | ------------- | -------------
|
122 |
+
**uuid** | **string**| UUID to fetch events specific to recieved email |
|
123 |
+
|
124 |
+
### Return type
|
125 |
+
|
126 |
+
[**\SendinBlue\Client\Model\GetInboundEmailEventsByUuid**](../Model/GetInboundEmailEventsByUuid.md)
|
127 |
+
|
128 |
+
### Authorization
|
129 |
+
|
130 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
131 |
+
|
132 |
+
### HTTP request headers
|
133 |
+
|
134 |
+
- **Content-Type**: application/json
|
135 |
+
- **Accept**: application/json
|
136 |
+
|
137 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
138 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/ListsApi.md
ADDED
@@ -0,0 +1,552 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\ListsApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**addContactToList**](ListsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
8 |
+
[**createList**](ListsApi.md#createList) | **POST** /contacts/lists | Create a list
|
9 |
+
[**deleteList**](ListsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
|
10 |
+
[**getContactsFromList**](ListsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
11 |
+
[**getFolderLists**](ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
12 |
+
[**getList**](ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details
|
13 |
+
[**getLists**](ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
|
14 |
+
[**removeContactFromList**](ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
15 |
+
[**updateList**](ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
|
16 |
+
|
17 |
+
|
18 |
+
# **addContactToList**
|
19 |
+
> \SendinBlue\Client\Model\PostContactInfo addContactToList($listId, $contactEmails)
|
20 |
+
|
21 |
+
Add existing contacts to a list
|
22 |
+
|
23 |
+
### Example
|
24 |
+
```php
|
25 |
+
<?php
|
26 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
27 |
+
|
28 |
+
// Configure API key authorization: api-key
|
29 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
30 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
31 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
32 |
+
// Configure API key authorization: partner-key
|
33 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
34 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
35 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
36 |
+
|
37 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
38 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
39 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
40 |
+
new GuzzleHttp\Client(),
|
41 |
+
$config
|
42 |
+
);
|
43 |
+
$listId = 789; // int | Id of the list
|
44 |
+
$contactEmails = new \SendinBlue\Client\Model\AddContactToList(); // \SendinBlue\Client\Model\AddContactToList | Emails addresses OR IDs of the contacts
|
45 |
+
|
46 |
+
try {
|
47 |
+
$result = $apiInstance->addContactToList($listId, $contactEmails);
|
48 |
+
print_r($result);
|
49 |
+
} catch (Exception $e) {
|
50 |
+
echo 'Exception when calling ListsApi->addContactToList: ', $e->getMessage(), PHP_EOL;
|
51 |
+
}
|
52 |
+
?>
|
53 |
+
```
|
54 |
+
|
55 |
+
### Parameters
|
56 |
+
|
57 |
+
Name | Type | Description | Notes
|
58 |
+
------------- | ------------- | ------------- | -------------
|
59 |
+
**listId** | **int**| Id of the list |
|
60 |
+
**contactEmails** | [**\SendinBlue\Client\Model\AddContactToList**](../Model/AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
61 |
+
|
62 |
+
### Return type
|
63 |
+
|
64 |
+
[**\SendinBlue\Client\Model\PostContactInfo**](../Model/PostContactInfo.md)
|
65 |
+
|
66 |
+
### Authorization
|
67 |
+
|
68 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
69 |
+
|
70 |
+
### HTTP request headers
|
71 |
+
|
72 |
+
- **Content-Type**: application/json
|
73 |
+
- **Accept**: application/json
|
74 |
+
|
75 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
76 |
+
|
77 |
+
# **createList**
|
78 |
+
> \SendinBlue\Client\Model\CreateModel createList($createList)
|
79 |
+
|
80 |
+
Create a list
|
81 |
+
|
82 |
+
### Example
|
83 |
+
```php
|
84 |
+
<?php
|
85 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
86 |
+
|
87 |
+
// Configure API key authorization: api-key
|
88 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
89 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
90 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
91 |
+
// Configure API key authorization: partner-key
|
92 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
93 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
94 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
95 |
+
|
96 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
97 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
98 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
99 |
+
new GuzzleHttp\Client(),
|
100 |
+
$config
|
101 |
+
);
|
102 |
+
$createList = new \SendinBlue\Client\Model\CreateList(); // \SendinBlue\Client\Model\CreateList | Values to create a list
|
103 |
+
|
104 |
+
try {
|
105 |
+
$result = $apiInstance->createList($createList);
|
106 |
+
print_r($result);
|
107 |
+
} catch (Exception $e) {
|
108 |
+
echo 'Exception when calling ListsApi->createList: ', $e->getMessage(), PHP_EOL;
|
109 |
+
}
|
110 |
+
?>
|
111 |
+
```
|
112 |
+
|
113 |
+
### Parameters
|
114 |
+
|
115 |
+
Name | Type | Description | Notes
|
116 |
+
------------- | ------------- | ------------- | -------------
|
117 |
+
**createList** | [**\SendinBlue\Client\Model\CreateList**](../Model/CreateList.md)| Values to create a list |
|
118 |
+
|
119 |
+
### Return type
|
120 |
+
|
121 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
122 |
+
|
123 |
+
### Authorization
|
124 |
+
|
125 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
126 |
+
|
127 |
+
### HTTP request headers
|
128 |
+
|
129 |
+
- **Content-Type**: application/json
|
130 |
+
- **Accept**: application/json
|
131 |
+
|
132 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
133 |
+
|
134 |
+
# **deleteList**
|
135 |
+
> deleteList($listId)
|
136 |
+
|
137 |
+
Delete a list
|
138 |
+
|
139 |
+
### Example
|
140 |
+
```php
|
141 |
+
<?php
|
142 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
143 |
+
|
144 |
+
// Configure API key authorization: api-key
|
145 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
146 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
147 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
148 |
+
// Configure API key authorization: partner-key
|
149 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
150 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
151 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
152 |
+
|
153 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
154 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
155 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
156 |
+
new GuzzleHttp\Client(),
|
157 |
+
$config
|
158 |
+
);
|
159 |
+
$listId = 789; // int | Id of the list
|
160 |
+
|
161 |
+
try {
|
162 |
+
$apiInstance->deleteList($listId);
|
163 |
+
} catch (Exception $e) {
|
164 |
+
echo 'Exception when calling ListsApi->deleteList: ', $e->getMessage(), PHP_EOL;
|
165 |
+
}
|
166 |
+
?>
|
167 |
+
```
|
168 |
+
|
169 |
+
### Parameters
|
170 |
+
|
171 |
+
Name | Type | Description | Notes
|
172 |
+
------------- | ------------- | ------------- | -------------
|
173 |
+
**listId** | **int**| Id of the list |
|
174 |
+
|
175 |
+
### Return type
|
176 |
+
|
177 |
+
void (empty response body)
|
178 |
+
|
179 |
+
### Authorization
|
180 |
+
|
181 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
182 |
+
|
183 |
+
### HTTP request headers
|
184 |
+
|
185 |
+
- **Content-Type**: application/json
|
186 |
+
- **Accept**: application/json
|
187 |
+
|
188 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
189 |
+
|
190 |
+
# **getContactsFromList**
|
191 |
+
> \SendinBlue\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort)
|
192 |
+
|
193 |
+
Get contacts in a list
|
194 |
+
|
195 |
+
### Example
|
196 |
+
```php
|
197 |
+
<?php
|
198 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
199 |
+
|
200 |
+
// Configure API key authorization: api-key
|
201 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
202 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
203 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
204 |
+
// Configure API key authorization: partner-key
|
205 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
206 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
207 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
208 |
+
|
209 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
210 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
211 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
212 |
+
new GuzzleHttp\Client(),
|
213 |
+
$config
|
214 |
+
);
|
215 |
+
$listId = 789; // int | Id of the list
|
216 |
+
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
217 |
+
$limit = 50; // int | Number of documents per page
|
218 |
+
$offset = 0; // int | Index of the first document of the page
|
219 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
220 |
+
|
221 |
+
try {
|
222 |
+
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
|
223 |
+
print_r($result);
|
224 |
+
} catch (Exception $e) {
|
225 |
+
echo 'Exception when calling ListsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL;
|
226 |
+
}
|
227 |
+
?>
|
228 |
+
```
|
229 |
+
|
230 |
+
### Parameters
|
231 |
+
|
232 |
+
Name | Type | Description | Notes
|
233 |
+
------------- | ------------- | ------------- | -------------
|
234 |
+
**listId** | **int**| Id of the list |
|
235 |
+
**modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
236 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
237 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
238 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
239 |
+
|
240 |
+
### Return type
|
241 |
+
|
242 |
+
[**\SendinBlue\Client\Model\GetContacts**](../Model/GetContacts.md)
|
243 |
+
|
244 |
+
### Authorization
|
245 |
+
|
246 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
247 |
+
|
248 |
+
### HTTP request headers
|
249 |
+
|
250 |
+
- **Content-Type**: application/json
|
251 |
+
- **Accept**: application/json
|
252 |
+
|
253 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
254 |
+
|
255 |
+
# **getFolderLists**
|
256 |
+
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
|
257 |
+
|
258 |
+
Get lists in a folder
|
259 |
+
|
260 |
+
### Example
|
261 |
+
```php
|
262 |
+
<?php
|
263 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
264 |
+
|
265 |
+
// Configure API key authorization: api-key
|
266 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
267 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
268 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
269 |
+
// Configure API key authorization: partner-key
|
270 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
271 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
272 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
273 |
+
|
274 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
275 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
276 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
277 |
+
new GuzzleHttp\Client(),
|
278 |
+
$config
|
279 |
+
);
|
280 |
+
$folderId = 789; // int | Id of the folder
|
281 |
+
$limit = 10; // int | Number of documents per page
|
282 |
+
$offset = 0; // int | Index of the first document of the page
|
283 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
284 |
+
|
285 |
+
try {
|
286 |
+
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
|
287 |
+
print_r($result);
|
288 |
+
} catch (Exception $e) {
|
289 |
+
echo 'Exception when calling ListsApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
|
290 |
+
}
|
291 |
+
?>
|
292 |
+
```
|
293 |
+
|
294 |
+
### Parameters
|
295 |
+
|
296 |
+
Name | Type | Description | Notes
|
297 |
+
------------- | ------------- | ------------- | -------------
|
298 |
+
**folderId** | **int**| Id of the folder |
|
299 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
300 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
301 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
302 |
+
|
303 |
+
### Return type
|
304 |
+
|
305 |
+
[**\SendinBlue\Client\Model\GetFolderLists**](../Model/GetFolderLists.md)
|
306 |
+
|
307 |
+
### Authorization
|
308 |
+
|
309 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
310 |
+
|
311 |
+
### HTTP request headers
|
312 |
+
|
313 |
+
- **Content-Type**: application/json
|
314 |
+
- **Accept**: application/json
|
315 |
+
|
316 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
317 |
+
|
318 |
+
# **getList**
|
319 |
+
> \SendinBlue\Client\Model\GetExtendedList getList($listId)
|
320 |
+
|
321 |
+
Get a list's details
|
322 |
+
|
323 |
+
### Example
|
324 |
+
```php
|
325 |
+
<?php
|
326 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
327 |
+
|
328 |
+
// Configure API key authorization: api-key
|
329 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
330 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
331 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
332 |
+
// Configure API key authorization: partner-key
|
333 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
334 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
335 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
336 |
+
|
337 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
338 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
339 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
340 |
+
new GuzzleHttp\Client(),
|
341 |
+
$config
|
342 |
+
);
|
343 |
+
$listId = 789; // int | Id of the list
|
344 |
+
|
345 |
+
try {
|
346 |
+
$result = $apiInstance->getList($listId);
|
347 |
+
print_r($result);
|
348 |
+
} catch (Exception $e) {
|
349 |
+
echo 'Exception when calling ListsApi->getList: ', $e->getMessage(), PHP_EOL;
|
350 |
+
}
|
351 |
+
?>
|
352 |
+
```
|
353 |
+
|
354 |
+
### Parameters
|
355 |
+
|
356 |
+
Name | Type | Description | Notes
|
357 |
+
------------- | ------------- | ------------- | -------------
|
358 |
+
**listId** | **int**| Id of the list |
|
359 |
+
|
360 |
+
### Return type
|
361 |
+
|
362 |
+
[**\SendinBlue\Client\Model\GetExtendedList**](../Model/GetExtendedList.md)
|
363 |
+
|
364 |
+
### Authorization
|
365 |
+
|
366 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
367 |
+
|
368 |
+
### HTTP request headers
|
369 |
+
|
370 |
+
- **Content-Type**: application/json
|
371 |
+
- **Accept**: application/json
|
372 |
+
|
373 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
374 |
+
|
375 |
+
# **getLists**
|
376 |
+
> \SendinBlue\Client\Model\GetLists getLists($limit, $offset, $sort)
|
377 |
+
|
378 |
+
Get all the lists
|
379 |
+
|
380 |
+
### Example
|
381 |
+
```php
|
382 |
+
<?php
|
383 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
384 |
+
|
385 |
+
// Configure API key authorization: api-key
|
386 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
387 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
388 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
389 |
+
// Configure API key authorization: partner-key
|
390 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
391 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
392 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
393 |
+
|
394 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
395 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
396 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
397 |
+
new GuzzleHttp\Client(),
|
398 |
+
$config
|
399 |
+
);
|
400 |
+
$limit = 10; // int | Number of documents per page
|
401 |
+
$offset = 0; // int | Index of the first document of the page
|
402 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
403 |
+
|
404 |
+
try {
|
405 |
+
$result = $apiInstance->getLists($limit, $offset, $sort);
|
406 |
+
print_r($result);
|
407 |
+
} catch (Exception $e) {
|
408 |
+
echo 'Exception when calling ListsApi->getLists: ', $e->getMessage(), PHP_EOL;
|
409 |
+
}
|
410 |
+
?>
|
411 |
+
```
|
412 |
+
|
413 |
+
### Parameters
|
414 |
+
|
415 |
+
Name | Type | Description | Notes
|
416 |
+
------------- | ------------- | ------------- | -------------
|
417 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
418 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
419 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
420 |
+
|
421 |
+
### Return type
|
422 |
+
|
423 |
+
[**\SendinBlue\Client\Model\GetLists**](../Model/GetLists.md)
|
424 |
+
|
425 |
+
### Authorization
|
426 |
+
|
427 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
428 |
+
|
429 |
+
### HTTP request headers
|
430 |
+
|
431 |
+
- **Content-Type**: application/json
|
432 |
+
- **Accept**: application/json
|
433 |
+
|
434 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
435 |
+
|
436 |
+
# **removeContactFromList**
|
437 |
+
> \SendinBlue\Client\Model\PostContactInfo removeContactFromList($listId, $contactEmails)
|
438 |
+
|
439 |
+
Delete a contact from a list
|
440 |
+
|
441 |
+
### Example
|
442 |
+
```php
|
443 |
+
<?php
|
444 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
445 |
+
|
446 |
+
// Configure API key authorization: api-key
|
447 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
448 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
449 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
450 |
+
// Configure API key authorization: partner-key
|
451 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
452 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
453 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
454 |
+
|
455 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
456 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
457 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
458 |
+
new GuzzleHttp\Client(),
|
459 |
+
$config
|
460 |
+
);
|
461 |
+
$listId = 789; // int | Id of the list
|
462 |
+
$contactEmails = new \SendinBlue\Client\Model\RemoveContactFromList(); // \SendinBlue\Client\Model\RemoveContactFromList | Emails addresses OR IDs of the contacts
|
463 |
+
|
464 |
+
try {
|
465 |
+
$result = $apiInstance->removeContactFromList($listId, $contactEmails);
|
466 |
+
print_r($result);
|
467 |
+
} catch (Exception $e) {
|
468 |
+
echo 'Exception when calling ListsApi->removeContactFromList: ', $e->getMessage(), PHP_EOL;
|
469 |
+
}
|
470 |
+
?>
|
471 |
+
```
|
472 |
+
|
473 |
+
### Parameters
|
474 |
+
|
475 |
+
Name | Type | Description | Notes
|
476 |
+
------------- | ------------- | ------------- | -------------
|
477 |
+
**listId** | **int**| Id of the list |
|
478 |
+
**contactEmails** | [**\SendinBlue\Client\Model\RemoveContactFromList**](../Model/RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
479 |
+
|
480 |
+
### Return type
|
481 |
+
|
482 |
+
[**\SendinBlue\Client\Model\PostContactInfo**](../Model/PostContactInfo.md)
|
483 |
+
|
484 |
+
### Authorization
|
485 |
+
|
486 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
487 |
+
|
488 |
+
### HTTP request headers
|
489 |
+
|
490 |
+
- **Content-Type**: application/json
|
491 |
+
- **Accept**: application/json
|
492 |
+
|
493 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
494 |
+
|
495 |
+
# **updateList**
|
496 |
+
> updateList($listId, $updateList)
|
497 |
+
|
498 |
+
Update a list
|
499 |
+
|
500 |
+
### Example
|
501 |
+
```php
|
502 |
+
<?php
|
503 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
504 |
+
|
505 |
+
// Configure API key authorization: api-key
|
506 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
507 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
508 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
509 |
+
// Configure API key authorization: partner-key
|
510 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
511 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
512 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
513 |
+
|
514 |
+
$apiInstance = new SendinBlue\Client\Api\ListsApi(
|
515 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
516 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
517 |
+
new GuzzleHttp\Client(),
|
518 |
+
$config
|
519 |
+
);
|
520 |
+
$listId = 789; // int | Id of the list
|
521 |
+
$updateList = new \SendinBlue\Client\Model\UpdateList(); // \SendinBlue\Client\Model\UpdateList | Values to update a list
|
522 |
+
|
523 |
+
try {
|
524 |
+
$apiInstance->updateList($listId, $updateList);
|
525 |
+
} catch (Exception $e) {
|
526 |
+
echo 'Exception when calling ListsApi->updateList: ', $e->getMessage(), PHP_EOL;
|
527 |
+
}
|
528 |
+
?>
|
529 |
+
```
|
530 |
+
|
531 |
+
### Parameters
|
532 |
+
|
533 |
+
Name | Type | Description | Notes
|
534 |
+
------------- | ------------- | ------------- | -------------
|
535 |
+
**listId** | **int**| Id of the list |
|
536 |
+
**updateList** | [**\SendinBlue\Client\Model\UpdateList**](../Model/UpdateList.md)| Values to update a list |
|
537 |
+
|
538 |
+
### Return type
|
539 |
+
|
540 |
+
void (empty response body)
|
541 |
+
|
542 |
+
### Authorization
|
543 |
+
|
544 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
545 |
+
|
546 |
+
### HTTP request headers
|
547 |
+
|
548 |
+
- **Content-Type**: application/json
|
549 |
+
- **Accept**: application/json
|
550 |
+
|
551 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
552 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/MasterAccountApi.md
ADDED
@@ -0,0 +1,424 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\MasterAccountApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**corporateMasterAccountGet**](MasterAccountApi.md#corporateMasterAccountGet) | **GET** /corporate/masterAccount | Get the details of requested master account
|
8 |
+
[**corporateSubAccountGet**](MasterAccountApi.md#corporateSubAccountGet) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
|
9 |
+
[**corporateSubAccountIdDelete**](MasterAccountApi.md#corporateSubAccountIdDelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
|
10 |
+
[**corporateSubAccountIdGet**](MasterAccountApi.md#corporateSubAccountIdGet) | **GET** /corporate/subAccount/{id} | Get sub-account details
|
11 |
+
[**corporateSubAccountIdPlanPut**](MasterAccountApi.md#corporateSubAccountIdPlanPut) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
12 |
+
[**corporateSubAccountPost**](MasterAccountApi.md#corporateSubAccountPost) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
13 |
+
[**corporateSubAccountSsoTokenPost**](MasterAccountApi.md#corporateSubAccountSsoTokenPost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Sendinblue
|
14 |
+
|
15 |
+
|
16 |
+
# **corporateMasterAccountGet**
|
17 |
+
> \SendinBlue\Client\Model\MasterDetailsResponse corporateMasterAccountGet()
|
18 |
+
|
19 |
+
Get the details of requested master account
|
20 |
+
|
21 |
+
This endpoint will provide the details of the master account.
|
22 |
+
|
23 |
+
### Example
|
24 |
+
```php
|
25 |
+
<?php
|
26 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
27 |
+
|
28 |
+
// Configure API key authorization: api-key
|
29 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
30 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
31 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
32 |
+
// Configure API key authorization: partner-key
|
33 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
34 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
35 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
36 |
+
|
37 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
38 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
39 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
40 |
+
new GuzzleHttp\Client(),
|
41 |
+
$config
|
42 |
+
);
|
43 |
+
|
44 |
+
try {
|
45 |
+
$result = $apiInstance->corporateMasterAccountGet();
|
46 |
+
print_r($result);
|
47 |
+
} catch (Exception $e) {
|
48 |
+
echo 'Exception when calling MasterAccountApi->corporateMasterAccountGet: ', $e->getMessage(), PHP_EOL;
|
49 |
+
}
|
50 |
+
?>
|
51 |
+
```
|
52 |
+
|
53 |
+
### Parameters
|
54 |
+
This endpoint does not need any parameter.
|
55 |
+
|
56 |
+
### Return type
|
57 |
+
|
58 |
+
[**\SendinBlue\Client\Model\MasterDetailsResponse**](../Model/MasterDetailsResponse.md)
|
59 |
+
|
60 |
+
### Authorization
|
61 |
+
|
62 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
63 |
+
|
64 |
+
### HTTP request headers
|
65 |
+
|
66 |
+
- **Content-Type**: application/json
|
67 |
+
- **Accept**: application/json
|
68 |
+
|
69 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
70 |
+
|
71 |
+
# **corporateSubAccountGet**
|
72 |
+
> \SendinBlue\Client\Model\SubAccountsResponse corporateSubAccountGet($offset, $limit)
|
73 |
+
|
74 |
+
Get the list of all the sub-accounts of the master account.
|
75 |
+
|
76 |
+
This endpoint will provide the list all the sub-accounts of the master account.
|
77 |
+
|
78 |
+
### Example
|
79 |
+
```php
|
80 |
+
<?php
|
81 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
82 |
+
|
83 |
+
// Configure API key authorization: api-key
|
84 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
85 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
86 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
87 |
+
// Configure API key authorization: partner-key
|
88 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
89 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
90 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
91 |
+
|
92 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
93 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
94 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
95 |
+
new GuzzleHttp\Client(),
|
96 |
+
$config
|
97 |
+
);
|
98 |
+
$offset = 56; // int | Index of the first sub-account in the page
|
99 |
+
$limit = 56; // int | Number of sub-accounts to be displayed on each page
|
100 |
+
|
101 |
+
try {
|
102 |
+
$result = $apiInstance->corporateSubAccountGet($offset, $limit);
|
103 |
+
print_r($result);
|
104 |
+
} catch (Exception $e) {
|
105 |
+
echo 'Exception when calling MasterAccountApi->corporateSubAccountGet: ', $e->getMessage(), PHP_EOL;
|
106 |
+
}
|
107 |
+
?>
|
108 |
+
```
|
109 |
+
|
110 |
+
### Parameters
|
111 |
+
|
112 |
+
Name | Type | Description | Notes
|
113 |
+
------------- | ------------- | ------------- | -------------
|
114 |
+
**offset** | **int**| Index of the first sub-account in the page |
|
115 |
+
**limit** | **int**| Number of sub-accounts to be displayed on each page |
|
116 |
+
|
117 |
+
### Return type
|
118 |
+
|
119 |
+
[**\SendinBlue\Client\Model\SubAccountsResponse**](../Model/SubAccountsResponse.md)
|
120 |
+
|
121 |
+
### Authorization
|
122 |
+
|
123 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
124 |
+
|
125 |
+
### HTTP request headers
|
126 |
+
|
127 |
+
- **Content-Type**: application/json
|
128 |
+
- **Accept**: application/json
|
129 |
+
|
130 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
131 |
+
|
132 |
+
# **corporateSubAccountIdDelete**
|
133 |
+
> corporateSubAccountIdDelete($id)
|
134 |
+
|
135 |
+
Delete a sub-account
|
136 |
+
|
137 |
+
### Example
|
138 |
+
```php
|
139 |
+
<?php
|
140 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
141 |
+
|
142 |
+
// Configure API key authorization: api-key
|
143 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
144 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
145 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
146 |
+
// Configure API key authorization: partner-key
|
147 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
148 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
149 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
150 |
+
|
151 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
152 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
153 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
154 |
+
new GuzzleHttp\Client(),
|
155 |
+
$config
|
156 |
+
);
|
157 |
+
$id = 789; // int | Id of the sub-account organization to be deleted
|
158 |
+
|
159 |
+
try {
|
160 |
+
$apiInstance->corporateSubAccountIdDelete($id);
|
161 |
+
} catch (Exception $e) {
|
162 |
+
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdDelete: ', $e->getMessage(), PHP_EOL;
|
163 |
+
}
|
164 |
+
?>
|
165 |
+
```
|
166 |
+
|
167 |
+
### Parameters
|
168 |
+
|
169 |
+
Name | Type | Description | Notes
|
170 |
+
------------- | ------------- | ------------- | -------------
|
171 |
+
**id** | **int**| Id of the sub-account organization to be deleted |
|
172 |
+
|
173 |
+
### Return type
|
174 |
+
|
175 |
+
void (empty response body)
|
176 |
+
|
177 |
+
### Authorization
|
178 |
+
|
179 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
180 |
+
|
181 |
+
### HTTP request headers
|
182 |
+
|
183 |
+
- **Content-Type**: application/json
|
184 |
+
- **Accept**: application/json
|
185 |
+
|
186 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
187 |
+
|
188 |
+
# **corporateSubAccountIdGet**
|
189 |
+
> \SendinBlue\Client\Model\SubAccountDetailsResponse corporateSubAccountIdGet($id)
|
190 |
+
|
191 |
+
Get sub-account details
|
192 |
+
|
193 |
+
This endpoint will provide the details for the specified sub-account company
|
194 |
+
|
195 |
+
### Example
|
196 |
+
```php
|
197 |
+
<?php
|
198 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
199 |
+
|
200 |
+
// Configure API key authorization: api-key
|
201 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
202 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
203 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
204 |
+
// Configure API key authorization: partner-key
|
205 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
206 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
207 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
208 |
+
|
209 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
210 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
211 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
212 |
+
new GuzzleHttp\Client(),
|
213 |
+
$config
|
214 |
+
);
|
215 |
+
$id = 789; // int | Id of the sub-account organization
|
216 |
+
|
217 |
+
try {
|
218 |
+
$result = $apiInstance->corporateSubAccountIdGet($id);
|
219 |
+
print_r($result);
|
220 |
+
} catch (Exception $e) {
|
221 |
+
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdGet: ', $e->getMessage(), PHP_EOL;
|
222 |
+
}
|
223 |
+
?>
|
224 |
+
```
|
225 |
+
|
226 |
+
### Parameters
|
227 |
+
|
228 |
+
Name | Type | Description | Notes
|
229 |
+
------------- | ------------- | ------------- | -------------
|
230 |
+
**id** | **int**| Id of the sub-account organization |
|
231 |
+
|
232 |
+
### Return type
|
233 |
+
|
234 |
+
[**\SendinBlue\Client\Model\SubAccountDetailsResponse**](../Model/SubAccountDetailsResponse.md)
|
235 |
+
|
236 |
+
### Authorization
|
237 |
+
|
238 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
239 |
+
|
240 |
+
### HTTP request headers
|
241 |
+
|
242 |
+
- **Content-Type**: application/json
|
243 |
+
- **Accept**: application/json
|
244 |
+
|
245 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
246 |
+
|
247 |
+
# **corporateSubAccountIdPlanPut**
|
248 |
+
> corporateSubAccountIdPlanPut($id, $updatePlanDetails)
|
249 |
+
|
250 |
+
Update sub-account plan
|
251 |
+
|
252 |
+
This endpoint will update the sub-account plan
|
253 |
+
|
254 |
+
### Example
|
255 |
+
```php
|
256 |
+
<?php
|
257 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
258 |
+
|
259 |
+
// Configure API key authorization: api-key
|
260 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
261 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
262 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
263 |
+
// Configure API key authorization: partner-key
|
264 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
265 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
266 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
267 |
+
|
268 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
269 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
270 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
271 |
+
new GuzzleHttp\Client(),
|
272 |
+
$config
|
273 |
+
);
|
274 |
+
$id = 789; // int | Id of the sub-account organization
|
275 |
+
$updatePlanDetails = new \SendinBlue\Client\Model\SubAccountUpdatePlanRequest(); // \SendinBlue\Client\Model\SubAccountUpdatePlanRequest | Values to update a sub-account plan
|
276 |
+
|
277 |
+
try {
|
278 |
+
$apiInstance->corporateSubAccountIdPlanPut($id, $updatePlanDetails);
|
279 |
+
} catch (Exception $e) {
|
280 |
+
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdPlanPut: ', $e->getMessage(), PHP_EOL;
|
281 |
+
}
|
282 |
+
?>
|
283 |
+
```
|
284 |
+
|
285 |
+
### Parameters
|
286 |
+
|
287 |
+
Name | Type | Description | Notes
|
288 |
+
------------- | ------------- | ------------- | -------------
|
289 |
+
**id** | **int**| Id of the sub-account organization |
|
290 |
+
**updatePlanDetails** | [**\SendinBlue\Client\Model\SubAccountUpdatePlanRequest**](../Model/SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan |
|
291 |
+
|
292 |
+
### Return type
|
293 |
+
|
294 |
+
void (empty response body)
|
295 |
+
|
296 |
+
### Authorization
|
297 |
+
|
298 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
299 |
+
|
300 |
+
### HTTP request headers
|
301 |
+
|
302 |
+
- **Content-Type**: application/json
|
303 |
+
- **Accept**: application/json
|
304 |
+
|
305 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
306 |
+
|
307 |
+
# **corporateSubAccountPost**
|
308 |
+
> \SendinBlue\Client\Model\CreateSubAccountResponse corporateSubAccountPost($subAccountCreate)
|
309 |
+
|
310 |
+
Create a new sub-account under a master account.
|
311 |
+
|
312 |
+
This endpoint will create a new sub-account under a master account
|
313 |
+
|
314 |
+
### Example
|
315 |
+
```php
|
316 |
+
<?php
|
317 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
318 |
+
|
319 |
+
// Configure API key authorization: api-key
|
320 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
321 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
322 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
323 |
+
// Configure API key authorization: partner-key
|
324 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
325 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
326 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
327 |
+
|
328 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
329 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
330 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
331 |
+
new GuzzleHttp\Client(),
|
332 |
+
$config
|
333 |
+
);
|
334 |
+
$subAccountCreate = new \SendinBlue\Client\Model\CreateSubAccount(); // \SendinBlue\Client\Model\CreateSubAccount | values to create new sub-account
|
335 |
+
|
336 |
+
try {
|
337 |
+
$result = $apiInstance->corporateSubAccountPost($subAccountCreate);
|
338 |
+
print_r($result);
|
339 |
+
} catch (Exception $e) {
|
340 |
+
echo 'Exception when calling MasterAccountApi->corporateSubAccountPost: ', $e->getMessage(), PHP_EOL;
|
341 |
+
}
|
342 |
+
?>
|
343 |
+
```
|
344 |
+
|
345 |
+
### Parameters
|
346 |
+
|
347 |
+
Name | Type | Description | Notes
|
348 |
+
------------- | ------------- | ------------- | -------------
|
349 |
+
**subAccountCreate** | [**\SendinBlue\Client\Model\CreateSubAccount**](../Model/CreateSubAccount.md)| values to create new sub-account |
|
350 |
+
|
351 |
+
### Return type
|
352 |
+
|
353 |
+
[**\SendinBlue\Client\Model\CreateSubAccountResponse**](../Model/CreateSubAccountResponse.md)
|
354 |
+
|
355 |
+
### Authorization
|
356 |
+
|
357 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
358 |
+
|
359 |
+
### HTTP request headers
|
360 |
+
|
361 |
+
- **Content-Type**: application/json
|
362 |
+
- **Accept**: application/json
|
363 |
+
|
364 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
365 |
+
|
366 |
+
# **corporateSubAccountSsoTokenPost**
|
367 |
+
> \SendinBlue\Client\Model\GetSsoToken corporateSubAccountSsoTokenPost($ssoTokenRequest)
|
368 |
+
|
369 |
+
Generate SSO token to access Sendinblue
|
370 |
+
|
371 |
+
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
|
372 |
+
|
373 |
+
### Example
|
374 |
+
```php
|
375 |
+
<?php
|
376 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
377 |
+
|
378 |
+
// Configure API key authorization: api-key
|
379 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
380 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
381 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
382 |
+
// Configure API key authorization: partner-key
|
383 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
384 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
385 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
386 |
+
|
387 |
+
$apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
|
388 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
389 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
390 |
+
new GuzzleHttp\Client(),
|
391 |
+
$config
|
392 |
+
);
|
393 |
+
$ssoTokenRequest = new \SendinBlue\Client\Model\SsoTokenRequest(); // \SendinBlue\Client\Model\SsoTokenRequest | Values to generate SSO token for sub-account
|
394 |
+
|
395 |
+
try {
|
396 |
+
$result = $apiInstance->corporateSubAccountSsoTokenPost($ssoTokenRequest);
|
397 |
+
print_r($result);
|
398 |
+
} catch (Exception $e) {
|
399 |
+
echo 'Exception when calling MasterAccountApi->corporateSubAccountSsoTokenPost: ', $e->getMessage(), PHP_EOL;
|
400 |
+
}
|
401 |
+
?>
|
402 |
+
```
|
403 |
+
|
404 |
+
### Parameters
|
405 |
+
|
406 |
+
Name | Type | Description | Notes
|
407 |
+
------------- | ------------- | ------------- | -------------
|
408 |
+
**ssoTokenRequest** | [**\SendinBlue\Client\Model\SsoTokenRequest**](../Model/SsoTokenRequest.md)| Values to generate SSO token for sub-account |
|
409 |
+
|
410 |
+
### Return type
|
411 |
+
|
412 |
+
[**\SendinBlue\Client\Model\GetSsoToken**](../Model/GetSsoToken.md)
|
413 |
+
|
414 |
+
### Authorization
|
415 |
+
|
416 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
417 |
+
|
418 |
+
### HTTP request headers
|
419 |
+
|
420 |
+
- **Content-Type**: application/json
|
421 |
+
- **Accept**: application/json
|
422 |
+
|
423 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
424 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/ProcessApi.md
ADDED
@@ -0,0 +1,128 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\ProcessApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**getProcess**](ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process
|
8 |
+
[**getProcesses**](ProcessApi.md#getProcesses) | **GET** /processes | Return all the processes for your account
|
9 |
+
|
10 |
+
|
11 |
+
# **getProcess**
|
12 |
+
> \SendinBlue\Client\Model\GetProcess getProcess($processId)
|
13 |
+
|
14 |
+
Return the informations for a process
|
15 |
+
|
16 |
+
### Example
|
17 |
+
```php
|
18 |
+
<?php
|
19 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
20 |
+
|
21 |
+
// Configure API key authorization: api-key
|
22 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
23 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
24 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
25 |
+
// Configure API key authorization: partner-key
|
26 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
27 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
28 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
29 |
+
|
30 |
+
$apiInstance = new SendinBlue\Client\Api\ProcessApi(
|
31 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
32 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
33 |
+
new GuzzleHttp\Client(),
|
34 |
+
$config
|
35 |
+
);
|
36 |
+
$processId = 789; // int | Id of the process
|
37 |
+
|
38 |
+
try {
|
39 |
+
$result = $apiInstance->getProcess($processId);
|
40 |
+
print_r($result);
|
41 |
+
} catch (Exception $e) {
|
42 |
+
echo 'Exception when calling ProcessApi->getProcess: ', $e->getMessage(), PHP_EOL;
|
43 |
+
}
|
44 |
+
?>
|
45 |
+
```
|
46 |
+
|
47 |
+
### Parameters
|
48 |
+
|
49 |
+
Name | Type | Description | Notes
|
50 |
+
------------- | ------------- | ------------- | -------------
|
51 |
+
**processId** | **int**| Id of the process |
|
52 |
+
|
53 |
+
### Return type
|
54 |
+
|
55 |
+
[**\SendinBlue\Client\Model\GetProcess**](../Model/GetProcess.md)
|
56 |
+
|
57 |
+
### Authorization
|
58 |
+
|
59 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
60 |
+
|
61 |
+
### HTTP request headers
|
62 |
+
|
63 |
+
- **Content-Type**: application/json
|
64 |
+
- **Accept**: application/json
|
65 |
+
|
66 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
67 |
+
|
68 |
+
# **getProcesses**
|
69 |
+
> \SendinBlue\Client\Model\GetProcesses getProcesses($limit, $offset, $sort)
|
70 |
+
|
71 |
+
Return all the processes for your account
|
72 |
+
|
73 |
+
### Example
|
74 |
+
```php
|
75 |
+
<?php
|
76 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
77 |
+
|
78 |
+
// Configure API key authorization: api-key
|
79 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
80 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
81 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
82 |
+
// Configure API key authorization: partner-key
|
83 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
84 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
85 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
86 |
+
|
87 |
+
$apiInstance = new SendinBlue\Client\Api\ProcessApi(
|
88 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
89 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
90 |
+
new GuzzleHttp\Client(),
|
91 |
+
$config
|
92 |
+
);
|
93 |
+
$limit = 10; // int | Number limitation for the result returned
|
94 |
+
$offset = 0; // int | Beginning point in the list to retrieve from.
|
95 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
96 |
+
|
97 |
+
try {
|
98 |
+
$result = $apiInstance->getProcesses($limit, $offset, $sort);
|
99 |
+
print_r($result);
|
100 |
+
} catch (Exception $e) {
|
101 |
+
echo 'Exception when calling ProcessApi->getProcesses: ', $e->getMessage(), PHP_EOL;
|
102 |
+
}
|
103 |
+
?>
|
104 |
+
```
|
105 |
+
|
106 |
+
### Parameters
|
107 |
+
|
108 |
+
Name | Type | Description | Notes
|
109 |
+
------------- | ------------- | ------------- | -------------
|
110 |
+
**limit** | **int**| Number limitation for the result returned | [optional] [default to 10]
|
111 |
+
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
112 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
113 |
+
|
114 |
+
### Return type
|
115 |
+
|
116 |
+
[**\SendinBlue\Client\Model\GetProcesses**](../Model/GetProcesses.md)
|
117 |
+
|
118 |
+
### Authorization
|
119 |
+
|
120 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
121 |
+
|
122 |
+
### HTTP request headers
|
123 |
+
|
124 |
+
- **Content-Type**: application/json
|
125 |
+
- **Accept**: application/json
|
126 |
+
|
127 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
128 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/ResellerApi.md
ADDED
@@ -0,0 +1,952 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\ResellerApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**addCredits**](ResellerApi.md#addCredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
8 |
+
[**associateIpToChild**](ResellerApi.md#associateIpToChild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
|
9 |
+
[**createChildDomain**](ResellerApi.md#createChildDomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
|
10 |
+
[**createResellerChild**](ResellerApi.md#createResellerChild) | **POST** /reseller/children | Creates a reseller child
|
11 |
+
[**deleteChildDomain**](ResellerApi.md#deleteChildDomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
12 |
+
[**deleteResellerChild**](ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
|
13 |
+
[**dissociateIpFromChild**](ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
|
14 |
+
[**getChildAccountCreationStatus**](ResellerApi.md#getChildAccountCreationStatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
15 |
+
[**getChildDomains**](ResellerApi.md#getChildDomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
|
16 |
+
[**getChildInfo**](ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
|
17 |
+
[**getResellerChilds**](ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Get the list of all children accounts
|
18 |
+
[**getSsoToken**](ResellerApi.md#getSsoToken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO)
|
19 |
+
[**removeCredits**](ResellerApi.md#removeCredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
20 |
+
[**updateChildAccountStatus**](ResellerApi.md#updateChildAccountStatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
|
21 |
+
[**updateChildDomain**](ResellerApi.md#updateChildDomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
22 |
+
[**updateResellerChild**](ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
|
23 |
+
|
24 |
+
|
25 |
+
# **addCredits**
|
26 |
+
> \SendinBlue\Client\Model\RemainingCreditModel addCredits($childIdentifier, $addCredits)
|
27 |
+
|
28 |
+
Add Email and/or SMS credits to a specific child account
|
29 |
+
|
30 |
+
### Example
|
31 |
+
```php
|
32 |
+
<?php
|
33 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
34 |
+
|
35 |
+
// Configure API key authorization: api-key
|
36 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
37 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
38 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
39 |
+
// Configure API key authorization: partner-key
|
40 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
41 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
42 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
43 |
+
|
44 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
45 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
46 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
47 |
+
new GuzzleHttp\Client(),
|
48 |
+
$config
|
49 |
+
);
|
50 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
51 |
+
$addCredits = new \SendinBlue\Client\Model\AddCredits(); // \SendinBlue\Client\Model\AddCredits | Values to post to add credit to a specific child account
|
52 |
+
|
53 |
+
try {
|
54 |
+
$result = $apiInstance->addCredits($childIdentifier, $addCredits);
|
55 |
+
print_r($result);
|
56 |
+
} catch (Exception $e) {
|
57 |
+
echo 'Exception when calling ResellerApi->addCredits: ', $e->getMessage(), PHP_EOL;
|
58 |
+
}
|
59 |
+
?>
|
60 |
+
```
|
61 |
+
|
62 |
+
### Parameters
|
63 |
+
|
64 |
+
Name | Type | Description | Notes
|
65 |
+
------------- | ------------- | ------------- | -------------
|
66 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
67 |
+
**addCredits** | [**\SendinBlue\Client\Model\AddCredits**](../Model/AddCredits.md)| Values to post to add credit to a specific child account |
|
68 |
+
|
69 |
+
### Return type
|
70 |
+
|
71 |
+
[**\SendinBlue\Client\Model\RemainingCreditModel**](../Model/RemainingCreditModel.md)
|
72 |
+
|
73 |
+
### Authorization
|
74 |
+
|
75 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
76 |
+
|
77 |
+
### HTTP request headers
|
78 |
+
|
79 |
+
- **Content-Type**: application/json
|
80 |
+
- **Accept**: application/json
|
81 |
+
|
82 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
83 |
+
|
84 |
+
# **associateIpToChild**
|
85 |
+
> associateIpToChild($childIdentifier, $ip)
|
86 |
+
|
87 |
+
Associate a dedicated IP to the child
|
88 |
+
|
89 |
+
### Example
|
90 |
+
```php
|
91 |
+
<?php
|
92 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
93 |
+
|
94 |
+
// Configure API key authorization: api-key
|
95 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
96 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
97 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
98 |
+
// Configure API key authorization: partner-key
|
99 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
100 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
101 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
102 |
+
|
103 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
104 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
105 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
106 |
+
new GuzzleHttp\Client(),
|
107 |
+
$config
|
108 |
+
);
|
109 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
110 |
+
$ip = new \SendinBlue\Client\Model\ManageIp(); // \SendinBlue\Client\Model\ManageIp | IP to associate
|
111 |
+
|
112 |
+
try {
|
113 |
+
$apiInstance->associateIpToChild($childIdentifier, $ip);
|
114 |
+
} catch (Exception $e) {
|
115 |
+
echo 'Exception when calling ResellerApi->associateIpToChild: ', $e->getMessage(), PHP_EOL;
|
116 |
+
}
|
117 |
+
?>
|
118 |
+
```
|
119 |
+
|
120 |
+
### Parameters
|
121 |
+
|
122 |
+
Name | Type | Description | Notes
|
123 |
+
------------- | ------------- | ------------- | -------------
|
124 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
125 |
+
**ip** | [**\SendinBlue\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to associate |
|
126 |
+
|
127 |
+
### Return type
|
128 |
+
|
129 |
+
void (empty response body)
|
130 |
+
|
131 |
+
### Authorization
|
132 |
+
|
133 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
134 |
+
|
135 |
+
### HTTP request headers
|
136 |
+
|
137 |
+
- **Content-Type**: application/json
|
138 |
+
- **Accept**: application/json
|
139 |
+
|
140 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
141 |
+
|
142 |
+
# **createChildDomain**
|
143 |
+
> createChildDomain($childIdentifier, $addChildDomain)
|
144 |
+
|
145 |
+
Create a domain for a child account
|
146 |
+
|
147 |
+
### Example
|
148 |
+
```php
|
149 |
+
<?php
|
150 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
151 |
+
|
152 |
+
// Configure API key authorization: api-key
|
153 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
154 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
155 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
156 |
+
// Configure API key authorization: partner-key
|
157 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
158 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
159 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
160 |
+
|
161 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
162 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
163 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
164 |
+
new GuzzleHttp\Client(),
|
165 |
+
$config
|
166 |
+
);
|
167 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
168 |
+
$addChildDomain = new \SendinBlue\Client\Model\AddChildDomain(); // \SendinBlue\Client\Model\AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.
|
169 |
+
|
170 |
+
try {
|
171 |
+
$apiInstance->createChildDomain($childIdentifier, $addChildDomain);
|
172 |
+
} catch (Exception $e) {
|
173 |
+
echo 'Exception when calling ResellerApi->createChildDomain: ', $e->getMessage(), PHP_EOL;
|
174 |
+
}
|
175 |
+
?>
|
176 |
+
```
|
177 |
+
|
178 |
+
### Parameters
|
179 |
+
|
180 |
+
Name | Type | Description | Notes
|
181 |
+
------------- | ------------- | ------------- | -------------
|
182 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
183 |
+
**addChildDomain** | [**\SendinBlue\Client\Model\AddChildDomain**](../Model/AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. |
|
184 |
+
|
185 |
+
### Return type
|
186 |
+
|
187 |
+
void (empty response body)
|
188 |
+
|
189 |
+
### Authorization
|
190 |
+
|
191 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
192 |
+
|
193 |
+
### HTTP request headers
|
194 |
+
|
195 |
+
- **Content-Type**: application/json
|
196 |
+
- **Accept**: application/json
|
197 |
+
|
198 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
199 |
+
|
200 |
+
# **createResellerChild**
|
201 |
+
> \SendinBlue\Client\Model\CreateReseller createResellerChild($resellerChild)
|
202 |
+
|
203 |
+
Creates a reseller child
|
204 |
+
|
205 |
+
### Example
|
206 |
+
```php
|
207 |
+
<?php
|
208 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
209 |
+
|
210 |
+
// Configure API key authorization: api-key
|
211 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
212 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
213 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
214 |
+
// Configure API key authorization: partner-key
|
215 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
216 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
217 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
218 |
+
|
219 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
220 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
221 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
222 |
+
new GuzzleHttp\Client(),
|
223 |
+
$config
|
224 |
+
);
|
225 |
+
$resellerChild = new \SendinBlue\Client\Model\CreateChild(); // \SendinBlue\Client\Model\CreateChild | reseller child to add
|
226 |
+
|
227 |
+
try {
|
228 |
+
$result = $apiInstance->createResellerChild($resellerChild);
|
229 |
+
print_r($result);
|
230 |
+
} catch (Exception $e) {
|
231 |
+
echo 'Exception when calling ResellerApi->createResellerChild: ', $e->getMessage(), PHP_EOL;
|
232 |
+
}
|
233 |
+
?>
|
234 |
+
```
|
235 |
+
|
236 |
+
### Parameters
|
237 |
+
|
238 |
+
Name | Type | Description | Notes
|
239 |
+
------------- | ------------- | ------------- | -------------
|
240 |
+
**resellerChild** | [**\SendinBlue\Client\Model\CreateChild**](../Model/CreateChild.md)| reseller child to add | [optional]
|
241 |
+
|
242 |
+
### Return type
|
243 |
+
|
244 |
+
[**\SendinBlue\Client\Model\CreateReseller**](../Model/CreateReseller.md)
|
245 |
+
|
246 |
+
### Authorization
|
247 |
+
|
248 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
249 |
+
|
250 |
+
### HTTP request headers
|
251 |
+
|
252 |
+
- **Content-Type**: application/json
|
253 |
+
- **Accept**: application/json
|
254 |
+
|
255 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
256 |
+
|
257 |
+
# **deleteChildDomain**
|
258 |
+
> deleteChildDomain($childIdentifier, $domainName)
|
259 |
+
|
260 |
+
Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
261 |
+
|
262 |
+
### Example
|
263 |
+
```php
|
264 |
+
<?php
|
265 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
266 |
+
|
267 |
+
// Configure API key authorization: api-key
|
268 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
269 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
270 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
271 |
+
// Configure API key authorization: partner-key
|
272 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
273 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
274 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
275 |
+
|
276 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
277 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
278 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
279 |
+
new GuzzleHttp\Client(),
|
280 |
+
$config
|
281 |
+
);
|
282 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
283 |
+
$domainName = "domainName_example"; // string | Pass the existing domain that needs to be deleted
|
284 |
+
|
285 |
+
try {
|
286 |
+
$apiInstance->deleteChildDomain($childIdentifier, $domainName);
|
287 |
+
} catch (Exception $e) {
|
288 |
+
echo 'Exception when calling ResellerApi->deleteChildDomain: ', $e->getMessage(), PHP_EOL;
|
289 |
+
}
|
290 |
+
?>
|
291 |
+
```
|
292 |
+
|
293 |
+
### Parameters
|
294 |
+
|
295 |
+
Name | Type | Description | Notes
|
296 |
+
------------- | ------------- | ------------- | -------------
|
297 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
298 |
+
**domainName** | **string**| Pass the existing domain that needs to be deleted |
|
299 |
+
|
300 |
+
### Return type
|
301 |
+
|
302 |
+
void (empty response body)
|
303 |
+
|
304 |
+
### Authorization
|
305 |
+
|
306 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
307 |
+
|
308 |
+
### HTTP request headers
|
309 |
+
|
310 |
+
- **Content-Type**: application/json
|
311 |
+
- **Accept**: application/json
|
312 |
+
|
313 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
314 |
+
|
315 |
+
# **deleteResellerChild**
|
316 |
+
> deleteResellerChild($childIdentifier)
|
317 |
+
|
318 |
+
Delete a single reseller child based on the child identifier supplied
|
319 |
+
|
320 |
+
### Example
|
321 |
+
```php
|
322 |
+
<?php
|
323 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
324 |
+
|
325 |
+
// Configure API key authorization: api-key
|
326 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
327 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
328 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
329 |
+
// Configure API key authorization: partner-key
|
330 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
331 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
332 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
333 |
+
|
334 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
335 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
336 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
337 |
+
new GuzzleHttp\Client(),
|
338 |
+
$config
|
339 |
+
);
|
340 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or child id of reseller's child
|
341 |
+
|
342 |
+
try {
|
343 |
+
$apiInstance->deleteResellerChild($childIdentifier);
|
344 |
+
} catch (Exception $e) {
|
345 |
+
echo 'Exception when calling ResellerApi->deleteResellerChild: ', $e->getMessage(), PHP_EOL;
|
346 |
+
}
|
347 |
+
?>
|
348 |
+
```
|
349 |
+
|
350 |
+
### Parameters
|
351 |
+
|
352 |
+
Name | Type | Description | Notes
|
353 |
+
------------- | ------------- | ------------- | -------------
|
354 |
+
**childIdentifier** | **string**| Either auth key or child id of reseller's child |
|
355 |
+
|
356 |
+
### Return type
|
357 |
+
|
358 |
+
void (empty response body)
|
359 |
+
|
360 |
+
### Authorization
|
361 |
+
|
362 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
363 |
+
|
364 |
+
### HTTP request headers
|
365 |
+
|
366 |
+
- **Content-Type**: application/json
|
367 |
+
- **Accept**: application/json
|
368 |
+
|
369 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
370 |
+
|
371 |
+
# **dissociateIpFromChild**
|
372 |
+
> dissociateIpFromChild($childIdentifier, $ip)
|
373 |
+
|
374 |
+
Dissociate a dedicated IP to the child
|
375 |
+
|
376 |
+
### Example
|
377 |
+
```php
|
378 |
+
<?php
|
379 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
380 |
+
|
381 |
+
// Configure API key authorization: api-key
|
382 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
383 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
384 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
385 |
+
// Configure API key authorization: partner-key
|
386 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
387 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
388 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
389 |
+
|
390 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
391 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
392 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
393 |
+
new GuzzleHttp\Client(),
|
394 |
+
$config
|
395 |
+
);
|
396 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
397 |
+
$ip = new \SendinBlue\Client\Model\ManageIp(); // \SendinBlue\Client\Model\ManageIp | IP to dissociate
|
398 |
+
|
399 |
+
try {
|
400 |
+
$apiInstance->dissociateIpFromChild($childIdentifier, $ip);
|
401 |
+
} catch (Exception $e) {
|
402 |
+
echo 'Exception when calling ResellerApi->dissociateIpFromChild: ', $e->getMessage(), PHP_EOL;
|
403 |
+
}
|
404 |
+
?>
|
405 |
+
```
|
406 |
+
|
407 |
+
### Parameters
|
408 |
+
|
409 |
+
Name | Type | Description | Notes
|
410 |
+
------------- | ------------- | ------------- | -------------
|
411 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
412 |
+
**ip** | [**\SendinBlue\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to dissociate |
|
413 |
+
|
414 |
+
### Return type
|
415 |
+
|
416 |
+
void (empty response body)
|
417 |
+
|
418 |
+
### Authorization
|
419 |
+
|
420 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
421 |
+
|
422 |
+
### HTTP request headers
|
423 |
+
|
424 |
+
- **Content-Type**: application/json
|
425 |
+
- **Accept**: application/json
|
426 |
+
|
427 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
428 |
+
|
429 |
+
# **getChildAccountCreationStatus**
|
430 |
+
> \SendinBlue\Client\Model\GetChildAccountCreationStatus getChildAccountCreationStatus($childIdentifier)
|
431 |
+
|
432 |
+
Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
433 |
+
|
434 |
+
### Example
|
435 |
+
```php
|
436 |
+
<?php
|
437 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
438 |
+
|
439 |
+
// Configure API key authorization: api-key
|
440 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
441 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
442 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
443 |
+
// Configure API key authorization: partner-key
|
444 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
445 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
446 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
447 |
+
|
448 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
449 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
450 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
451 |
+
new GuzzleHttp\Client(),
|
452 |
+
$config
|
453 |
+
);
|
454 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
455 |
+
|
456 |
+
try {
|
457 |
+
$result = $apiInstance->getChildAccountCreationStatus($childIdentifier);
|
458 |
+
print_r($result);
|
459 |
+
} catch (Exception $e) {
|
460 |
+
echo 'Exception when calling ResellerApi->getChildAccountCreationStatus: ', $e->getMessage(), PHP_EOL;
|
461 |
+
}
|
462 |
+
?>
|
463 |
+
```
|
464 |
+
|
465 |
+
### Parameters
|
466 |
+
|
467 |
+
Name | Type | Description | Notes
|
468 |
+
------------- | ------------- | ------------- | -------------
|
469 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
470 |
+
|
471 |
+
### Return type
|
472 |
+
|
473 |
+
[**\SendinBlue\Client\Model\GetChildAccountCreationStatus**](../Model/GetChildAccountCreationStatus.md)
|
474 |
+
|
475 |
+
### Authorization
|
476 |
+
|
477 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
478 |
+
|
479 |
+
### HTTP request headers
|
480 |
+
|
481 |
+
- **Content-Type**: application/json
|
482 |
+
- **Accept**: application/json
|
483 |
+
|
484 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
485 |
+
|
486 |
+
# **getChildDomains**
|
487 |
+
> \SendinBlue\Client\Model\GetChildDomains getChildDomains($childIdentifier)
|
488 |
+
|
489 |
+
Get all sender domains for a specific child account
|
490 |
+
|
491 |
+
### Example
|
492 |
+
```php
|
493 |
+
<?php
|
494 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
495 |
+
|
496 |
+
// Configure API key authorization: api-key
|
497 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
498 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
499 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
500 |
+
// Configure API key authorization: partner-key
|
501 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
502 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
503 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
504 |
+
|
505 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
506 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
507 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
508 |
+
new GuzzleHttp\Client(),
|
509 |
+
$config
|
510 |
+
);
|
511 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
512 |
+
|
513 |
+
try {
|
514 |
+
$result = $apiInstance->getChildDomains($childIdentifier);
|
515 |
+
print_r($result);
|
516 |
+
} catch (Exception $e) {
|
517 |
+
echo 'Exception when calling ResellerApi->getChildDomains: ', $e->getMessage(), PHP_EOL;
|
518 |
+
}
|
519 |
+
?>
|
520 |
+
```
|
521 |
+
|
522 |
+
### Parameters
|
523 |
+
|
524 |
+
Name | Type | Description | Notes
|
525 |
+
------------- | ------------- | ------------- | -------------
|
526 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
527 |
+
|
528 |
+
### Return type
|
529 |
+
|
530 |
+
[**\SendinBlue\Client\Model\GetChildDomains**](../Model/GetChildDomains.md)
|
531 |
+
|
532 |
+
### Authorization
|
533 |
+
|
534 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
535 |
+
|
536 |
+
### HTTP request headers
|
537 |
+
|
538 |
+
- **Content-Type**: application/json
|
539 |
+
- **Accept**: application/json
|
540 |
+
|
541 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
542 |
+
|
543 |
+
# **getChildInfo**
|
544 |
+
> \SendinBlue\Client\Model\GetChildInfo getChildInfo($childIdentifier)
|
545 |
+
|
546 |
+
Get a child account's details
|
547 |
+
|
548 |
+
### Example
|
549 |
+
```php
|
550 |
+
<?php
|
551 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
552 |
+
|
553 |
+
// Configure API key authorization: api-key
|
554 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
555 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
556 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
557 |
+
// Configure API key authorization: partner-key
|
558 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
559 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
560 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
561 |
+
|
562 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
563 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
564 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
565 |
+
new GuzzleHttp\Client(),
|
566 |
+
$config
|
567 |
+
);
|
568 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
569 |
+
|
570 |
+
try {
|
571 |
+
$result = $apiInstance->getChildInfo($childIdentifier);
|
572 |
+
print_r($result);
|
573 |
+
} catch (Exception $e) {
|
574 |
+
echo 'Exception when calling ResellerApi->getChildInfo: ', $e->getMessage(), PHP_EOL;
|
575 |
+
}
|
576 |
+
?>
|
577 |
+
```
|
578 |
+
|
579 |
+
### Parameters
|
580 |
+
|
581 |
+
Name | Type | Description | Notes
|
582 |
+
------------- | ------------- | ------------- | -------------
|
583 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
584 |
+
|
585 |
+
### Return type
|
586 |
+
|
587 |
+
[**\SendinBlue\Client\Model\GetChildInfo**](../Model/GetChildInfo.md)
|
588 |
+
|
589 |
+
### Authorization
|
590 |
+
|
591 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
592 |
+
|
593 |
+
### HTTP request headers
|
594 |
+
|
595 |
+
- **Content-Type**: application/json
|
596 |
+
- **Accept**: application/json
|
597 |
+
|
598 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
599 |
+
|
600 |
+
# **getResellerChilds**
|
601 |
+
> \SendinBlue\Client\Model\GetChildrenList getResellerChilds($limit, $offset)
|
602 |
+
|
603 |
+
Get the list of all children accounts
|
604 |
+
|
605 |
+
### Example
|
606 |
+
```php
|
607 |
+
<?php
|
608 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
609 |
+
|
610 |
+
// Configure API key authorization: api-key
|
611 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
612 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
613 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
614 |
+
// Configure API key authorization: partner-key
|
615 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
616 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
617 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
618 |
+
|
619 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
620 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
621 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
622 |
+
new GuzzleHttp\Client(),
|
623 |
+
$config
|
624 |
+
);
|
625 |
+
$limit = 10; // int | Number of documents for child accounts information per page
|
626 |
+
$offset = 0; // int | Index of the first document in the page
|
627 |
+
|
628 |
+
try {
|
629 |
+
$result = $apiInstance->getResellerChilds($limit, $offset);
|
630 |
+
print_r($result);
|
631 |
+
} catch (Exception $e) {
|
632 |
+
echo 'Exception when calling ResellerApi->getResellerChilds: ', $e->getMessage(), PHP_EOL;
|
633 |
+
}
|
634 |
+
?>
|
635 |
+
```
|
636 |
+
|
637 |
+
### Parameters
|
638 |
+
|
639 |
+
Name | Type | Description | Notes
|
640 |
+
------------- | ------------- | ------------- | -------------
|
641 |
+
**limit** | **int**| Number of documents for child accounts information per page | [optional] [default to 10]
|
642 |
+
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
643 |
+
|
644 |
+
### Return type
|
645 |
+
|
646 |
+
[**\SendinBlue\Client\Model\GetChildrenList**](../Model/GetChildrenList.md)
|
647 |
+
|
648 |
+
### Authorization
|
649 |
+
|
650 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
651 |
+
|
652 |
+
### HTTP request headers
|
653 |
+
|
654 |
+
- **Content-Type**: application/json
|
655 |
+
- **Accept**: application/json
|
656 |
+
|
657 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
658 |
+
|
659 |
+
# **getSsoToken**
|
660 |
+
> \SendinBlue\Client\Model\GetSsoToken getSsoToken($childIdentifier)
|
661 |
+
|
662 |
+
Get session token to access Sendinblue (SSO)
|
663 |
+
|
664 |
+
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
665 |
+
|
666 |
+
### Example
|
667 |
+
```php
|
668 |
+
<?php
|
669 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
670 |
+
|
671 |
+
// Configure API key authorization: api-key
|
672 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
673 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
674 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
675 |
+
// Configure API key authorization: partner-key
|
676 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
677 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
678 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
679 |
+
|
680 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
681 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
682 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
683 |
+
new GuzzleHttp\Client(),
|
684 |
+
$config
|
685 |
+
);
|
686 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
687 |
+
|
688 |
+
try {
|
689 |
+
$result = $apiInstance->getSsoToken($childIdentifier);
|
690 |
+
print_r($result);
|
691 |
+
} catch (Exception $e) {
|
692 |
+
echo 'Exception when calling ResellerApi->getSsoToken: ', $e->getMessage(), PHP_EOL;
|
693 |
+
}
|
694 |
+
?>
|
695 |
+
```
|
696 |
+
|
697 |
+
### Parameters
|
698 |
+
|
699 |
+
Name | Type | Description | Notes
|
700 |
+
------------- | ------------- | ------------- | -------------
|
701 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
702 |
+
|
703 |
+
### Return type
|
704 |
+
|
705 |
+
[**\SendinBlue\Client\Model\GetSsoToken**](../Model/GetSsoToken.md)
|
706 |
+
|
707 |
+
### Authorization
|
708 |
+
|
709 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
710 |
+
|
711 |
+
### HTTP request headers
|
712 |
+
|
713 |
+
- **Content-Type**: application/json
|
714 |
+
- **Accept**: application/json
|
715 |
+
|
716 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
717 |
+
|
718 |
+
# **removeCredits**
|
719 |
+
> \SendinBlue\Client\Model\RemainingCreditModel removeCredits($childIdentifier, $removeCredits)
|
720 |
+
|
721 |
+
Remove Email and/or SMS credits from a specific child account
|
722 |
+
|
723 |
+
### Example
|
724 |
+
```php
|
725 |
+
<?php
|
726 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
727 |
+
|
728 |
+
// Configure API key authorization: api-key
|
729 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
730 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
731 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
732 |
+
// Configure API key authorization: partner-key
|
733 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
734 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
735 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
736 |
+
|
737 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
738 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
739 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
740 |
+
new GuzzleHttp\Client(),
|
741 |
+
$config
|
742 |
+
);
|
743 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
744 |
+
$removeCredits = new \SendinBlue\Client\Model\RemoveCredits(); // \SendinBlue\Client\Model\RemoveCredits | Values to post to remove email or SMS credits from a specific child account
|
745 |
+
|
746 |
+
try {
|
747 |
+
$result = $apiInstance->removeCredits($childIdentifier, $removeCredits);
|
748 |
+
print_r($result);
|
749 |
+
} catch (Exception $e) {
|
750 |
+
echo 'Exception when calling ResellerApi->removeCredits: ', $e->getMessage(), PHP_EOL;
|
751 |
+
}
|
752 |
+
?>
|
753 |
+
```
|
754 |
+
|
755 |
+
### Parameters
|
756 |
+
|
757 |
+
Name | Type | Description | Notes
|
758 |
+
------------- | ------------- | ------------- | -------------
|
759 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
760 |
+
**removeCredits** | [**\SendinBlue\Client\Model\RemoveCredits**](../Model/RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account |
|
761 |
+
|
762 |
+
### Return type
|
763 |
+
|
764 |
+
[**\SendinBlue\Client\Model\RemainingCreditModel**](../Model/RemainingCreditModel.md)
|
765 |
+
|
766 |
+
### Authorization
|
767 |
+
|
768 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
769 |
+
|
770 |
+
### HTTP request headers
|
771 |
+
|
772 |
+
- **Content-Type**: application/json
|
773 |
+
- **Accept**: application/json
|
774 |
+
|
775 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
776 |
+
|
777 |
+
# **updateChildAccountStatus**
|
778 |
+
> updateChildAccountStatus($childIdentifier, $updateChildAccountStatus)
|
779 |
+
|
780 |
+
Update info of reseller's child account status based on the childIdentifier supplied
|
781 |
+
|
782 |
+
### Example
|
783 |
+
```php
|
784 |
+
<?php
|
785 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
786 |
+
|
787 |
+
// Configure API key authorization: api-key
|
788 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
789 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
790 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
791 |
+
// Configure API key authorization: partner-key
|
792 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
793 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
794 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
795 |
+
|
796 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
797 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
798 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
799 |
+
new GuzzleHttp\Client(),
|
800 |
+
$config
|
801 |
+
);
|
802 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
803 |
+
$updateChildAccountStatus = new \SendinBlue\Client\Model\UpdateChildAccountStatus(); // \SendinBlue\Client\Model\UpdateChildAccountStatus | values to update in child account status
|
804 |
+
|
805 |
+
try {
|
806 |
+
$apiInstance->updateChildAccountStatus($childIdentifier, $updateChildAccountStatus);
|
807 |
+
} catch (Exception $e) {
|
808 |
+
echo 'Exception when calling ResellerApi->updateChildAccountStatus: ', $e->getMessage(), PHP_EOL;
|
809 |
+
}
|
810 |
+
?>
|
811 |
+
```
|
812 |
+
|
813 |
+
### Parameters
|
814 |
+
|
815 |
+
Name | Type | Description | Notes
|
816 |
+
------------- | ------------- | ------------- | -------------
|
817 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
818 |
+
**updateChildAccountStatus** | [**\SendinBlue\Client\Model\UpdateChildAccountStatus**](../Model/UpdateChildAccountStatus.md)| values to update in child account status |
|
819 |
+
|
820 |
+
### Return type
|
821 |
+
|
822 |
+
void (empty response body)
|
823 |
+
|
824 |
+
### Authorization
|
825 |
+
|
826 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
827 |
+
|
828 |
+
### HTTP request headers
|
829 |
+
|
830 |
+
- **Content-Type**: application/json
|
831 |
+
- **Accept**: application/json
|
832 |
+
|
833 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
834 |
+
|
835 |
+
# **updateChildDomain**
|
836 |
+
> updateChildDomain($childIdentifier, $domainName, $updateChildDomain)
|
837 |
+
|
838 |
+
Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
839 |
+
|
840 |
+
### Example
|
841 |
+
```php
|
842 |
+
<?php
|
843 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
844 |
+
|
845 |
+
// Configure API key authorization: api-key
|
846 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
847 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
848 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
849 |
+
// Configure API key authorization: partner-key
|
850 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
851 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
852 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
853 |
+
|
854 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
855 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
856 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
857 |
+
new GuzzleHttp\Client(),
|
858 |
+
$config
|
859 |
+
);
|
860 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
861 |
+
$domainName = "domainName_example"; // string | Pass the existing domain that needs to be updated
|
862 |
+
$updateChildDomain = new \SendinBlue\Client\Model\UpdateChildDomain(); // \SendinBlue\Client\Model\UpdateChildDomain | value to update for sender domain
|
863 |
+
|
864 |
+
try {
|
865 |
+
$apiInstance->updateChildDomain($childIdentifier, $domainName, $updateChildDomain);
|
866 |
+
} catch (Exception $e) {
|
867 |
+
echo 'Exception when calling ResellerApi->updateChildDomain: ', $e->getMessage(), PHP_EOL;
|
868 |
+
}
|
869 |
+
?>
|
870 |
+
```
|
871 |
+
|
872 |
+
### Parameters
|
873 |
+
|
874 |
+
Name | Type | Description | Notes
|
875 |
+
------------- | ------------- | ------------- | -------------
|
876 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
877 |
+
**domainName** | **string**| Pass the existing domain that needs to be updated |
|
878 |
+
**updateChildDomain** | [**\SendinBlue\Client\Model\UpdateChildDomain**](../Model/UpdateChildDomain.md)| value to update for sender domain |
|
879 |
+
|
880 |
+
### Return type
|
881 |
+
|
882 |
+
void (empty response body)
|
883 |
+
|
884 |
+
### Authorization
|
885 |
+
|
886 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
887 |
+
|
888 |
+
### HTTP request headers
|
889 |
+
|
890 |
+
- **Content-Type**: application/json
|
891 |
+
- **Accept**: application/json
|
892 |
+
|
893 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
894 |
+
|
895 |
+
# **updateResellerChild**
|
896 |
+
> updateResellerChild($childIdentifier, $resellerChild)
|
897 |
+
|
898 |
+
Update info of reseller's child based on the child identifier supplied
|
899 |
+
|
900 |
+
### Example
|
901 |
+
```php
|
902 |
+
<?php
|
903 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
904 |
+
|
905 |
+
// Configure API key authorization: api-key
|
906 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
907 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
908 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
909 |
+
// Configure API key authorization: partner-key
|
910 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
911 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
912 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
913 |
+
|
914 |
+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
|
915 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
916 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
917 |
+
new GuzzleHttp\Client(),
|
918 |
+
$config
|
919 |
+
);
|
920 |
+
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
921 |
+
$resellerChild = new \SendinBlue\Client\Model\UpdateChild(); // \SendinBlue\Client\Model\UpdateChild | values to update in child profile
|
922 |
+
|
923 |
+
try {
|
924 |
+
$apiInstance->updateResellerChild($childIdentifier, $resellerChild);
|
925 |
+
} catch (Exception $e) {
|
926 |
+
echo 'Exception when calling ResellerApi->updateResellerChild: ', $e->getMessage(), PHP_EOL;
|
927 |
+
}
|
928 |
+
?>
|
929 |
+
```
|
930 |
+
|
931 |
+
### Parameters
|
932 |
+
|
933 |
+
Name | Type | Description | Notes
|
934 |
+
------------- | ------------- | ------------- | -------------
|
935 |
+
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
936 |
+
**resellerChild** | [**\SendinBlue\Client\Model\UpdateChild**](../Model/UpdateChild.md)| values to update in child profile |
|
937 |
+
|
938 |
+
### Return type
|
939 |
+
|
940 |
+
void (empty response body)
|
941 |
+
|
942 |
+
### Authorization
|
943 |
+
|
944 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
945 |
+
|
946 |
+
### HTTP request headers
|
947 |
+
|
948 |
+
- **Content-Type**: application/json
|
949 |
+
- **Accept**: application/json
|
950 |
+
|
951 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
952 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/SMSCampaignsApi.md
ADDED
@@ -0,0 +1,606 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\SMSCampaignsApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**createSmsCampaign**](SMSCampaignsApi.md#createSmsCampaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
8 |
+
[**deleteSmsCampaign**](SMSCampaignsApi.md#deleteSmsCampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
9 |
+
[**getSmsCampaign**](SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
10 |
+
[**getSmsCampaigns**](SMSCampaignsApi.md#getSmsCampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
11 |
+
[**requestSmsRecipientExport**](SMSCampaignsApi.md#requestSmsRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
12 |
+
[**sendSmsCampaignNow**](SMSCampaignsApi.md#sendSmsCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
13 |
+
[**sendSmsReport**](SMSCampaignsApi.md#sendSmsReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
14 |
+
[**sendTestSms**](SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
15 |
+
[**updateSmsCampaign**](SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
16 |
+
[**updateSmsCampaignStatus**](SMSCampaignsApi.md#updateSmsCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
|
17 |
+
|
18 |
+
|
19 |
+
# **createSmsCampaign**
|
20 |
+
> \SendinBlue\Client\Model\CreateModel createSmsCampaign($createSmsCampaign)
|
21 |
+
|
22 |
+
Creates an SMS campaign
|
23 |
+
|
24 |
+
### Example
|
25 |
+
```php
|
26 |
+
<?php
|
27 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
28 |
+
|
29 |
+
// Configure API key authorization: api-key
|
30 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
31 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
32 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
33 |
+
// Configure API key authorization: partner-key
|
34 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
35 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
36 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
37 |
+
|
38 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
39 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
40 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
41 |
+
new GuzzleHttp\Client(),
|
42 |
+
$config
|
43 |
+
);
|
44 |
+
$createSmsCampaign = new \SendinBlue\Client\Model\CreateSmsCampaign(); // \SendinBlue\Client\Model\CreateSmsCampaign | Values to create an SMS Campaign
|
45 |
+
|
46 |
+
try {
|
47 |
+
$result = $apiInstance->createSmsCampaign($createSmsCampaign);
|
48 |
+
print_r($result);
|
49 |
+
} catch (Exception $e) {
|
50 |
+
echo 'Exception when calling SMSCampaignsApi->createSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
51 |
+
}
|
52 |
+
?>
|
53 |
+
```
|
54 |
+
|
55 |
+
### Parameters
|
56 |
+
|
57 |
+
Name | Type | Description | Notes
|
58 |
+
------------- | ------------- | ------------- | -------------
|
59 |
+
**createSmsCampaign** | [**\SendinBlue\Client\Model\CreateSmsCampaign**](../Model/CreateSmsCampaign.md)| Values to create an SMS Campaign |
|
60 |
+
|
61 |
+
### Return type
|
62 |
+
|
63 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
64 |
+
|
65 |
+
### Authorization
|
66 |
+
|
67 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
68 |
+
|
69 |
+
### HTTP request headers
|
70 |
+
|
71 |
+
- **Content-Type**: application/json
|
72 |
+
- **Accept**: application/json
|
73 |
+
|
74 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
75 |
+
|
76 |
+
# **deleteSmsCampaign**
|
77 |
+
> deleteSmsCampaign($campaignId)
|
78 |
+
|
79 |
+
Delete an SMS campaign
|
80 |
+
|
81 |
+
### Example
|
82 |
+
```php
|
83 |
+
<?php
|
84 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
85 |
+
|
86 |
+
// Configure API key authorization: api-key
|
87 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
88 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
89 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
90 |
+
// Configure API key authorization: partner-key
|
91 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
92 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
93 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
94 |
+
|
95 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
96 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
97 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
98 |
+
new GuzzleHttp\Client(),
|
99 |
+
$config
|
100 |
+
);
|
101 |
+
$campaignId = 789; // int | id of the SMS campaign
|
102 |
+
|
103 |
+
try {
|
104 |
+
$apiInstance->deleteSmsCampaign($campaignId);
|
105 |
+
} catch (Exception $e) {
|
106 |
+
echo 'Exception when calling SMSCampaignsApi->deleteSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
107 |
+
}
|
108 |
+
?>
|
109 |
+
```
|
110 |
+
|
111 |
+
### Parameters
|
112 |
+
|
113 |
+
Name | Type | Description | Notes
|
114 |
+
------------- | ------------- | ------------- | -------------
|
115 |
+
**campaignId** | **int**| id of the SMS campaign |
|
116 |
+
|
117 |
+
### Return type
|
118 |
+
|
119 |
+
void (empty response body)
|
120 |
+
|
121 |
+
### Authorization
|
122 |
+
|
123 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
124 |
+
|
125 |
+
### HTTP request headers
|
126 |
+
|
127 |
+
- **Content-Type**: application/json
|
128 |
+
- **Accept**: application/json
|
129 |
+
|
130 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
131 |
+
|
132 |
+
# **getSmsCampaign**
|
133 |
+
> \SendinBlue\Client\Model\GetSmsCampaign getSmsCampaign($campaignId)
|
134 |
+
|
135 |
+
Get an SMS campaign
|
136 |
+
|
137 |
+
### Example
|
138 |
+
```php
|
139 |
+
<?php
|
140 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
141 |
+
|
142 |
+
// Configure API key authorization: api-key
|
143 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
144 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
145 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
146 |
+
// Configure API key authorization: partner-key
|
147 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
148 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
149 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
150 |
+
|
151 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
152 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
153 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
154 |
+
new GuzzleHttp\Client(),
|
155 |
+
$config
|
156 |
+
);
|
157 |
+
$campaignId = 789; // int | id of the SMS campaign
|
158 |
+
|
159 |
+
try {
|
160 |
+
$result = $apiInstance->getSmsCampaign($campaignId);
|
161 |
+
print_r($result);
|
162 |
+
} catch (Exception $e) {
|
163 |
+
echo 'Exception when calling SMSCampaignsApi->getSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
164 |
+
}
|
165 |
+
?>
|
166 |
+
```
|
167 |
+
|
168 |
+
### Parameters
|
169 |
+
|
170 |
+
Name | Type | Description | Notes
|
171 |
+
------------- | ------------- | ------------- | -------------
|
172 |
+
**campaignId** | **int**| id of the SMS campaign |
|
173 |
+
|
174 |
+
### Return type
|
175 |
+
|
176 |
+
[**\SendinBlue\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md)
|
177 |
+
|
178 |
+
### Authorization
|
179 |
+
|
180 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
181 |
+
|
182 |
+
### HTTP request headers
|
183 |
+
|
184 |
+
- **Content-Type**: application/json
|
185 |
+
- **Accept**: application/json
|
186 |
+
|
187 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
188 |
+
|
189 |
+
# **getSmsCampaigns**
|
190 |
+
> \SendinBlue\Client\Model\GetSmsCampaigns getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort)
|
191 |
+
|
192 |
+
Returns the information for all your created SMS campaigns
|
193 |
+
|
194 |
+
### Example
|
195 |
+
```php
|
196 |
+
<?php
|
197 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
198 |
+
|
199 |
+
// Configure API key authorization: api-key
|
200 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
201 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
202 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
203 |
+
// Configure API key authorization: partner-key
|
204 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
205 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
206 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
207 |
+
|
208 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
209 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
210 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
211 |
+
new GuzzleHttp\Client(),
|
212 |
+
$config
|
213 |
+
);
|
214 |
+
$status = "status_example"; // string | Status of campaign.
|
215 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
216 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
217 |
+
$limit = 500; // int | Number limitation for the result returned
|
218 |
+
$offset = 0; // int | Beginning point in the list to retrieve from.
|
219 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
220 |
+
|
221 |
+
try {
|
222 |
+
$result = $apiInstance->getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort);
|
223 |
+
print_r($result);
|
224 |
+
} catch (Exception $e) {
|
225 |
+
echo 'Exception when calling SMSCampaignsApi->getSmsCampaigns: ', $e->getMessage(), PHP_EOL;
|
226 |
+
}
|
227 |
+
?>
|
228 |
+
```
|
229 |
+
|
230 |
+
### Parameters
|
231 |
+
|
232 |
+
Name | Type | Description | Notes
|
233 |
+
------------- | ------------- | ------------- | -------------
|
234 |
+
**status** | **string**| Status of campaign. | [optional]
|
235 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
236 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
237 |
+
**limit** | **int**| Number limitation for the result returned | [optional] [default to 500]
|
238 |
+
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
239 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
240 |
+
|
241 |
+
### Return type
|
242 |
+
|
243 |
+
[**\SendinBlue\Client\Model\GetSmsCampaigns**](../Model/GetSmsCampaigns.md)
|
244 |
+
|
245 |
+
### Authorization
|
246 |
+
|
247 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
248 |
+
|
249 |
+
### HTTP request headers
|
250 |
+
|
251 |
+
- **Content-Type**: application/json
|
252 |
+
- **Accept**: application/json
|
253 |
+
|
254 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
255 |
+
|
256 |
+
# **requestSmsRecipientExport**
|
257 |
+
> \SendinBlue\Client\Model\CreatedProcessId requestSmsRecipientExport($campaignId, $recipientExport)
|
258 |
+
|
259 |
+
Export an SMS campaign's recipients
|
260 |
+
|
261 |
+
It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
262 |
+
|
263 |
+
### Example
|
264 |
+
```php
|
265 |
+
<?php
|
266 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
267 |
+
|
268 |
+
// Configure API key authorization: api-key
|
269 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
270 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
271 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
272 |
+
// Configure API key authorization: partner-key
|
273 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
274 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
275 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
276 |
+
|
277 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
278 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
279 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
280 |
+
new GuzzleHttp\Client(),
|
281 |
+
$config
|
282 |
+
);
|
283 |
+
$campaignId = 789; // int | id of the campaign
|
284 |
+
$recipientExport = new \SendinBlue\Client\Model\RequestSmsRecipientExport(); // \SendinBlue\Client\Model\RequestSmsRecipientExport | Values to send for a recipient export request
|
285 |
+
|
286 |
+
try {
|
287 |
+
$result = $apiInstance->requestSmsRecipientExport($campaignId, $recipientExport);
|
288 |
+
print_r($result);
|
289 |
+
} catch (Exception $e) {
|
290 |
+
echo 'Exception when calling SMSCampaignsApi->requestSmsRecipientExport: ', $e->getMessage(), PHP_EOL;
|
291 |
+
}
|
292 |
+
?>
|
293 |
+
```
|
294 |
+
|
295 |
+
### Parameters
|
296 |
+
|
297 |
+
Name | Type | Description | Notes
|
298 |
+
------------- | ------------- | ------------- | -------------
|
299 |
+
**campaignId** | **int**| id of the campaign |
|
300 |
+
**recipientExport** | [**\SendinBlue\Client\Model\RequestSmsRecipientExport**](../Model/RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional]
|
301 |
+
|
302 |
+
### Return type
|
303 |
+
|
304 |
+
[**\SendinBlue\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
305 |
+
|
306 |
+
### Authorization
|
307 |
+
|
308 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
309 |
+
|
310 |
+
### HTTP request headers
|
311 |
+
|
312 |
+
- **Content-Type**: application/json
|
313 |
+
- **Accept**: application/json
|
314 |
+
|
315 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
316 |
+
|
317 |
+
# **sendSmsCampaignNow**
|
318 |
+
> sendSmsCampaignNow($campaignId)
|
319 |
+
|
320 |
+
Send your SMS campaign immediately
|
321 |
+
|
322 |
+
### Example
|
323 |
+
```php
|
324 |
+
<?php
|
325 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
326 |
+
|
327 |
+
// Configure API key authorization: api-key
|
328 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
329 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
330 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
331 |
+
// Configure API key authorization: partner-key
|
332 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
333 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
334 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
335 |
+
|
336 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
337 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
338 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
339 |
+
new GuzzleHttp\Client(),
|
340 |
+
$config
|
341 |
+
);
|
342 |
+
$campaignId = 789; // int | id of the campaign
|
343 |
+
|
344 |
+
try {
|
345 |
+
$apiInstance->sendSmsCampaignNow($campaignId);
|
346 |
+
} catch (Exception $e) {
|
347 |
+
echo 'Exception when calling SMSCampaignsApi->sendSmsCampaignNow: ', $e->getMessage(), PHP_EOL;
|
348 |
+
}
|
349 |
+
?>
|
350 |
+
```
|
351 |
+
|
352 |
+
### Parameters
|
353 |
+
|
354 |
+
Name | Type | Description | Notes
|
355 |
+
------------- | ------------- | ------------- | -------------
|
356 |
+
**campaignId** | **int**| id of the campaign |
|
357 |
+
|
358 |
+
### Return type
|
359 |
+
|
360 |
+
void (empty response body)
|
361 |
+
|
362 |
+
### Authorization
|
363 |
+
|
364 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
365 |
+
|
366 |
+
### HTTP request headers
|
367 |
+
|
368 |
+
- **Content-Type**: application/json
|
369 |
+
- **Accept**: application/json
|
370 |
+
|
371 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
372 |
+
|
373 |
+
# **sendSmsReport**
|
374 |
+
> sendSmsReport($campaignId, $sendReport)
|
375 |
+
|
376 |
+
Send an SMS campaign's report
|
377 |
+
|
378 |
+
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
|
379 |
+
|
380 |
+
### Example
|
381 |
+
```php
|
382 |
+
<?php
|
383 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
384 |
+
|
385 |
+
// Configure API key authorization: api-key
|
386 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
387 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
388 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
389 |
+
// Configure API key authorization: partner-key
|
390 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
391 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
392 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
393 |
+
|
394 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
395 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
396 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
397 |
+
new GuzzleHttp\Client(),
|
398 |
+
$config
|
399 |
+
);
|
400 |
+
$campaignId = 789; // int | id of the campaign
|
401 |
+
$sendReport = new \SendinBlue\Client\Model\SendReport(); // \SendinBlue\Client\Model\SendReport | Values for send a report
|
402 |
+
|
403 |
+
try {
|
404 |
+
$apiInstance->sendSmsReport($campaignId, $sendReport);
|
405 |
+
} catch (Exception $e) {
|
406 |
+
echo 'Exception when calling SMSCampaignsApi->sendSmsReport: ', $e->getMessage(), PHP_EOL;
|
407 |
+
}
|
408 |
+
?>
|
409 |
+
```
|
410 |
+
|
411 |
+
### Parameters
|
412 |
+
|
413 |
+
Name | Type | Description | Notes
|
414 |
+
------------- | ------------- | ------------- | -------------
|
415 |
+
**campaignId** | **int**| id of the campaign |
|
416 |
+
**sendReport** | [**\SendinBlue\Client\Model\SendReport**](../Model/SendReport.md)| Values for send a report |
|
417 |
+
|
418 |
+
### Return type
|
419 |
+
|
420 |
+
void (empty response body)
|
421 |
+
|
422 |
+
### Authorization
|
423 |
+
|
424 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
425 |
+
|
426 |
+
### HTTP request headers
|
427 |
+
|
428 |
+
- **Content-Type**: application/json
|
429 |
+
- **Accept**: application/json
|
430 |
+
|
431 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
432 |
+
|
433 |
+
# **sendTestSms**
|
434 |
+
> sendTestSms($campaignId, $phoneNumber)
|
435 |
+
|
436 |
+
Send a test SMS campaign
|
437 |
+
|
438 |
+
### Example
|
439 |
+
```php
|
440 |
+
<?php
|
441 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
442 |
+
|
443 |
+
// Configure API key authorization: api-key
|
444 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
445 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
446 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
447 |
+
// Configure API key authorization: partner-key
|
448 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
449 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
450 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
451 |
+
|
452 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
453 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
454 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
455 |
+
new GuzzleHttp\Client(),
|
456 |
+
$config
|
457 |
+
);
|
458 |
+
$campaignId = 789; // int | Id of the SMS campaign
|
459 |
+
$phoneNumber = new \SendinBlue\Client\Model\SendTestSms(); // \SendinBlue\Client\Model\SendTestSms | 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
|
460 |
+
|
461 |
+
try {
|
462 |
+
$apiInstance->sendTestSms($campaignId, $phoneNumber);
|
463 |
+
} catch (Exception $e) {
|
464 |
+
echo 'Exception when calling SMSCampaignsApi->sendTestSms: ', $e->getMessage(), PHP_EOL;
|
465 |
+
}
|
466 |
+
?>
|
467 |
+
```
|
468 |
+
|
469 |
+
### Parameters
|
470 |
+
|
471 |
+
Name | Type | Description | Notes
|
472 |
+
------------- | ------------- | ------------- | -------------
|
473 |
+
**campaignId** | **int**| Id of the SMS campaign |
|
474 |
+
**phoneNumber** | [**\SendinBlue\Client\Model\SendTestSms**](../Model/SendTestSms.md)| 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 |
|
475 |
+
|
476 |
+
### Return type
|
477 |
+
|
478 |
+
void (empty response body)
|
479 |
+
|
480 |
+
### Authorization
|
481 |
+
|
482 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
483 |
+
|
484 |
+
### HTTP request headers
|
485 |
+
|
486 |
+
- **Content-Type**: application/json
|
487 |
+
- **Accept**: application/json
|
488 |
+
|
489 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
490 |
+
|
491 |
+
# **updateSmsCampaign**
|
492 |
+
> updateSmsCampaign($campaignId, $updateSmsCampaign)
|
493 |
+
|
494 |
+
Update an SMS campaign
|
495 |
+
|
496 |
+
### Example
|
497 |
+
```php
|
498 |
+
<?php
|
499 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
500 |
+
|
501 |
+
// Configure API key authorization: api-key
|
502 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
503 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
504 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
505 |
+
// Configure API key authorization: partner-key
|
506 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
507 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
508 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
509 |
+
|
510 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
511 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
512 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
513 |
+
new GuzzleHttp\Client(),
|
514 |
+
$config
|
515 |
+
);
|
516 |
+
$campaignId = 789; // int | id of the SMS campaign
|
517 |
+
$updateSmsCampaign = new \SendinBlue\Client\Model\UpdateSmsCampaign(); // \SendinBlue\Client\Model\UpdateSmsCampaign | Values to update an SMS Campaign
|
518 |
+
|
519 |
+
try {
|
520 |
+
$apiInstance->updateSmsCampaign($campaignId, $updateSmsCampaign);
|
521 |
+
} catch (Exception $e) {
|
522 |
+
echo 'Exception when calling SMSCampaignsApi->updateSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
523 |
+
}
|
524 |
+
?>
|
525 |
+
```
|
526 |
+
|
527 |
+
### Parameters
|
528 |
+
|
529 |
+
Name | Type | Description | Notes
|
530 |
+
------------- | ------------- | ------------- | -------------
|
531 |
+
**campaignId** | **int**| id of the SMS campaign |
|
532 |
+
**updateSmsCampaign** | [**\SendinBlue\Client\Model\UpdateSmsCampaign**](../Model/UpdateSmsCampaign.md)| Values to update an SMS Campaign |
|
533 |
+
|
534 |
+
### Return type
|
535 |
+
|
536 |
+
void (empty response body)
|
537 |
+
|
538 |
+
### Authorization
|
539 |
+
|
540 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
541 |
+
|
542 |
+
### HTTP request headers
|
543 |
+
|
544 |
+
- **Content-Type**: application/json
|
545 |
+
- **Accept**: application/json
|
546 |
+
|
547 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
548 |
+
|
549 |
+
# **updateSmsCampaignStatus**
|
550 |
+
> updateSmsCampaignStatus($campaignId, $status)
|
551 |
+
|
552 |
+
Update a campaign's status
|
553 |
+
|
554 |
+
### Example
|
555 |
+
```php
|
556 |
+
<?php
|
557 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
558 |
+
|
559 |
+
// Configure API key authorization: api-key
|
560 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
561 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
562 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
563 |
+
// Configure API key authorization: partner-key
|
564 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
565 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
566 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
567 |
+
|
568 |
+
$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
|
569 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
570 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
571 |
+
new GuzzleHttp\Client(),
|
572 |
+
$config
|
573 |
+
);
|
574 |
+
$campaignId = 789; // int | id of the campaign
|
575 |
+
$status = new \SendinBlue\Client\Model\UpdateCampaignStatus(); // \SendinBlue\Client\Model\UpdateCampaignStatus | Status of the campaign.
|
576 |
+
|
577 |
+
try {
|
578 |
+
$apiInstance->updateSmsCampaignStatus($campaignId, $status);
|
579 |
+
} catch (Exception $e) {
|
580 |
+
echo 'Exception when calling SMSCampaignsApi->updateSmsCampaignStatus: ', $e->getMessage(), PHP_EOL;
|
581 |
+
}
|
582 |
+
?>
|
583 |
+
```
|
584 |
+
|
585 |
+
### Parameters
|
586 |
+
|
587 |
+
Name | Type | Description | Notes
|
588 |
+
------------- | ------------- | ------------- | -------------
|
589 |
+
**campaignId** | **int**| id of the campaign |
|
590 |
+
**status** | [**\SendinBlue\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign. |
|
591 |
+
|
592 |
+
### Return type
|
593 |
+
|
594 |
+
void (empty response body)
|
595 |
+
|
596 |
+
### Authorization
|
597 |
+
|
598 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
599 |
+
|
600 |
+
### HTTP request headers
|
601 |
+
|
602 |
+
- **Content-Type**: application/json
|
603 |
+
- **Accept**: application/json
|
604 |
+
|
605 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
606 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/SendersApi.md
ADDED
@@ -0,0 +1,354 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\SendersApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**createSender**](SendersApi.md#createSender) | **POST** /senders | Create a new sender
|
8 |
+
[**deleteSender**](SendersApi.md#deleteSender) | **DELETE** /senders/{senderId} | Delete a sender
|
9 |
+
[**getIps**](SendersApi.md#getIps) | **GET** /senders/ips | Get all the dedicated IPs for your account
|
10 |
+
[**getIpsFromSender**](SendersApi.md#getIpsFromSender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
11 |
+
[**getSenders**](SendersApi.md#getSenders) | **GET** /senders | Get the list of all your senders
|
12 |
+
[**updateSender**](SendersApi.md#updateSender) | **PUT** /senders/{senderId} | Update a sender
|
13 |
+
|
14 |
+
|
15 |
+
# **createSender**
|
16 |
+
> \SendinBlue\Client\Model\CreateSenderModel createSender($sender)
|
17 |
+
|
18 |
+
Create a new sender
|
19 |
+
|
20 |
+
### Example
|
21 |
+
```php
|
22 |
+
<?php
|
23 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
24 |
+
|
25 |
+
// Configure API key authorization: api-key
|
26 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
27 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
28 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
29 |
+
// Configure API key authorization: partner-key
|
30 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
31 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
32 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
33 |
+
|
34 |
+
$apiInstance = new SendinBlue\Client\Api\SendersApi(
|
35 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
36 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
37 |
+
new GuzzleHttp\Client(),
|
38 |
+
$config
|
39 |
+
);
|
40 |
+
$sender = new \SendinBlue\Client\Model\CreateSender(); // \SendinBlue\Client\Model\CreateSender | sender's name
|
41 |
+
|
42 |
+
try {
|
43 |
+
$result = $apiInstance->createSender($sender);
|
44 |
+
print_r($result);
|
45 |
+
} catch (Exception $e) {
|
46 |
+
echo 'Exception when calling SendersApi->createSender: ', $e->getMessage(), PHP_EOL;
|
47 |
+
}
|
48 |
+
?>
|
49 |
+
```
|
50 |
+
|
51 |
+
### Parameters
|
52 |
+
|
53 |
+
Name | Type | Description | Notes
|
54 |
+
------------- | ------------- | ------------- | -------------
|
55 |
+
**sender** | [**\SendinBlue\Client\Model\CreateSender**](../Model/CreateSender.md)| sender's name | [optional]
|
56 |
+
|
57 |
+
### Return type
|
58 |
+
|
59 |
+
[**\SendinBlue\Client\Model\CreateSenderModel**](../Model/CreateSenderModel.md)
|
60 |
+
|
61 |
+
### Authorization
|
62 |
+
|
63 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
64 |
+
|
65 |
+
### HTTP request headers
|
66 |
+
|
67 |
+
- **Content-Type**: application/json
|
68 |
+
- **Accept**: application/json
|
69 |
+
|
70 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
71 |
+
|
72 |
+
# **deleteSender**
|
73 |
+
> deleteSender($senderId)
|
74 |
+
|
75 |
+
Delete a sender
|
76 |
+
|
77 |
+
### Example
|
78 |
+
```php
|
79 |
+
<?php
|
80 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
81 |
+
|
82 |
+
// Configure API key authorization: api-key
|
83 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
84 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
85 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
86 |
+
// Configure API key authorization: partner-key
|
87 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
88 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
89 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
90 |
+
|
91 |
+
$apiInstance = new SendinBlue\Client\Api\SendersApi(
|
92 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
93 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
94 |
+
new GuzzleHttp\Client(),
|
95 |
+
$config
|
96 |
+
);
|
97 |
+
$senderId = 789; // int | Id of the sender
|
98 |
+
|
99 |
+
try {
|
100 |
+
$apiInstance->deleteSender($senderId);
|
101 |
+
} catch (Exception $e) {
|
102 |
+
echo 'Exception when calling SendersApi->deleteSender: ', $e->getMessage(), PHP_EOL;
|
103 |
+
}
|
104 |
+
?>
|
105 |
+
```
|
106 |
+
|
107 |
+
### Parameters
|
108 |
+
|
109 |
+
Name | Type | Description | Notes
|
110 |
+
------------- | ------------- | ------------- | -------------
|
111 |
+
**senderId** | **int**| Id of the sender |
|
112 |
+
|
113 |
+
### Return type
|
114 |
+
|
115 |
+
void (empty response body)
|
116 |
+
|
117 |
+
### Authorization
|
118 |
+
|
119 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
120 |
+
|
121 |
+
### HTTP request headers
|
122 |
+
|
123 |
+
- **Content-Type**: application/json
|
124 |
+
- **Accept**: application/json
|
125 |
+
|
126 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
127 |
+
|
128 |
+
# **getIps**
|
129 |
+
> \SendinBlue\Client\Model\GetIps getIps()
|
130 |
+
|
131 |
+
Get all the dedicated IPs for your account
|
132 |
+
|
133 |
+
### Example
|
134 |
+
```php
|
135 |
+
<?php
|
136 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
137 |
+
|
138 |
+
// Configure API key authorization: api-key
|
139 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
140 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
141 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
142 |
+
// Configure API key authorization: partner-key
|
143 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
144 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
145 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
146 |
+
|
147 |
+
$apiInstance = new SendinBlue\Client\Api\SendersApi(
|
148 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
149 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
150 |
+
new GuzzleHttp\Client(),
|
151 |
+
$config
|
152 |
+
);
|
153 |
+
|
154 |
+
try {
|
155 |
+
$result = $apiInstance->getIps();
|
156 |
+
print_r($result);
|
157 |
+
} catch (Exception $e) {
|
158 |
+
echo 'Exception when calling SendersApi->getIps: ', $e->getMessage(), PHP_EOL;
|
159 |
+
}
|
160 |
+
?>
|
161 |
+
```
|
162 |
+
|
163 |
+
### Parameters
|
164 |
+
This endpoint does not need any parameter.
|
165 |
+
|
166 |
+
### Return type
|
167 |
+
|
168 |
+
[**\SendinBlue\Client\Model\GetIps**](../Model/GetIps.md)
|
169 |
+
|
170 |
+
### Authorization
|
171 |
+
|
172 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
173 |
+
|
174 |
+
### HTTP request headers
|
175 |
+
|
176 |
+
- **Content-Type**: application/json
|
177 |
+
- **Accept**: application/json
|
178 |
+
|
179 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
180 |
+
|
181 |
+
# **getIpsFromSender**
|
182 |
+
> \SendinBlue\Client\Model\GetIpsFromSender getIpsFromSender($senderId)
|
183 |
+
|
184 |
+
Get all the dedicated IPs for a sender
|
185 |
+
|
186 |
+
### Example
|
187 |
+
```php
|
188 |
+
<?php
|
189 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
190 |
+
|
191 |
+
// Configure API key authorization: api-key
|
192 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
193 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
194 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
195 |
+
// Configure API key authorization: partner-key
|
196 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
197 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
198 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
199 |
+
|
200 |
+
$apiInstance = new SendinBlue\Client\Api\SendersApi(
|
201 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
202 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
203 |
+
new GuzzleHttp\Client(),
|
204 |
+
$config
|
205 |
+
);
|
206 |
+
$senderId = 789; // int | Id of the sender
|
207 |
+
|
208 |
+
try {
|
209 |
+
$result = $apiInstance->getIpsFromSender($senderId);
|
210 |
+
print_r($result);
|
211 |
+
} catch (Exception $e) {
|
212 |
+
echo 'Exception when calling SendersApi->getIpsFromSender: ', $e->getMessage(), PHP_EOL;
|
213 |
+
}
|
214 |
+
?>
|
215 |
+
```
|
216 |
+
|
217 |
+
### Parameters
|
218 |
+
|
219 |
+
Name | Type | Description | Notes
|
220 |
+
------------- | ------------- | ------------- | -------------
|
221 |
+
**senderId** | **int**| Id of the sender |
|
222 |
+
|
223 |
+
### Return type
|
224 |
+
|
225 |
+
[**\SendinBlue\Client\Model\GetIpsFromSender**](../Model/GetIpsFromSender.md)
|
226 |
+
|
227 |
+
### Authorization
|
228 |
+
|
229 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
230 |
+
|
231 |
+
### HTTP request headers
|
232 |
+
|
233 |
+
- **Content-Type**: application/json
|
234 |
+
- **Accept**: application/json
|
235 |
+
|
236 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
237 |
+
|
238 |
+
# **getSenders**
|
239 |
+
> \SendinBlue\Client\Model\GetSendersList getSenders($ip, $domain)
|
240 |
+
|
241 |
+
Get the list of all your senders
|
242 |
+
|
243 |
+
### Example
|
244 |
+
```php
|
245 |
+
<?php
|
246 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
247 |
+
|
248 |
+
// Configure API key authorization: api-key
|
249 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
250 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
251 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
252 |
+
// Configure API key authorization: partner-key
|
253 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
254 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
255 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
256 |
+
|
257 |
+
$apiInstance = new SendinBlue\Client\Api\SendersApi(
|
258 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
259 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
260 |
+
new GuzzleHttp\Client(),
|
261 |
+
$config
|
262 |
+
);
|
263 |
+
$ip = "ip_example"; // string | Filter your senders for a specific ip (available for dedicated IP usage only)
|
264 |
+
$domain = "domain_example"; // string | Filter your senders for a specific domain
|
265 |
+
|
266 |
+
try {
|
267 |
+
$result = $apiInstance->getSenders($ip, $domain);
|
268 |
+
print_r($result);
|
269 |
+
} catch (Exception $e) {
|
270 |
+
echo 'Exception when calling SendersApi->getSenders: ', $e->getMessage(), PHP_EOL;
|
271 |
+
}
|
272 |
+
?>
|
273 |
+
```
|
274 |
+
|
275 |
+
### Parameters
|
276 |
+
|
277 |
+
Name | Type | Description | Notes
|
278 |
+
------------- | ------------- | ------------- | -------------
|
279 |
+
**ip** | **string**| Filter your senders for a specific ip (available for dedicated IP usage only) | [optional]
|
280 |
+
**domain** | **string**| Filter your senders for a specific domain | [optional]
|
281 |
+
|
282 |
+
### Return type
|
283 |
+
|
284 |
+
[**\SendinBlue\Client\Model\GetSendersList**](../Model/GetSendersList.md)
|
285 |
+
|
286 |
+
### Authorization
|
287 |
+
|
288 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
289 |
+
|
290 |
+
### HTTP request headers
|
291 |
+
|
292 |
+
- **Content-Type**: application/json
|
293 |
+
- **Accept**: application/json
|
294 |
+
|
295 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
296 |
+
|
297 |
+
# **updateSender**
|
298 |
+
> updateSender($senderId, $sender)
|
299 |
+
|
300 |
+
Update a sender
|
301 |
+
|
302 |
+
### Example
|
303 |
+
```php
|
304 |
+
<?php
|
305 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
306 |
+
|
307 |
+
// Configure API key authorization: api-key
|
308 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
309 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
310 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
311 |
+
// Configure API key authorization: partner-key
|
312 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
313 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
314 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
315 |
+
|
316 |
+
$apiInstance = new SendinBlue\Client\Api\SendersApi(
|
317 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
318 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
319 |
+
new GuzzleHttp\Client(),
|
320 |
+
$config
|
321 |
+
);
|
322 |
+
$senderId = 789; // int | Id of the sender
|
323 |
+
$sender = new \SendinBlue\Client\Model\UpdateSender(); // \SendinBlue\Client\Model\UpdateSender | sender's name
|
324 |
+
|
325 |
+
try {
|
326 |
+
$apiInstance->updateSender($senderId, $sender);
|
327 |
+
} catch (Exception $e) {
|
328 |
+
echo 'Exception when calling SendersApi->updateSender: ', $e->getMessage(), PHP_EOL;
|
329 |
+
}
|
330 |
+
?>
|
331 |
+
```
|
332 |
+
|
333 |
+
### Parameters
|
334 |
+
|
335 |
+
Name | Type | Description | Notes
|
336 |
+
------------- | ------------- | ------------- | -------------
|
337 |
+
**senderId** | **int**| Id of the sender |
|
338 |
+
**sender** | [**\SendinBlue\Client\Model\UpdateSender**](../Model/UpdateSender.md)| sender's name | [optional]
|
339 |
+
|
340 |
+
### Return type
|
341 |
+
|
342 |
+
void (empty response body)
|
343 |
+
|
344 |
+
### Authorization
|
345 |
+
|
346 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
347 |
+
|
348 |
+
### HTTP request headers
|
349 |
+
|
350 |
+
- **Content-Type**: application/json
|
351 |
+
- **Accept**: application/json
|
352 |
+
|
353 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
354 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/TransactionalEmailsApi.md
ADDED
@@ -0,0 +1,1379 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\TransactionalEmailsApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**blockNewDomain**](TransactionalEmailsApi.md#blockNewDomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
8 |
+
[**createSmtpTemplate**](TransactionalEmailsApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an email template
|
9 |
+
[**deleteBlockedDomain**](TransactionalEmailsApi.md#deleteBlockedDomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
10 |
+
[**deleteHardbounces**](TransactionalEmailsApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
11 |
+
[**deleteSmtpTemplate**](TransactionalEmailsApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
12 |
+
[**getAggregatedSmtpReport**](TransactionalEmailsApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
13 |
+
[**getBlockedDomains**](TransactionalEmailsApi.md#getBlockedDomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
14 |
+
[**getEmailEventReport**](TransactionalEmailsApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
15 |
+
[**getScheduledEmailByBatchId**](TransactionalEmailsApi.md#getScheduledEmailByBatchId) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
|
16 |
+
[**getScheduledEmailById**](TransactionalEmailsApi.md#getScheduledEmailById) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
|
17 |
+
[**getScheduledEmailByMessageId**](TransactionalEmailsApi.md#getScheduledEmailByMessageId) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
|
18 |
+
[**getSmtpReport**](TransactionalEmailsApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
19 |
+
[**getSmtpTemplate**](TransactionalEmailsApi.md#getSmtpTemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
|
20 |
+
[**getSmtpTemplates**](TransactionalEmailsApi.md#getSmtpTemplates) | **GET** /smtp/templates | Get the list of email templates
|
21 |
+
[**getTransacBlockedContacts**](TransactionalEmailsApi.md#getTransacBlockedContacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
22 |
+
[**getTransacEmailContent**](TransactionalEmailsApi.md#getTransacEmailContent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
23 |
+
[**getTransacEmailsList**](TransactionalEmailsApi.md#getTransacEmailsList) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
24 |
+
[**sendTestTemplate**](TransactionalEmailsApi.md#sendTestTemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
25 |
+
[**sendTransacEmail**](TransactionalEmailsApi.md#sendTransacEmail) | **POST** /smtp/email | Send a transactional email
|
26 |
+
[**smtpBlockedContactsEmailDelete**](TransactionalEmailsApi.md#smtpBlockedContactsEmailDelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
27 |
+
[**smtpLogMessageIdDelete**](TransactionalEmailsApi.md#smtpLogMessageIdDelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
28 |
+
[**updateSmtpTemplate**](TransactionalEmailsApi.md#updateSmtpTemplate) | **PUT** /smtp/templates/{templateId} | Update an email template
|
29 |
+
|
30 |
+
|
31 |
+
# **blockNewDomain**
|
32 |
+
> blockNewDomain($blockDomain)
|
33 |
+
|
34 |
+
Add a new domain to the list of blocked domains
|
35 |
+
|
36 |
+
Blocks a new domain in order to avoid messages being sent to the same
|
37 |
+
|
38 |
+
### Example
|
39 |
+
```php
|
40 |
+
<?php
|
41 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
42 |
+
|
43 |
+
// Configure API key authorization: api-key
|
44 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
45 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
46 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
47 |
+
// Configure API key authorization: partner-key
|
48 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
49 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
50 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
51 |
+
|
52 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
53 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
54 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
55 |
+
new GuzzleHttp\Client(),
|
56 |
+
$config
|
57 |
+
);
|
58 |
+
$blockDomain = new \SendinBlue\Client\Model\BlockDomain(); // \SendinBlue\Client\Model\BlockDomain |
|
59 |
+
|
60 |
+
try {
|
61 |
+
$apiInstance->blockNewDomain($blockDomain);
|
62 |
+
} catch (Exception $e) {
|
63 |
+
echo 'Exception when calling TransactionalEmailsApi->blockNewDomain: ', $e->getMessage(), PHP_EOL;
|
64 |
+
}
|
65 |
+
?>
|
66 |
+
```
|
67 |
+
|
68 |
+
### Parameters
|
69 |
+
|
70 |
+
Name | Type | Description | Notes
|
71 |
+
------------- | ------------- | ------------- | -------------
|
72 |
+
**blockDomain** | [**\SendinBlue\Client\Model\BlockDomain**](../Model/BlockDomain.md)| |
|
73 |
+
|
74 |
+
### Return type
|
75 |
+
|
76 |
+
void (empty response body)
|
77 |
+
|
78 |
+
### Authorization
|
79 |
+
|
80 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
81 |
+
|
82 |
+
### HTTP request headers
|
83 |
+
|
84 |
+
- **Content-Type**: application/json
|
85 |
+
- **Accept**: application/json
|
86 |
+
|
87 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
88 |
+
|
89 |
+
# **createSmtpTemplate**
|
90 |
+
> \SendinBlue\Client\Model\CreateModel createSmtpTemplate($smtpTemplate)
|
91 |
+
|
92 |
+
Create an email template
|
93 |
+
|
94 |
+
### Example
|
95 |
+
```php
|
96 |
+
<?php
|
97 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
98 |
+
|
99 |
+
// Configure API key authorization: api-key
|
100 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
101 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
102 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
103 |
+
// Configure API key authorization: partner-key
|
104 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
105 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
106 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
107 |
+
|
108 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
109 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
110 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
111 |
+
new GuzzleHttp\Client(),
|
112 |
+
$config
|
113 |
+
);
|
114 |
+
$smtpTemplate = new \SendinBlue\Client\Model\CreateSmtpTemplate(); // \SendinBlue\Client\Model\CreateSmtpTemplate | values to update in transactional email template
|
115 |
+
|
116 |
+
try {
|
117 |
+
$result = $apiInstance->createSmtpTemplate($smtpTemplate);
|
118 |
+
print_r($result);
|
119 |
+
} catch (Exception $e) {
|
120 |
+
echo 'Exception when calling TransactionalEmailsApi->createSmtpTemplate: ', $e->getMessage(), PHP_EOL;
|
121 |
+
}
|
122 |
+
?>
|
123 |
+
```
|
124 |
+
|
125 |
+
### Parameters
|
126 |
+
|
127 |
+
Name | Type | Description | Notes
|
128 |
+
------------- | ------------- | ------------- | -------------
|
129 |
+
**smtpTemplate** | [**\SendinBlue\Client\Model\CreateSmtpTemplate**](../Model/CreateSmtpTemplate.md)| values to update in transactional email template |
|
130 |
+
|
131 |
+
### Return type
|
132 |
+
|
133 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
134 |
+
|
135 |
+
### Authorization
|
136 |
+
|
137 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
138 |
+
|
139 |
+
### HTTP request headers
|
140 |
+
|
141 |
+
- **Content-Type**: application/json
|
142 |
+
- **Accept**: application/json
|
143 |
+
|
144 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
145 |
+
|
146 |
+
# **deleteBlockedDomain**
|
147 |
+
> deleteBlockedDomain($domain)
|
148 |
+
|
149 |
+
Unblock an existing domain from the list of blocked domains
|
150 |
+
|
151 |
+
Unblocks an existing domain from the list of blocked domains
|
152 |
+
|
153 |
+
### Example
|
154 |
+
```php
|
155 |
+
<?php
|
156 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
157 |
+
|
158 |
+
// Configure API key authorization: api-key
|
159 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
160 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
161 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
162 |
+
// Configure API key authorization: partner-key
|
163 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
164 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
165 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
166 |
+
|
167 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
168 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
169 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
170 |
+
new GuzzleHttp\Client(),
|
171 |
+
$config
|
172 |
+
);
|
173 |
+
$domain = "domain_example"; // string | The name of the domain to be deleted
|
174 |
+
|
175 |
+
try {
|
176 |
+
$apiInstance->deleteBlockedDomain($domain);
|
177 |
+
} catch (Exception $e) {
|
178 |
+
echo 'Exception when calling TransactionalEmailsApi->deleteBlockedDomain: ', $e->getMessage(), PHP_EOL;
|
179 |
+
}
|
180 |
+
?>
|
181 |
+
```
|
182 |
+
|
183 |
+
### Parameters
|
184 |
+
|
185 |
+
Name | Type | Description | Notes
|
186 |
+
------------- | ------------- | ------------- | -------------
|
187 |
+
**domain** | **string**| The name of the domain to be deleted |
|
188 |
+
|
189 |
+
### Return type
|
190 |
+
|
191 |
+
void (empty response body)
|
192 |
+
|
193 |
+
### Authorization
|
194 |
+
|
195 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
196 |
+
|
197 |
+
### HTTP request headers
|
198 |
+
|
199 |
+
- **Content-Type**: application/json
|
200 |
+
- **Accept**: application/json
|
201 |
+
|
202 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
203 |
+
|
204 |
+
# **deleteHardbounces**
|
205 |
+
> deleteHardbounces($deleteHardbounces)
|
206 |
+
|
207 |
+
Delete hardbounces
|
208 |
+
|
209 |
+
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
210 |
+
|
211 |
+
### Example
|
212 |
+
```php
|
213 |
+
<?php
|
214 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
215 |
+
|
216 |
+
// Configure API key authorization: api-key
|
217 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
218 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
219 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
220 |
+
// Configure API key authorization: partner-key
|
221 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
222 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
223 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
224 |
+
|
225 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
226 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
227 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
228 |
+
new GuzzleHttp\Client(),
|
229 |
+
$config
|
230 |
+
);
|
231 |
+
$deleteHardbounces = new \SendinBlue\Client\Model\DeleteHardbounces(); // \SendinBlue\Client\Model\DeleteHardbounces | values to delete hardbounces
|
232 |
+
|
233 |
+
try {
|
234 |
+
$apiInstance->deleteHardbounces($deleteHardbounces);
|
235 |
+
} catch (Exception $e) {
|
236 |
+
echo 'Exception when calling TransactionalEmailsApi->deleteHardbounces: ', $e->getMessage(), PHP_EOL;
|
237 |
+
}
|
238 |
+
?>
|
239 |
+
```
|
240 |
+
|
241 |
+
### Parameters
|
242 |
+
|
243 |
+
Name | Type | Description | Notes
|
244 |
+
------------- | ------------- | ------------- | -------------
|
245 |
+
**deleteHardbounces** | [**\SendinBlue\Client\Model\DeleteHardbounces**](../Model/DeleteHardbounces.md)| values to delete hardbounces | [optional]
|
246 |
+
|
247 |
+
### Return type
|
248 |
+
|
249 |
+
void (empty response body)
|
250 |
+
|
251 |
+
### Authorization
|
252 |
+
|
253 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
254 |
+
|
255 |
+
### HTTP request headers
|
256 |
+
|
257 |
+
- **Content-Type**: application/json
|
258 |
+
- **Accept**: application/json
|
259 |
+
|
260 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
261 |
+
|
262 |
+
# **deleteSmtpTemplate**
|
263 |
+
> deleteSmtpTemplate($templateId)
|
264 |
+
|
265 |
+
Delete an inactive email template
|
266 |
+
|
267 |
+
### Example
|
268 |
+
```php
|
269 |
+
<?php
|
270 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
271 |
+
|
272 |
+
// Configure API key authorization: api-key
|
273 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
274 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
275 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
276 |
+
// Configure API key authorization: partner-key
|
277 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
278 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
279 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
280 |
+
|
281 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
282 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
283 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
284 |
+
new GuzzleHttp\Client(),
|
285 |
+
$config
|
286 |
+
);
|
287 |
+
$templateId = 789; // int | id of the template
|
288 |
+
|
289 |
+
try {
|
290 |
+
$apiInstance->deleteSmtpTemplate($templateId);
|
291 |
+
} catch (Exception $e) {
|
292 |
+
echo 'Exception when calling TransactionalEmailsApi->deleteSmtpTemplate: ', $e->getMessage(), PHP_EOL;
|
293 |
+
}
|
294 |
+
?>
|
295 |
+
```
|
296 |
+
|
297 |
+
### Parameters
|
298 |
+
|
299 |
+
Name | Type | Description | Notes
|
300 |
+
------------- | ------------- | ------------- | -------------
|
301 |
+
**templateId** | **int**| id of the template |
|
302 |
+
|
303 |
+
### Return type
|
304 |
+
|
305 |
+
void (empty response body)
|
306 |
+
|
307 |
+
### Authorization
|
308 |
+
|
309 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
310 |
+
|
311 |
+
### HTTP request headers
|
312 |
+
|
313 |
+
- **Content-Type**: application/json
|
314 |
+
- **Accept**: application/json
|
315 |
+
|
316 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
317 |
+
|
318 |
+
# **getAggregatedSmtpReport**
|
319 |
+
> \SendinBlue\Client\Model\GetAggregatedReport getAggregatedSmtpReport($startDate, $endDate, $days, $tag)
|
320 |
+
|
321 |
+
Get your transactional email activity aggregated over a period of time
|
322 |
+
|
323 |
+
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
324 |
+
|
325 |
+
### Example
|
326 |
+
```php
|
327 |
+
<?php
|
328 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
329 |
+
|
330 |
+
// Configure API key authorization: api-key
|
331 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
332 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
333 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
334 |
+
// Configure API key authorization: partner-key
|
335 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
336 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
337 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
338 |
+
|
339 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
340 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
341 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
342 |
+
new GuzzleHttp\Client(),
|
343 |
+
$config
|
344 |
+
);
|
345 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
346 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
347 |
+
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
348 |
+
$tag = "tag_example"; // string | Tag of the emails
|
349 |
+
|
350 |
+
try {
|
351 |
+
$result = $apiInstance->getAggregatedSmtpReport($startDate, $endDate, $days, $tag);
|
352 |
+
print_r($result);
|
353 |
+
} catch (Exception $e) {
|
354 |
+
echo 'Exception when calling TransactionalEmailsApi->getAggregatedSmtpReport: ', $e->getMessage(), PHP_EOL;
|
355 |
+
}
|
356 |
+
?>
|
357 |
+
```
|
358 |
+
|
359 |
+
### Parameters
|
360 |
+
|
361 |
+
Name | Type | Description | Notes
|
362 |
+
------------- | ------------- | ------------- | -------------
|
363 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
364 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
365 |
+
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
366 |
+
**tag** | **string**| Tag of the emails | [optional]
|
367 |
+
|
368 |
+
### Return type
|
369 |
+
|
370 |
+
[**\SendinBlue\Client\Model\GetAggregatedReport**](../Model/GetAggregatedReport.md)
|
371 |
+
|
372 |
+
### Authorization
|
373 |
+
|
374 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
375 |
+
|
376 |
+
### HTTP request headers
|
377 |
+
|
378 |
+
- **Content-Type**: application/json
|
379 |
+
- **Accept**: application/json
|
380 |
+
|
381 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
382 |
+
|
383 |
+
# **getBlockedDomains**
|
384 |
+
> \SendinBlue\Client\Model\GetBlockedDomains getBlockedDomains()
|
385 |
+
|
386 |
+
Get the list of blocked domains
|
387 |
+
|
388 |
+
Get the list of blocked domains
|
389 |
+
|
390 |
+
### Example
|
391 |
+
```php
|
392 |
+
<?php
|
393 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
394 |
+
|
395 |
+
// Configure API key authorization: api-key
|
396 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
397 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
398 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
399 |
+
// Configure API key authorization: partner-key
|
400 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
401 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
402 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
403 |
+
|
404 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
405 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
406 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
407 |
+
new GuzzleHttp\Client(),
|
408 |
+
$config
|
409 |
+
);
|
410 |
+
|
411 |
+
try {
|
412 |
+
$result = $apiInstance->getBlockedDomains();
|
413 |
+
print_r($result);
|
414 |
+
} catch (Exception $e) {
|
415 |
+
echo 'Exception when calling TransactionalEmailsApi->getBlockedDomains: ', $e->getMessage(), PHP_EOL;
|
416 |
+
}
|
417 |
+
?>
|
418 |
+
```
|
419 |
+
|
420 |
+
### Parameters
|
421 |
+
This endpoint does not need any parameter.
|
422 |
+
|
423 |
+
### Return type
|
424 |
+
|
425 |
+
[**\SendinBlue\Client\Model\GetBlockedDomains**](../Model/GetBlockedDomains.md)
|
426 |
+
|
427 |
+
### Authorization
|
428 |
+
|
429 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
430 |
+
|
431 |
+
### HTTP request headers
|
432 |
+
|
433 |
+
- **Content-Type**: application/json
|
434 |
+
- **Accept**: application/json
|
435 |
+
|
436 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
437 |
+
|
438 |
+
# **getEmailEventReport**
|
439 |
+
> \SendinBlue\Client\Model\GetEmailEventReport getEmailEventReport($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort)
|
440 |
+
|
441 |
+
Get all your transactional email activity (unaggregated events)
|
442 |
+
|
443 |
+
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
444 |
+
|
445 |
+
### Example
|
446 |
+
```php
|
447 |
+
<?php
|
448 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
449 |
+
|
450 |
+
// Configure API key authorization: api-key
|
451 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
452 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
453 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
454 |
+
// Configure API key authorization: partner-key
|
455 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
456 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
457 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
458 |
+
|
459 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
460 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
461 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
462 |
+
new GuzzleHttp\Client(),
|
463 |
+
$config
|
464 |
+
);
|
465 |
+
$limit = 50; // int | Number limitation for the result returned
|
466 |
+
$offset = 0; // int | Beginning point in the list to retrieve from.
|
467 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
468 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
469 |
+
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
470 |
+
$email = "email_example"; // string | Filter the report for a specific email addresses
|
471 |
+
$event = "event_example"; // string | Filter the report for a specific event type
|
472 |
+
$tags = "tags_example"; // string | Filter the report for tags (serialized and urlencoded array)
|
473 |
+
$messageId = "messageId_example"; // string | Filter on a specific message id
|
474 |
+
$templateId = 789; // int | Filter on a specific template id
|
475 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
476 |
+
|
477 |
+
try {
|
478 |
+
$result = $apiInstance->getEmailEventReport($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort);
|
479 |
+
print_r($result);
|
480 |
+
} catch (Exception $e) {
|
481 |
+
echo 'Exception when calling TransactionalEmailsApi->getEmailEventReport: ', $e->getMessage(), PHP_EOL;
|
482 |
+
}
|
483 |
+
?>
|
484 |
+
```
|
485 |
+
|
486 |
+
### Parameters
|
487 |
+
|
488 |
+
Name | Type | Description | Notes
|
489 |
+
------------- | ------------- | ------------- | -------------
|
490 |
+
**limit** | **int**| Number limitation for the result returned | [optional] [default to 50]
|
491 |
+
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
492 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
493 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
494 |
+
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
495 |
+
**email** | **string**| Filter the report for a specific email addresses | [optional]
|
496 |
+
**event** | **string**| Filter the report for a specific event type | [optional]
|
497 |
+
**tags** | **string**| Filter the report for tags (serialized and urlencoded array) | [optional]
|
498 |
+
**messageId** | **string**| Filter on a specific message id | [optional]
|
499 |
+
**templateId** | **int**| Filter on a specific template id | [optional]
|
500 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
501 |
+
|
502 |
+
### Return type
|
503 |
+
|
504 |
+
[**\SendinBlue\Client\Model\GetEmailEventReport**](../Model/GetEmailEventReport.md)
|
505 |
+
|
506 |
+
### Authorization
|
507 |
+
|
508 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
509 |
+
|
510 |
+
### HTTP request headers
|
511 |
+
|
512 |
+
- **Content-Type**: application/json
|
513 |
+
- **Accept**: application/json
|
514 |
+
|
515 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
516 |
+
|
517 |
+
# **getScheduledEmailByBatchId**
|
518 |
+
> \SendinBlue\Client\Model\GetScheduledEmailByBatchId getScheduledEmailByBatchId($batchId, $startDate, $endDate, $sort, $status, $limit, $offset)
|
519 |
+
|
520 |
+
Fetch scheduled emails by batchId
|
521 |
+
|
522 |
+
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
|
523 |
+
|
524 |
+
### Example
|
525 |
+
```php
|
526 |
+
<?php
|
527 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
528 |
+
|
529 |
+
// Configure API key authorization: api-key
|
530 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
531 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
532 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
533 |
+
// Configure API key authorization: partner-key
|
534 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
535 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
536 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
537 |
+
|
538 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
539 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
540 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
541 |
+
new GuzzleHttp\Client(),
|
542 |
+
$config
|
543 |
+
);
|
544 |
+
$batchId = "batchId_example"; // string | The batchId of scheduled emails batch (Should be a valid UUIDv4)
|
545 |
+
$startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
546 |
+
$endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
547 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
548 |
+
$status = "status_example"; // string | Filter the records by `status` of the scheduled email batch or message.
|
549 |
+
$limit = 100; // int | Number of documents returned per page
|
550 |
+
$offset = 0; // int | Index of the first document on the page
|
551 |
+
|
552 |
+
try {
|
553 |
+
$result = $apiInstance->getScheduledEmailByBatchId($batchId, $startDate, $endDate, $sort, $status, $limit, $offset);
|
554 |
+
print_r($result);
|
555 |
+
} catch (Exception $e) {
|
556 |
+
echo 'Exception when calling TransactionalEmailsApi->getScheduledEmailByBatchId: ', $e->getMessage(), PHP_EOL;
|
557 |
+
}
|
558 |
+
?>
|
559 |
+
```
|
560 |
+
|
561 |
+
### Parameters
|
562 |
+
|
563 |
+
Name | Type | Description | Notes
|
564 |
+
------------- | ------------- | ------------- | -------------
|
565 |
+
**batchId** | **string**| The batchId of scheduled emails batch (Should be a valid UUIDv4) |
|
566 |
+
**startDate** | **\DateTime**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
|
567 |
+
**endDate** | **\DateTime**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
568 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
569 |
+
**status** | **string**| Filter the records by `status` of the scheduled email batch or message. | [optional]
|
570 |
+
**limit** | **int**| Number of documents returned per page | [optional] [default to 100]
|
571 |
+
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
|
572 |
+
|
573 |
+
### Return type
|
574 |
+
|
575 |
+
[**\SendinBlue\Client\Model\GetScheduledEmailByBatchId**](../Model/GetScheduledEmailByBatchId.md)
|
576 |
+
|
577 |
+
### Authorization
|
578 |
+
|
579 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
580 |
+
|
581 |
+
### HTTP request headers
|
582 |
+
|
583 |
+
- **Content-Type**: application/json
|
584 |
+
- **Accept**: application/json
|
585 |
+
|
586 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
587 |
+
|
588 |
+
# **getScheduledEmailById**
|
589 |
+
> getScheduledEmailById($identifier)
|
590 |
+
|
591 |
+
Delete scheduled emails by batchId or messageId
|
592 |
+
|
593 |
+
Delete scheduled batch of emails by batchId or single scheduled email by messageId
|
594 |
+
|
595 |
+
### Example
|
596 |
+
```php
|
597 |
+
<?php
|
598 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
599 |
+
|
600 |
+
// Configure API key authorization: api-key
|
601 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
602 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
603 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
604 |
+
// Configure API key authorization: partner-key
|
605 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
606 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
607 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
608 |
+
|
609 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
610 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
611 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
612 |
+
new GuzzleHttp\Client(),
|
613 |
+
$config
|
614 |
+
);
|
615 |
+
$identifier = "identifier_example"; // string | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
|
616 |
+
|
617 |
+
try {
|
618 |
+
$apiInstance->getScheduledEmailById($identifier);
|
619 |
+
} catch (Exception $e) {
|
620 |
+
echo 'Exception when calling TransactionalEmailsApi->getScheduledEmailById: ', $e->getMessage(), PHP_EOL;
|
621 |
+
}
|
622 |
+
?>
|
623 |
+
```
|
624 |
+
|
625 |
+
### Parameters
|
626 |
+
|
627 |
+
Name | Type | Description | Notes
|
628 |
+
------------- | ------------- | ------------- | -------------
|
629 |
+
**identifier** | **string**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. |
|
630 |
+
|
631 |
+
### Return type
|
632 |
+
|
633 |
+
void (empty response body)
|
634 |
+
|
635 |
+
### Authorization
|
636 |
+
|
637 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
638 |
+
|
639 |
+
### HTTP request headers
|
640 |
+
|
641 |
+
- **Content-Type**: application/json
|
642 |
+
- **Accept**: application/json
|
643 |
+
|
644 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
645 |
+
|
646 |
+
# **getScheduledEmailByMessageId**
|
647 |
+
> \SendinBlue\Client\Model\GetScheduledEmailByMessageId getScheduledEmailByMessageId($messageId, $startDate, $endDate)
|
648 |
+
|
649 |
+
Fetch scheduled email by messageId
|
650 |
+
|
651 |
+
Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
|
652 |
+
|
653 |
+
### Example
|
654 |
+
```php
|
655 |
+
<?php
|
656 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
657 |
+
|
658 |
+
// Configure API key authorization: api-key
|
659 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
660 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
661 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
662 |
+
// Configure API key authorization: partner-key
|
663 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
664 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
665 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
666 |
+
|
667 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
668 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
669 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
670 |
+
new GuzzleHttp\Client(),
|
671 |
+
$config
|
672 |
+
);
|
673 |
+
$messageId = "messageId_example"; // string | The messageId of scheduled email
|
674 |
+
$startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
675 |
+
$endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
676 |
+
|
677 |
+
try {
|
678 |
+
$result = $apiInstance->getScheduledEmailByMessageId($messageId, $startDate, $endDate);
|
679 |
+
print_r($result);
|
680 |
+
} catch (Exception $e) {
|
681 |
+
echo 'Exception when calling TransactionalEmailsApi->getScheduledEmailByMessageId: ', $e->getMessage(), PHP_EOL;
|
682 |
+
}
|
683 |
+
?>
|
684 |
+
```
|
685 |
+
|
686 |
+
### Parameters
|
687 |
+
|
688 |
+
Name | Type | Description | Notes
|
689 |
+
------------- | ------------- | ------------- | -------------
|
690 |
+
**messageId** | **string**| The messageId of scheduled email |
|
691 |
+
**startDate** | **\DateTime**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
|
692 |
+
**endDate** | **\DateTime**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
693 |
+
|
694 |
+
### Return type
|
695 |
+
|
696 |
+
[**\SendinBlue\Client\Model\GetScheduledEmailByMessageId**](../Model/GetScheduledEmailByMessageId.md)
|
697 |
+
|
698 |
+
### Authorization
|
699 |
+
|
700 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
701 |
+
|
702 |
+
### HTTP request headers
|
703 |
+
|
704 |
+
- **Content-Type**: application/json
|
705 |
+
- **Accept**: application/json
|
706 |
+
|
707 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
708 |
+
|
709 |
+
# **getSmtpReport**
|
710 |
+
> \SendinBlue\Client\Model\GetReports getSmtpReport($limit, $offset, $startDate, $endDate, $days, $tag, $sort)
|
711 |
+
|
712 |
+
Get your transactional email activity aggregated per day
|
713 |
+
|
714 |
+
### Example
|
715 |
+
```php
|
716 |
+
<?php
|
717 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
718 |
+
|
719 |
+
// Configure API key authorization: api-key
|
720 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
721 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
722 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
723 |
+
// Configure API key authorization: partner-key
|
724 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
725 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
726 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
727 |
+
|
728 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
729 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
730 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
731 |
+
new GuzzleHttp\Client(),
|
732 |
+
$config
|
733 |
+
);
|
734 |
+
$limit = 10; // int | Number of documents returned per page
|
735 |
+
$offset = 0; // int | Index of the first document on the page
|
736 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
737 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
738 |
+
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
739 |
+
$tag = "tag_example"; // string | Tag of the emails
|
740 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
741 |
+
|
742 |
+
try {
|
743 |
+
$result = $apiInstance->getSmtpReport($limit, $offset, $startDate, $endDate, $days, $tag, $sort);
|
744 |
+
print_r($result);
|
745 |
+
} catch (Exception $e) {
|
746 |
+
echo 'Exception when calling TransactionalEmailsApi->getSmtpReport: ', $e->getMessage(), PHP_EOL;
|
747 |
+
}
|
748 |
+
?>
|
749 |
+
```
|
750 |
+
|
751 |
+
### Parameters
|
752 |
+
|
753 |
+
Name | Type | Description | Notes
|
754 |
+
------------- | ------------- | ------------- | -------------
|
755 |
+
**limit** | **int**| Number of documents returned per page | [optional] [default to 10]
|
756 |
+
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
|
757 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
|
758 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
|
759 |
+
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
760 |
+
**tag** | **string**| Tag of the emails | [optional]
|
761 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
762 |
+
|
763 |
+
### Return type
|
764 |
+
|
765 |
+
[**\SendinBlue\Client\Model\GetReports**](../Model/GetReports.md)
|
766 |
+
|
767 |
+
### Authorization
|
768 |
+
|
769 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
770 |
+
|
771 |
+
### HTTP request headers
|
772 |
+
|
773 |
+
- **Content-Type**: application/json
|
774 |
+
- **Accept**: application/json
|
775 |
+
|
776 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
777 |
+
|
778 |
+
# **getSmtpTemplate**
|
779 |
+
> \SendinBlue\Client\Model\GetSmtpTemplateOverview getSmtpTemplate($templateId)
|
780 |
+
|
781 |
+
Returns the template information
|
782 |
+
|
783 |
+
### Example
|
784 |
+
```php
|
785 |
+
<?php
|
786 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
787 |
+
|
788 |
+
// Configure API key authorization: api-key
|
789 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
790 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
791 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
792 |
+
// Configure API key authorization: partner-key
|
793 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
794 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
795 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
796 |
+
|
797 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
798 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
799 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
800 |
+
new GuzzleHttp\Client(),
|
801 |
+
$config
|
802 |
+
);
|
803 |
+
$templateId = 789; // int | id of the template
|
804 |
+
|
805 |
+
try {
|
806 |
+
$result = $apiInstance->getSmtpTemplate($templateId);
|
807 |
+
print_r($result);
|
808 |
+
} catch (Exception $e) {
|
809 |
+
echo 'Exception when calling TransactionalEmailsApi->getSmtpTemplate: ', $e->getMessage(), PHP_EOL;
|
810 |
+
}
|
811 |
+
?>
|
812 |
+
```
|
813 |
+
|
814 |
+
### Parameters
|
815 |
+
|
816 |
+
Name | Type | Description | Notes
|
817 |
+
------------- | ------------- | ------------- | -------------
|
818 |
+
**templateId** | **int**| id of the template |
|
819 |
+
|
820 |
+
### Return type
|
821 |
+
|
822 |
+
[**\SendinBlue\Client\Model\GetSmtpTemplateOverview**](../Model/GetSmtpTemplateOverview.md)
|
823 |
+
|
824 |
+
### Authorization
|
825 |
+
|
826 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
827 |
+
|
828 |
+
### HTTP request headers
|
829 |
+
|
830 |
+
- **Content-Type**: application/json
|
831 |
+
- **Accept**: application/json
|
832 |
+
|
833 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
834 |
+
|
835 |
+
# **getSmtpTemplates**
|
836 |
+
> \SendinBlue\Client\Model\GetSmtpTemplates getSmtpTemplates($templateStatus, $limit, $offset, $sort)
|
837 |
+
|
838 |
+
Get the list of email templates
|
839 |
+
|
840 |
+
### Example
|
841 |
+
```php
|
842 |
+
<?php
|
843 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
844 |
+
|
845 |
+
// Configure API key authorization: api-key
|
846 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
847 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
848 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
849 |
+
// Configure API key authorization: partner-key
|
850 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
851 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
852 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
853 |
+
|
854 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
855 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
856 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
857 |
+
new GuzzleHttp\Client(),
|
858 |
+
$config
|
859 |
+
);
|
860 |
+
$templateStatus = true; // bool | Filter on the status of the template. Active = true, inactive = false
|
861 |
+
$limit = 50; // int | Number of documents returned per page
|
862 |
+
$offset = 0; // int | Index of the first document in the page
|
863 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
864 |
+
|
865 |
+
try {
|
866 |
+
$result = $apiInstance->getSmtpTemplates($templateStatus, $limit, $offset, $sort);
|
867 |
+
print_r($result);
|
868 |
+
} catch (Exception $e) {
|
869 |
+
echo 'Exception when calling TransactionalEmailsApi->getSmtpTemplates: ', $e->getMessage(), PHP_EOL;
|
870 |
+
}
|
871 |
+
?>
|
872 |
+
```
|
873 |
+
|
874 |
+
### Parameters
|
875 |
+
|
876 |
+
Name | Type | Description | Notes
|
877 |
+
------------- | ------------- | ------------- | -------------
|
878 |
+
**templateStatus** | **bool**| Filter on the status of the template. Active = true, inactive = false | [optional]
|
879 |
+
**limit** | **int**| Number of documents returned per page | [optional] [default to 50]
|
880 |
+
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
881 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
882 |
+
|
883 |
+
### Return type
|
884 |
+
|
885 |
+
[**\SendinBlue\Client\Model\GetSmtpTemplates**](../Model/GetSmtpTemplates.md)
|
886 |
+
|
887 |
+
### Authorization
|
888 |
+
|
889 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
890 |
+
|
891 |
+
### HTTP request headers
|
892 |
+
|
893 |
+
- **Content-Type**: application/json
|
894 |
+
- **Accept**: application/json
|
895 |
+
|
896 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
897 |
+
|
898 |
+
# **getTransacBlockedContacts**
|
899 |
+
> \SendinBlue\Client\Model\GetTransacBlockedContacts getTransacBlockedContacts($startDate, $endDate, $limit, $offset, $senders, $sort)
|
900 |
+
|
901 |
+
Get the list of blocked or unsubscribed transactional contacts
|
902 |
+
|
903 |
+
### Example
|
904 |
+
```php
|
905 |
+
<?php
|
906 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
907 |
+
|
908 |
+
// Configure API key authorization: api-key
|
909 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
910 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
911 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
912 |
+
// Configure API key authorization: partner-key
|
913 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
914 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
915 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
916 |
+
|
917 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
918 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
919 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
920 |
+
new GuzzleHttp\Client(),
|
921 |
+
$config
|
922 |
+
);
|
923 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
924 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
925 |
+
$limit = 50; // int | Number of documents returned per page
|
926 |
+
$offset = 0; // int | Index of the first document on the page
|
927 |
+
$senders = array("senders_example"); // string[] | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
928 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
929 |
+
|
930 |
+
try {
|
931 |
+
$result = $apiInstance->getTransacBlockedContacts($startDate, $endDate, $limit, $offset, $senders, $sort);
|
932 |
+
print_r($result);
|
933 |
+
} catch (Exception $e) {
|
934 |
+
echo 'Exception when calling TransactionalEmailsApi->getTransacBlockedContacts: ', $e->getMessage(), PHP_EOL;
|
935 |
+
}
|
936 |
+
?>
|
937 |
+
```
|
938 |
+
|
939 |
+
### Parameters
|
940 |
+
|
941 |
+
Name | Type | Description | Notes
|
942 |
+
------------- | ------------- | ------------- | -------------
|
943 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional]
|
944 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional]
|
945 |
+
**limit** | **int**| Number of documents returned per page | [optional] [default to 50]
|
946 |
+
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
|
947 |
+
**senders** | [**string[]**](../Model/string.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
|
948 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
949 |
+
|
950 |
+
### Return type
|
951 |
+
|
952 |
+
[**\SendinBlue\Client\Model\GetTransacBlockedContacts**](../Model/GetTransacBlockedContacts.md)
|
953 |
+
|
954 |
+
### Authorization
|
955 |
+
|
956 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
957 |
+
|
958 |
+
### HTTP request headers
|
959 |
+
|
960 |
+
- **Content-Type**: application/json
|
961 |
+
- **Accept**: application/json
|
962 |
+
|
963 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
964 |
+
|
965 |
+
# **getTransacEmailContent**
|
966 |
+
> \SendinBlue\Client\Model\GetTransacEmailContent getTransacEmailContent($uuid)
|
967 |
+
|
968 |
+
Get the personalized content of a sent transactional email
|
969 |
+
|
970 |
+
### Example
|
971 |
+
```php
|
972 |
+
<?php
|
973 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
974 |
+
|
975 |
+
// Configure API key authorization: api-key
|
976 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
977 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
978 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
979 |
+
// Configure API key authorization: partner-key
|
980 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
981 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
982 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
983 |
+
|
984 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
985 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
986 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
987 |
+
new GuzzleHttp\Client(),
|
988 |
+
$config
|
989 |
+
);
|
990 |
+
$uuid = "uuid_example"; // string | Unique id of the transactional email that has been sent to a particular contact
|
991 |
+
|
992 |
+
try {
|
993 |
+
$result = $apiInstance->getTransacEmailContent($uuid);
|
994 |
+
print_r($result);
|
995 |
+
} catch (Exception $e) {
|
996 |
+
echo 'Exception when calling TransactionalEmailsApi->getTransacEmailContent: ', $e->getMessage(), PHP_EOL;
|
997 |
+
}
|
998 |
+
?>
|
999 |
+
```
|
1000 |
+
|
1001 |
+
### Parameters
|
1002 |
+
|
1003 |
+
Name | Type | Description | Notes
|
1004 |
+
------------- | ------------- | ------------- | -------------
|
1005 |
+
**uuid** | **string**| Unique id of the transactional email that has been sent to a particular contact |
|
1006 |
+
|
1007 |
+
### Return type
|
1008 |
+
|
1009 |
+
[**\SendinBlue\Client\Model\GetTransacEmailContent**](../Model/GetTransacEmailContent.md)
|
1010 |
+
|
1011 |
+
### Authorization
|
1012 |
+
|
1013 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1014 |
+
|
1015 |
+
### HTTP request headers
|
1016 |
+
|
1017 |
+
- **Content-Type**: application/json
|
1018 |
+
- **Accept**: application/json
|
1019 |
+
|
1020 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1021 |
+
|
1022 |
+
# **getTransacEmailsList**
|
1023 |
+
> \SendinBlue\Client\Model\GetTransacEmailsList getTransacEmailsList($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset)
|
1024 |
+
|
1025 |
+
Get the list of transactional emails on the basis of allowed filters
|
1026 |
+
|
1027 |
+
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
1028 |
+
|
1029 |
+
### Example
|
1030 |
+
```php
|
1031 |
+
<?php
|
1032 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1033 |
+
|
1034 |
+
// Configure API key authorization: api-key
|
1035 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1036 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1037 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1038 |
+
// Configure API key authorization: partner-key
|
1039 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1040 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1041 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1042 |
+
|
1043 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
1044 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1045 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1046 |
+
new GuzzleHttp\Client(),
|
1047 |
+
$config
|
1048 |
+
);
|
1049 |
+
$email = "email_example"; // string | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
1050 |
+
$templateId = 789; // int | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
1051 |
+
$messageId = "messageId_example"; // string | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
1052 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
1053 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
1054 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1055 |
+
$limit = 500; // int | Number of documents returned per page
|
1056 |
+
$offset = 0; // int | Index of the first document in the page
|
1057 |
+
|
1058 |
+
try {
|
1059 |
+
$result = $apiInstance->getTransacEmailsList($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset);
|
1060 |
+
print_r($result);
|
1061 |
+
} catch (Exception $e) {
|
1062 |
+
echo 'Exception when calling TransactionalEmailsApi->getTransacEmailsList: ', $e->getMessage(), PHP_EOL;
|
1063 |
+
}
|
1064 |
+
?>
|
1065 |
+
```
|
1066 |
+
|
1067 |
+
### Parameters
|
1068 |
+
|
1069 |
+
Name | Type | Description | Notes
|
1070 |
+
------------- | ------------- | ------------- | -------------
|
1071 |
+
**email** | **string**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
|
1072 |
+
**templateId** | **int**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional]
|
1073 |
+
**messageId** | **string**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
|
1074 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
1075 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
1076 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1077 |
+
**limit** | **int**| Number of documents returned per page | [optional] [default to 500]
|
1078 |
+
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
1079 |
+
|
1080 |
+
### Return type
|
1081 |
+
|
1082 |
+
[**\SendinBlue\Client\Model\GetTransacEmailsList**](../Model/GetTransacEmailsList.md)
|
1083 |
+
|
1084 |
+
### Authorization
|
1085 |
+
|
1086 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1087 |
+
|
1088 |
+
### HTTP request headers
|
1089 |
+
|
1090 |
+
- **Content-Type**: application/json
|
1091 |
+
- **Accept**: application/json
|
1092 |
+
|
1093 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1094 |
+
|
1095 |
+
# **sendTestTemplate**
|
1096 |
+
> sendTestTemplate($templateId, $sendTestEmail)
|
1097 |
+
|
1098 |
+
Send a template to your test list
|
1099 |
+
|
1100 |
+
### Example
|
1101 |
+
```php
|
1102 |
+
<?php
|
1103 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1104 |
+
|
1105 |
+
// Configure API key authorization: api-key
|
1106 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1107 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1108 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1109 |
+
// Configure API key authorization: partner-key
|
1110 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1111 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1112 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1113 |
+
|
1114 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
1115 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1116 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1117 |
+
new GuzzleHttp\Client(),
|
1118 |
+
$config
|
1119 |
+
);
|
1120 |
+
$templateId = 789; // int | Id of the template
|
1121 |
+
$sendTestEmail = new \SendinBlue\Client\Model\SendTestEmail(); // \SendinBlue\Client\Model\SendTestEmail |
|
1122 |
+
|
1123 |
+
try {
|
1124 |
+
$apiInstance->sendTestTemplate($templateId, $sendTestEmail);
|
1125 |
+
} catch (Exception $e) {
|
1126 |
+
echo 'Exception when calling TransactionalEmailsApi->sendTestTemplate: ', $e->getMessage(), PHP_EOL;
|
1127 |
+
}
|
1128 |
+
?>
|
1129 |
+
```
|
1130 |
+
|
1131 |
+
### Parameters
|
1132 |
+
|
1133 |
+
Name | Type | Description | Notes
|
1134 |
+
------------- | ------------- | ------------- | -------------
|
1135 |
+
**templateId** | **int**| Id of the template |
|
1136 |
+
**sendTestEmail** | [**\SendinBlue\Client\Model\SendTestEmail**](../Model/SendTestEmail.md)| |
|
1137 |
+
|
1138 |
+
### Return type
|
1139 |
+
|
1140 |
+
void (empty response body)
|
1141 |
+
|
1142 |
+
### Authorization
|
1143 |
+
|
1144 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1145 |
+
|
1146 |
+
### HTTP request headers
|
1147 |
+
|
1148 |
+
- **Content-Type**: application/json
|
1149 |
+
- **Accept**: application/json
|
1150 |
+
|
1151 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1152 |
+
|
1153 |
+
# **sendTransacEmail**
|
1154 |
+
> \SendinBlue\Client\Model\CreateSmtpEmail sendTransacEmail($sendSmtpEmail)
|
1155 |
+
|
1156 |
+
Send a transactional email
|
1157 |
+
|
1158 |
+
### Example
|
1159 |
+
```php
|
1160 |
+
<?php
|
1161 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1162 |
+
|
1163 |
+
// Configure API key authorization: api-key
|
1164 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1165 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1166 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1167 |
+
// Configure API key authorization: partner-key
|
1168 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1169 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1170 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1171 |
+
|
1172 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
1173 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1174 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1175 |
+
new GuzzleHttp\Client(),
|
1176 |
+
$config
|
1177 |
+
);
|
1178 |
+
$sendSmtpEmail = new \SendinBlue\Client\Model\SendSmtpEmail(); // \SendinBlue\Client\Model\SendSmtpEmail | Values to send a transactional email
|
1179 |
+
|
1180 |
+
try {
|
1181 |
+
$result = $apiInstance->sendTransacEmail($sendSmtpEmail);
|
1182 |
+
print_r($result);
|
1183 |
+
} catch (Exception $e) {
|
1184 |
+
echo 'Exception when calling TransactionalEmailsApi->sendTransacEmail: ', $e->getMessage(), PHP_EOL;
|
1185 |
+
}
|
1186 |
+
?>
|
1187 |
+
```
|
1188 |
+
|
1189 |
+
### Parameters
|
1190 |
+
|
1191 |
+
Name | Type | Description | Notes
|
1192 |
+
------------- | ------------- | ------------- | -------------
|
1193 |
+
**sendSmtpEmail** | [**\SendinBlue\Client\Model\SendSmtpEmail**](../Model/SendSmtpEmail.md)| Values to send a transactional email |
|
1194 |
+
|
1195 |
+
### Return type
|
1196 |
+
|
1197 |
+
[**\SendinBlue\Client\Model\CreateSmtpEmail**](../Model/CreateSmtpEmail.md)
|
1198 |
+
|
1199 |
+
### Authorization
|
1200 |
+
|
1201 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1202 |
+
|
1203 |
+
### HTTP request headers
|
1204 |
+
|
1205 |
+
- **Content-Type**: application/json
|
1206 |
+
- **Accept**: application/json
|
1207 |
+
|
1208 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1209 |
+
|
1210 |
+
# **smtpBlockedContactsEmailDelete**
|
1211 |
+
> smtpBlockedContactsEmailDelete($email)
|
1212 |
+
|
1213 |
+
Unblock or resubscribe a transactional contact
|
1214 |
+
|
1215 |
+
### Example
|
1216 |
+
```php
|
1217 |
+
<?php
|
1218 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1219 |
+
|
1220 |
+
// Configure API key authorization: api-key
|
1221 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1222 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1223 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1224 |
+
// Configure API key authorization: partner-key
|
1225 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1226 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1227 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1228 |
+
|
1229 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
1230 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1231 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1232 |
+
new GuzzleHttp\Client(),
|
1233 |
+
$config
|
1234 |
+
);
|
1235 |
+
$email = "email_example"; // string | contact email (urlencoded) to unblock.
|
1236 |
+
|
1237 |
+
try {
|
1238 |
+
$apiInstance->smtpBlockedContactsEmailDelete($email);
|
1239 |
+
} catch (Exception $e) {
|
1240 |
+
echo 'Exception when calling TransactionalEmailsApi->smtpBlockedContactsEmailDelete: ', $e->getMessage(), PHP_EOL;
|
1241 |
+
}
|
1242 |
+
?>
|
1243 |
+
```
|
1244 |
+
|
1245 |
+
### Parameters
|
1246 |
+
|
1247 |
+
Name | Type | Description | Notes
|
1248 |
+
------------- | ------------- | ------------- | -------------
|
1249 |
+
**email** | **string**| contact email (urlencoded) to unblock. |
|
1250 |
+
|
1251 |
+
### Return type
|
1252 |
+
|
1253 |
+
void (empty response body)
|
1254 |
+
|
1255 |
+
### Authorization
|
1256 |
+
|
1257 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1258 |
+
|
1259 |
+
### HTTP request headers
|
1260 |
+
|
1261 |
+
- **Content-Type**: application/json
|
1262 |
+
- **Accept**: application/json
|
1263 |
+
|
1264 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1265 |
+
|
1266 |
+
# **smtpLogMessageIdDelete**
|
1267 |
+
> smtpLogMessageIdDelete($messageId)
|
1268 |
+
|
1269 |
+
Delete an SMTP transactional log
|
1270 |
+
|
1271 |
+
### Example
|
1272 |
+
```php
|
1273 |
+
<?php
|
1274 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1275 |
+
|
1276 |
+
// Configure API key authorization: api-key
|
1277 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1278 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1279 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1280 |
+
// Configure API key authorization: partner-key
|
1281 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1282 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1283 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1284 |
+
|
1285 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
1286 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1287 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1288 |
+
new GuzzleHttp\Client(),
|
1289 |
+
$config
|
1290 |
+
);
|
1291 |
+
$messageId = "messageId_example"; // string | MessageId of the transactional log to delete
|
1292 |
+
|
1293 |
+
try {
|
1294 |
+
$apiInstance->smtpLogMessageIdDelete($messageId);
|
1295 |
+
} catch (Exception $e) {
|
1296 |
+
echo 'Exception when calling TransactionalEmailsApi->smtpLogMessageIdDelete: ', $e->getMessage(), PHP_EOL;
|
1297 |
+
}
|
1298 |
+
?>
|
1299 |
+
```
|
1300 |
+
|
1301 |
+
### Parameters
|
1302 |
+
|
1303 |
+
Name | Type | Description | Notes
|
1304 |
+
------------- | ------------- | ------------- | -------------
|
1305 |
+
**messageId** | **string**| MessageId of the transactional log to delete |
|
1306 |
+
|
1307 |
+
### Return type
|
1308 |
+
|
1309 |
+
void (empty response body)
|
1310 |
+
|
1311 |
+
### Authorization
|
1312 |
+
|
1313 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1314 |
+
|
1315 |
+
### HTTP request headers
|
1316 |
+
|
1317 |
+
- **Content-Type**: application/json
|
1318 |
+
- **Accept**: application/json
|
1319 |
+
|
1320 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1321 |
+
|
1322 |
+
# **updateSmtpTemplate**
|
1323 |
+
> updateSmtpTemplate($templateId, $smtpTemplate)
|
1324 |
+
|
1325 |
+
Update an email template
|
1326 |
+
|
1327 |
+
### Example
|
1328 |
+
```php
|
1329 |
+
<?php
|
1330 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
1331 |
+
|
1332 |
+
// Configure API key authorization: api-key
|
1333 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
1334 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1335 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
1336 |
+
// Configure API key authorization: partner-key
|
1337 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
1338 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
1339 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
1340 |
+
|
1341 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalEmailsApi(
|
1342 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
1343 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
1344 |
+
new GuzzleHttp\Client(),
|
1345 |
+
$config
|
1346 |
+
);
|
1347 |
+
$templateId = 789; // int | id of the template
|
1348 |
+
$smtpTemplate = new \SendinBlue\Client\Model\UpdateSmtpTemplate(); // \SendinBlue\Client\Model\UpdateSmtpTemplate | values to update in transactional email template
|
1349 |
+
|
1350 |
+
try {
|
1351 |
+
$apiInstance->updateSmtpTemplate($templateId, $smtpTemplate);
|
1352 |
+
} catch (Exception $e) {
|
1353 |
+
echo 'Exception when calling TransactionalEmailsApi->updateSmtpTemplate: ', $e->getMessage(), PHP_EOL;
|
1354 |
+
}
|
1355 |
+
?>
|
1356 |
+
```
|
1357 |
+
|
1358 |
+
### Parameters
|
1359 |
+
|
1360 |
+
Name | Type | Description | Notes
|
1361 |
+
------------- | ------------- | ------------- | -------------
|
1362 |
+
**templateId** | **int**| id of the template |
|
1363 |
+
**smtpTemplate** | [**\SendinBlue\Client\Model\UpdateSmtpTemplate**](../Model/UpdateSmtpTemplate.md)| values to update in transactional email template |
|
1364 |
+
|
1365 |
+
### Return type
|
1366 |
+
|
1367 |
+
void (empty response body)
|
1368 |
+
|
1369 |
+
### Authorization
|
1370 |
+
|
1371 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
1372 |
+
|
1373 |
+
### HTTP request headers
|
1374 |
+
|
1375 |
+
- **Content-Type**: application/json
|
1376 |
+
- **Accept**: application/json
|
1377 |
+
|
1378 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
1379 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/TransactionalSMSApi.md
ADDED
@@ -0,0 +1,270 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\TransactionalSMSApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**getSmsEvents**](TransactionalSMSApi.md#getSmsEvents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
8 |
+
[**getTransacAggregatedSmsReport**](TransactionalSMSApi.md#getTransacAggregatedSmsReport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
9 |
+
[**getTransacSmsReport**](TransactionalSMSApi.md#getTransacSmsReport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
10 |
+
[**sendTransacSms**](TransactionalSMSApi.md#sendTransacSms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
11 |
+
|
12 |
+
|
13 |
+
# **getSmsEvents**
|
14 |
+
> \SendinBlue\Client\Model\GetSmsEventReport getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort)
|
15 |
+
|
16 |
+
Get all your SMS activity (unaggregated events)
|
17 |
+
|
18 |
+
### Example
|
19 |
+
```php
|
20 |
+
<?php
|
21 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
22 |
+
|
23 |
+
// Configure API key authorization: api-key
|
24 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
25 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
26 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
27 |
+
// Configure API key authorization: partner-key
|
28 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
29 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
30 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
31 |
+
|
32 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
|
33 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
34 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
35 |
+
new GuzzleHttp\Client(),
|
36 |
+
$config
|
37 |
+
);
|
38 |
+
$limit = 50; // int | Number of documents per page
|
39 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
40 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
41 |
+
$offset = 0; // int | Index of the first document of the page
|
42 |
+
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
43 |
+
$phoneNumber = "phoneNumber_example"; // string | Filter the report for a specific phone number
|
44 |
+
$event = "event_example"; // string | Filter the report for specific events
|
45 |
+
$tags = "tags_example"; // string | Filter the report for specific tags passed as a serialized urlencoded array
|
46 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
47 |
+
|
48 |
+
try {
|
49 |
+
$result = $apiInstance->getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort);
|
50 |
+
print_r($result);
|
51 |
+
} catch (Exception $e) {
|
52 |
+
echo 'Exception when calling TransactionalSMSApi->getSmsEvents: ', $e->getMessage(), PHP_EOL;
|
53 |
+
}
|
54 |
+
?>
|
55 |
+
```
|
56 |
+
|
57 |
+
### Parameters
|
58 |
+
|
59 |
+
Name | Type | Description | Notes
|
60 |
+
------------- | ------------- | ------------- | -------------
|
61 |
+
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
62 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
63 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
64 |
+
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
65 |
+
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
66 |
+
**phoneNumber** | **string**| Filter the report for a specific phone number | [optional]
|
67 |
+
**event** | **string**| Filter the report for specific events | [optional]
|
68 |
+
**tags** | **string**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
|
69 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
70 |
+
|
71 |
+
### Return type
|
72 |
+
|
73 |
+
[**\SendinBlue\Client\Model\GetSmsEventReport**](../Model/GetSmsEventReport.md)
|
74 |
+
|
75 |
+
### Authorization
|
76 |
+
|
77 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
78 |
+
|
79 |
+
### HTTP request headers
|
80 |
+
|
81 |
+
- **Content-Type**: application/json
|
82 |
+
- **Accept**: application/json
|
83 |
+
|
84 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
85 |
+
|
86 |
+
# **getTransacAggregatedSmsReport**
|
87 |
+
> \SendinBlue\Client\Model\GetTransacAggregatedSmsReport getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag)
|
88 |
+
|
89 |
+
Get your SMS activity aggregated over a period of time
|
90 |
+
|
91 |
+
### Example
|
92 |
+
```php
|
93 |
+
<?php
|
94 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
95 |
+
|
96 |
+
// Configure API key authorization: api-key
|
97 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
98 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
99 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
100 |
+
// Configure API key authorization: partner-key
|
101 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
102 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
103 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
104 |
+
|
105 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
|
106 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
107 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
108 |
+
new GuzzleHttp\Client(),
|
109 |
+
$config
|
110 |
+
);
|
111 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
112 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
113 |
+
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
114 |
+
$tag = "tag_example"; // string | Filter on a tag
|
115 |
+
|
116 |
+
try {
|
117 |
+
$result = $apiInstance->getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag);
|
118 |
+
print_r($result);
|
119 |
+
} catch (Exception $e) {
|
120 |
+
echo 'Exception when calling TransactionalSMSApi->getTransacAggregatedSmsReport: ', $e->getMessage(), PHP_EOL;
|
121 |
+
}
|
122 |
+
?>
|
123 |
+
```
|
124 |
+
|
125 |
+
### Parameters
|
126 |
+
|
127 |
+
Name | Type | Description | Notes
|
128 |
+
------------- | ------------- | ------------- | -------------
|
129 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
130 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
131 |
+
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
|
132 |
+
**tag** | **string**| Filter on a tag | [optional]
|
133 |
+
|
134 |
+
### Return type
|
135 |
+
|
136 |
+
[**\SendinBlue\Client\Model\GetTransacAggregatedSmsReport**](../Model/GetTransacAggregatedSmsReport.md)
|
137 |
+
|
138 |
+
### Authorization
|
139 |
+
|
140 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
141 |
+
|
142 |
+
### HTTP request headers
|
143 |
+
|
144 |
+
- **Content-Type**: application/json
|
145 |
+
- **Accept**: application/json
|
146 |
+
|
147 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
148 |
+
|
149 |
+
# **getTransacSmsReport**
|
150 |
+
> \SendinBlue\Client\Model\GetTransacSmsReport getTransacSmsReport($startDate, $endDate, $days, $tag, $sort)
|
151 |
+
|
152 |
+
Get your SMS activity aggregated per day
|
153 |
+
|
154 |
+
### Example
|
155 |
+
```php
|
156 |
+
<?php
|
157 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
158 |
+
|
159 |
+
// Configure API key authorization: api-key
|
160 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
161 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
162 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
163 |
+
// Configure API key authorization: partner-key
|
164 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
165 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
166 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
167 |
+
|
168 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
|
169 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
170 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
171 |
+
new GuzzleHttp\Client(),
|
172 |
+
$config
|
173 |
+
);
|
174 |
+
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
175 |
+
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
176 |
+
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
177 |
+
$tag = "tag_example"; // string | Filter on a tag
|
178 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
179 |
+
|
180 |
+
try {
|
181 |
+
$result = $apiInstance->getTransacSmsReport($startDate, $endDate, $days, $tag, $sort);
|
182 |
+
print_r($result);
|
183 |
+
} catch (Exception $e) {
|
184 |
+
echo 'Exception when calling TransactionalSMSApi->getTransacSmsReport: ', $e->getMessage(), PHP_EOL;
|
185 |
+
}
|
186 |
+
?>
|
187 |
+
```
|
188 |
+
|
189 |
+
### Parameters
|
190 |
+
|
191 |
+
Name | Type | Description | Notes
|
192 |
+
------------- | ------------- | ------------- | -------------
|
193 |
+
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
194 |
+
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
195 |
+
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
196 |
+
**tag** | **string**| Filter on a tag | [optional]
|
197 |
+
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
198 |
+
|
199 |
+
### Return type
|
200 |
+
|
201 |
+
[**\SendinBlue\Client\Model\GetTransacSmsReport**](../Model/GetTransacSmsReport.md)
|
202 |
+
|
203 |
+
### Authorization
|
204 |
+
|
205 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
206 |
+
|
207 |
+
### HTTP request headers
|
208 |
+
|
209 |
+
- **Content-Type**: application/json
|
210 |
+
- **Accept**: application/json
|
211 |
+
|
212 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
213 |
+
|
214 |
+
# **sendTransacSms**
|
215 |
+
> \SendinBlue\Client\Model\SendSms sendTransacSms($sendTransacSms)
|
216 |
+
|
217 |
+
Send SMS message to a mobile number
|
218 |
+
|
219 |
+
### Example
|
220 |
+
```php
|
221 |
+
<?php
|
222 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
223 |
+
|
224 |
+
// Configure API key authorization: api-key
|
225 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
226 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
227 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
228 |
+
// Configure API key authorization: partner-key
|
229 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
230 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
231 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
232 |
+
|
233 |
+
$apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
|
234 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
235 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
236 |
+
new GuzzleHttp\Client(),
|
237 |
+
$config
|
238 |
+
);
|
239 |
+
$sendTransacSms = new \SendinBlue\Client\Model\SendTransacSms(); // \SendinBlue\Client\Model\SendTransacSms | Values to send a transactional SMS
|
240 |
+
|
241 |
+
try {
|
242 |
+
$result = $apiInstance->sendTransacSms($sendTransacSms);
|
243 |
+
print_r($result);
|
244 |
+
} catch (Exception $e) {
|
245 |
+
echo 'Exception when calling TransactionalSMSApi->sendTransacSms: ', $e->getMessage(), PHP_EOL;
|
246 |
+
}
|
247 |
+
?>
|
248 |
+
```
|
249 |
+
|
250 |
+
### Parameters
|
251 |
+
|
252 |
+
Name | Type | Description | Notes
|
253 |
+
------------- | ------------- | ------------- | -------------
|
254 |
+
**sendTransacSms** | [**\SendinBlue\Client\Model\SendTransacSms**](../Model/SendTransacSms.md)| Values to send a transactional SMS |
|
255 |
+
|
256 |
+
### Return type
|
257 |
+
|
258 |
+
[**\SendinBlue\Client\Model\SendSms**](../Model/SendSms.md)
|
259 |
+
|
260 |
+
### Authorization
|
261 |
+
|
262 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
263 |
+
|
264 |
+
### HTTP request headers
|
265 |
+
|
266 |
+
- **Content-Type**: application/json
|
267 |
+
- **Accept**: application/json
|
268 |
+
|
269 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
270 |
+
|
Postman/Postman-Mail/sendinblue/docs/Api/WebhooksApi.md
ADDED
@@ -0,0 +1,300 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendinBlue\Client\WebhooksApi
|
2 |
+
|
3 |
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4 |
+
|
5 |
+
Method | HTTP request | Description
|
6 |
+
------------- | ------------- | -------------
|
7 |
+
[**createWebhook**](WebhooksApi.md#createWebhook) | **POST** /webhooks | Create a webhook
|
8 |
+
[**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
9 |
+
[**getWebhook**](WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
10 |
+
[**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all webhooks
|
11 |
+
[**updateWebhook**](WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhookId} | Update a webhook
|
12 |
+
|
13 |
+
|
14 |
+
# **createWebhook**
|
15 |
+
> \SendinBlue\Client\Model\CreateModel createWebhook($createWebhook)
|
16 |
+
|
17 |
+
Create a webhook
|
18 |
+
|
19 |
+
### Example
|
20 |
+
```php
|
21 |
+
<?php
|
22 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
23 |
+
|
24 |
+
// Configure API key authorization: api-key
|
25 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
26 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
27 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
28 |
+
// Configure API key authorization: partner-key
|
29 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
30 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
31 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
32 |
+
|
33 |
+
$apiInstance = new SendinBlue\Client\Api\WebhooksApi(
|
34 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
35 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
36 |
+
new GuzzleHttp\Client(),
|
37 |
+
$config
|
38 |
+
);
|
39 |
+
$createWebhook = new \SendinBlue\Client\Model\CreateWebhook(); // \SendinBlue\Client\Model\CreateWebhook | Values to create a webhook
|
40 |
+
|
41 |
+
try {
|
42 |
+
$result = $apiInstance->createWebhook($createWebhook);
|
43 |
+
print_r($result);
|
44 |
+
} catch (Exception $e) {
|
45 |
+
echo 'Exception when calling WebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL;
|
46 |
+
}
|
47 |
+
?>
|
48 |
+
```
|
49 |
+
|
50 |
+
### Parameters
|
51 |
+
|
52 |
+
Name | Type | Description | Notes
|
53 |
+
------------- | ------------- | ------------- | -------------
|
54 |
+
**createWebhook** | [**\SendinBlue\Client\Model\CreateWebhook**](../Model/CreateWebhook.md)| Values to create a webhook |
|
55 |
+
|
56 |
+
### Return type
|
57 |
+
|
58 |
+
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
|
59 |
+
|
60 |
+
### Authorization
|
61 |
+
|
62 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
63 |
+
|
64 |
+
### HTTP request headers
|
65 |
+
|
66 |
+
- **Content-Type**: application/json
|
67 |
+
- **Accept**: application/json
|
68 |
+
|
69 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
70 |
+
|
71 |
+
# **deleteWebhook**
|
72 |
+
> deleteWebhook($webhookId)
|
73 |
+
|
74 |
+
Delete a webhook
|
75 |
+
|
76 |
+
### Example
|
77 |
+
```php
|
78 |
+
<?php
|
79 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
80 |
+
|
81 |
+
// Configure API key authorization: api-key
|
82 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
83 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
84 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
85 |
+
// Configure API key authorization: partner-key
|
86 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
87 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
88 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
89 |
+
|
90 |
+
$apiInstance = new SendinBlue\Client\Api\WebhooksApi(
|
91 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
92 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
93 |
+
new GuzzleHttp\Client(),
|
94 |
+
$config
|
95 |
+
);
|
96 |
+
$webhookId = 789; // int | Id of the webhook
|
97 |
+
|
98 |
+
try {
|
99 |
+
$apiInstance->deleteWebhook($webhookId);
|
100 |
+
} catch (Exception $e) {
|
101 |
+
echo 'Exception when calling WebhooksApi->deleteWebhook: ', $e->getMessage(), PHP_EOL;
|
102 |
+
}
|
103 |
+
?>
|
104 |
+
```
|
105 |
+
|
106 |
+
### Parameters
|
107 |
+
|
108 |
+
Name | Type | Description | Notes
|
109 |
+
------------- | ------------- | ------------- | -------------
|
110 |
+
**webhookId** | **int**| Id of the webhook |
|
111 |
+
|
112 |
+
### Return type
|
113 |
+
|
114 |
+
void (empty response body)
|
115 |
+
|
116 |
+
### Authorization
|
117 |
+
|
118 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
119 |
+
|
120 |
+
### HTTP request headers
|
121 |
+
|
122 |
+
- **Content-Type**: application/json
|
123 |
+
- **Accept**: application/json
|
124 |
+
|
125 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
126 |
+
|
127 |
+
# **getWebhook**
|
128 |
+
> \SendinBlue\Client\Model\GetWebhook getWebhook($webhookId)
|
129 |
+
|
130 |
+
Get a webhook details
|
131 |
+
|
132 |
+
### Example
|
133 |
+
```php
|
134 |
+
<?php
|
135 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
136 |
+
|
137 |
+
// Configure API key authorization: api-key
|
138 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
139 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
140 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
141 |
+
// Configure API key authorization: partner-key
|
142 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
143 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
144 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
145 |
+
|
146 |
+
$apiInstance = new SendinBlue\Client\Api\WebhooksApi(
|
147 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
148 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
149 |
+
new GuzzleHttp\Client(),
|
150 |
+
$config
|
151 |
+
);
|
152 |
+
$webhookId = 789; // int | Id of the webhook
|
153 |
+
|
154 |
+
try {
|
155 |
+
$result = $apiInstance->getWebhook($webhookId);
|
156 |
+
print_r($result);
|
157 |
+
} catch (Exception $e) {
|
158 |
+
echo 'Exception when calling WebhooksApi->getWebhook: ', $e->getMessage(), PHP_EOL;
|
159 |
+
}
|
160 |
+
?>
|
161 |
+
```
|
162 |
+
|
163 |
+
### Parameters
|
164 |
+
|
165 |
+
Name | Type | Description | Notes
|
166 |
+
------------- | ------------- | ------------- | -------------
|
167 |
+
**webhookId** | **int**| Id of the webhook |
|
168 |
+
|
169 |
+
### Return type
|
170 |
+
|
171 |
+
[**\SendinBlue\Client\Model\GetWebhook**](../Model/GetWebhook.md)
|
172 |
+
|
173 |
+
### Authorization
|
174 |
+
|
175 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
176 |
+
|
177 |
+
### HTTP request headers
|
178 |
+
|
179 |
+
- **Content-Type**: application/json
|
180 |
+
- **Accept**: application/json
|
181 |
+
|
182 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
183 |
+
|
184 |
+
# **getWebhooks**
|
185 |
+
> \SendinBlue\Client\Model\GetWebhooks getWebhooks($type, $sort)
|
186 |
+
|
187 |
+
Get all webhooks
|
188 |
+
|
189 |
+
### Example
|
190 |
+
```php
|
191 |
+
<?php
|
192 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
193 |
+
|
194 |
+
// Configure API key authorization: api-key
|
195 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
196 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
197 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
198 |
+
// Configure API key authorization: partner-key
|
199 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
200 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
201 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
202 |
+
|
203 |
+
$apiInstance = new SendinBlue\Client\Api\WebhooksApi(
|
204 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
205 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
206 |
+
new GuzzleHttp\Client(),
|
207 |
+
$config
|
208 |
+
);
|
209 |
+
$type = "transactional"; // string | Filter on webhook type
|
210 |
+
$sort = "desc"; // string | Sort the results in the ascending/descending order of webhook creation
|
211 |
+
|
212 |
+
try {
|
213 |
+
$result = $apiInstance->getWebhooks($type, $sort);
|
214 |
+
print_r($result);
|
215 |
+
} catch (Exception $e) {
|
216 |
+
echo 'Exception when calling WebhooksApi->getWebhooks: ', $e->getMessage(), PHP_EOL;
|
217 |
+
}
|
218 |
+
?>
|
219 |
+
```
|
220 |
+
|
221 |
+
### Parameters
|
222 |
+
|
223 |
+
Name | Type | Description | Notes
|
224 |
+
------------- | ------------- | ------------- | -------------
|
225 |
+
**type** | **string**| Filter on webhook type | [optional] [default to transactional]
|
226 |
+
**sort** | **string**| Sort the results in the ascending/descending order of webhook creation | [optional] [default to desc]
|
227 |
+
|
228 |
+
### Return type
|
229 |
+
|
230 |
+
[**\SendinBlue\Client\Model\GetWebhooks**](../Model/GetWebhooks.md)
|
231 |
+
|
232 |
+
### Authorization
|
233 |
+
|
234 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
235 |
+
|
236 |
+
### HTTP request headers
|
237 |
+
|
238 |
+
- **Content-Type**: application/json
|
239 |
+
- **Accept**: application/json
|
240 |
+
|
241 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
242 |
+
|
243 |
+
# **updateWebhook**
|
244 |
+
> updateWebhook($webhookId, $updateWebhook)
|
245 |
+
|
246 |
+
Update a webhook
|
247 |
+
|
248 |
+
### Example
|
249 |
+
```php
|
250 |
+
<?php
|
251 |
+
require_once(__DIR__ . '/vendor/autoload.php');
|
252 |
+
|
253 |
+
// Configure API key authorization: api-key
|
254 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
255 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
256 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
257 |
+
// Configure API key authorization: partner-key
|
258 |
+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
259 |
+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
260 |
+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
261 |
+
|
262 |
+
$apiInstance = new SendinBlue\Client\Api\WebhooksApi(
|
263 |
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
264 |
+
// This is optional, `GuzzleHttp\Client` will be used as default.
|
265 |
+
new GuzzleHttp\Client(),
|
266 |
+
$config
|
267 |
+
);
|
268 |
+
$webhookId = 789; // int | Id of the webhook
|
269 |
+
$updateWebhook = new \SendinBlue\Client\Model\UpdateWebhook(); // \SendinBlue\Client\Model\UpdateWebhook | Values to update a webhook
|
270 |
+
|
271 |
+
try {
|
272 |
+
$apiInstance->updateWebhook($webhookId, $updateWebhook);
|
273 |
+
} catch (Exception $e) {
|
274 |
+
echo 'Exception when calling WebhooksApi->updateWebhook: ', $e->getMessage(), PHP_EOL;
|
275 |
+
}
|
276 |
+
?>
|
277 |
+
```
|
278 |
+
|
279 |
+
### Parameters
|
280 |
+
|
281 |
+
Name | Type | Description | Notes
|
282 |
+
------------- | ------------- | ------------- | -------------
|
283 |
+
**webhookId** | **int**| Id of the webhook |
|
284 |
+
**updateWebhook** | [**\SendinBlue\Client\Model\UpdateWebhook**](../Model/UpdateWebhook.md)| Values to update a webhook |
|
285 |
+
|
286 |
+
### Return type
|
287 |
+
|
288 |
+
void (empty response body)
|
289 |
+
|
290 |
+
### Authorization
|
291 |
+
|
292 |
+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
293 |
+
|
294 |
+
### HTTP request headers
|
295 |
+
|
296 |
+
- **Content-Type**: application/json
|
297 |
+
- **Accept**: application/json
|
298 |
+
|
299 |
+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
300 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AbTestCampaignResult.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AbTestCampaignResult
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**winningVersion** | **string** | 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]
|
7 |
+
**winningCriteria** | **string** | Criteria choosen for winning version (Open/Click) | [optional]
|
8 |
+
**winningSubjectLine** | **string** | Subject Line of current winning version | [optional]
|
9 |
+
**openRate** | **string** | Open rate for current winning version | [optional]
|
10 |
+
**clickRate** | **string** | Click rate for current winning version | [optional]
|
11 |
+
**winningVersionRate** | **string** | Open/Click rate for the winner version | [optional]
|
12 |
+
**statistics** | [**\SendinBlue\Client\Model\AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
|
13 |
+
**clickedLinks** | [**\SendinBlue\Client\Model\AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AbTestCampaignResultClickedLinks.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AbTestCampaignResultClickedLinks
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**versionA** | [**\SendinBlue\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) | |
|
7 |
+
**versionB** | [**\SendinBlue\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AbTestCampaignResultStatistics.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AbTestCampaignResultStatistics
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**openers** | [**\SendinBlue\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
7 |
+
**clicks** | [**\SendinBlue\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
8 |
+
**unsubscribed** | [**\SendinBlue\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
9 |
+
**hardBounces** | [**\SendinBlue\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
10 |
+
**softBounces** | [**\SendinBlue\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
11 |
+
**complaints** | [**\SendinBlue\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AbTestVersionClicks.md
ADDED
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AbTestVersionClicks
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
|
7 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
8 |
+
|
9 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AbTestVersionClicksInner.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AbTestVersionClicksInner
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**link** | **string** | URL of the link |
|
7 |
+
**clicksCount** | **float** | Number of times a link is clicked |
|
8 |
+
**clickRate** | **string** | Percentage of clicks of link with respect to total clicks |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AbTestVersionStats.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AbTestVersionStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**versionA** | **string** | percentage of an event for version A |
|
7 |
+
**versionB** | **string** | percentage of an event for version B |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AddChildDomain.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AddChildDomain
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**domain** | **string** | Sender domain to add for a specific child account | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AddContactToList.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AddContactToList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**emails** | **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]
|
7 |
+
**ids** | **int[]** | 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]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/AddCredits.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# AddCredits
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional]
|
7 |
+
**email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/BlockDomain.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# BlockDomain
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**domain** | **string** | name of the domain to be blocked |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/Body.md
ADDED
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Body
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of task |
|
7 |
+
**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
8 |
+
**taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. |
|
9 |
+
**date** | [**\DateTime**] | Task due date and time |
|
10 |
+
**notes** | **string** | Notes added to a task | [optional]
|
11 |
+
**done** | **bool** | Task marked as done | [optional]
|
12 |
+
**assignToId** | **string** | User id to whom task is assigned | [optional]
|
13 |
+
**contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional]
|
14 |
+
**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional]
|
15 |
+
**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional]
|
16 |
+
**reminder** | [**\SendinBlue\Client\Model\TaskReminder**](TaskReminder.md) | | [optional]
|
17 |
+
|
18 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
19 |
+
|
20 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/Body1.md
ADDED
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Body1
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of task |
|
7 |
+
**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
8 |
+
**taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. |
|
9 |
+
**date** | [**\DateTime**] | Task date/time |
|
10 |
+
**notes** | **string** | Notes added to a task | [optional]
|
11 |
+
**done** | **bool** | Task marked as done | [optional]
|
12 |
+
**assignToId** | **string** | User id to whom task is assigned | [optional]
|
13 |
+
**contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional]
|
14 |
+
**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional]
|
15 |
+
**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional]
|
16 |
+
**reminder** | [**\SendinBlue\Client\Model\TaskReminder**](TaskReminder.md) | | [optional]
|
17 |
+
|
18 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
19 |
+
|
20 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/Contact.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Contact
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**virtualNextTask** | **object** | Next incomplete task of contact | [optional]
|
7 |
+
**email** | **string** | Contact email |
|
8 |
+
**assignToId** | **string** | User id to whom contact is assigned | [optional]
|
9 |
+
**contactsId** | **int** | Contact id | [optional]
|
10 |
+
**crmLists** | **object** | CRM lists in which contact is added |
|
11 |
+
**attributes** | **object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional]
|
12 |
+
**createdAt** | [**\DateTime**] | Contact created date/time | [optional]
|
13 |
+
**updatedAt** | [**\DateTime**] | Contact updated date/time | [optional]
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateAttribute.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateAttribute
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**value** | **string** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
7 |
+
**enumeration** | [**\SendinBlue\Client\Model\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]
|
8 |
+
**type** | **string** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateAttributeEnumeration.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateAttributeEnumeration
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**value** | **int** | Id of the value |
|
7 |
+
**label** | **string** | Label of the value |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateChild.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateChild
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address to create the child account |
|
7 |
+
**firstName** | **string** | First name to use to create the child account |
|
8 |
+
**lastName** | **string** | Last name to use to create the child account |
|
9 |
+
**companyName** | **string** | Company name to use to create the child account |
|
10 |
+
**password** | **string** | Password for the child account to login |
|
11 |
+
**language** | **string** | Language of the child account | [optional]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateContact.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateContact
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
**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]
|
8 |
+
**emailBlacklisted** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
9 |
+
**smsBlacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10 |
+
**listIds** | **int[]** | Ids of the lists to add the contact to | [optional]
|
11 |
+
**updateEnabled** | **bool** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
|
12 |
+
**smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateDoiContact.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateDoiContact
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. |
|
7 |
+
**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]
|
8 |
+
**includeListIds** | **int[]** | Lists under user account where contact should be added |
|
9 |
+
**excludeListIds** | **int[]** | Lists under user account where contact should not be added | [optional]
|
10 |
+
**templateId** | **int** | Id of the Double opt-in (DOI) template |
|
11 |
+
**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 }}. |
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateEmailCampaign.md
ADDED
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateEmailCampaign
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**tag** | **string** | Tag of the campaign | [optional]
|
7 |
+
**sender** | [**\SendinBlue\Client\Model\CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | |
|
8 |
+
**name** | **string** | Name of the campaign |
|
9 |
+
**htmlContent** | **string** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
|
10 |
+
**htmlUrl** | **string** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
|
11 |
+
**templateId** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
|
12 |
+
**scheduledAt** | **string** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
13 |
+
**subject** | **string** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
|
14 |
+
**replyTo** | **string** | Email on which the campaign recipients will be able to reply to | [optional]
|
15 |
+
**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]
|
16 |
+
**recipients** | [**\SendinBlue\Client\Model\CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
|
17 |
+
**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]
|
18 |
+
**inlineImageActivation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
|
19 |
+
**mirrorActive** | **bool** | Use true to enable the mirror link | [optional]
|
20 |
+
**footer** | **string** | Footer of the email campaign | [optional]
|
21 |
+
**header** | **string** | Header of the email campaign | [optional]
|
22 |
+
**utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
|
23 |
+
**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
|
24 |
+
**sendAtBestTime** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
|
25 |
+
**abTesting** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
|
26 |
+
**subjectA** | **string** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
27 |
+
**subjectB** | **string** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
28 |
+
**splitRule** | **int** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
|
29 |
+
**winnerCriteria** | **string** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
|
30 |
+
**winnerDelay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
|
31 |
+
**ipWarmupEnable** | **bool** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
|
32 |
+
**initialQuota** | **int** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
|
33 |
+
**increaseRate** | **int** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
|
34 |
+
|
35 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
36 |
+
|
37 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateEmailCampaignRecipients.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateEmailCampaignRecipients
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**exclusionListIds** | **int[]** | List ids to exclude from the campaign | [optional]
|
7 |
+
**listIds** | **int[]** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateEmailCampaignSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateEmailCampaignSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Sender Name | [optional]
|
7 |
+
**email** | **string** | Sender email |
|
8 |
+
**id** | **int** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateList.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the list |
|
7 |
+
**folderId** | **int** | Id of the parent folder in which this list is to be created |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateModel.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateModel
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the object created |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateReseller.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateReseller
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**authKey** | **string** | AuthKey of Reseller child created |
|
7 |
+
**id** | **int** | Id of Reseller child created | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | From Name to use for the sender |
|
7 |
+
**email** | **string** | From email to use for the sender. A verification email will be sent to this address. |
|
8 |
+
**ips** | [**\SendinBlue\Client\Model\CreateSenderIps[]**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSenderIps.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSenderIps
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**ip** | **string** | Dedicated IP available in your account |
|
7 |
+
**domain** | **string** | Domain of the IP |
|
8 |
+
**weight** | **int** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSenderModel.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSenderModel
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the Sender created |
|
7 |
+
**spfError** | **bool** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional]
|
8 |
+
**dkimError** | **bool** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSmsCampaign.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSmsCampaign
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the campaign |
|
7 |
+
**sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
|
8 |
+
**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 |
|
9 |
+
**recipients** | [**\SendinBlue\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10 |
+
**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]
|
11 |
+
**unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSmsCampaignRecipients.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSmsCampaignRecipients
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**listIds** | **int[]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
|
7 |
+
**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSmtpEmail.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSmtpEmail
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**messageId** | **string** | Message ID of the transactional email sent | [optional]
|
7 |
+
**messageIds** | **string[]** | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSmtpTemplate.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSmtpTemplate
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**tag** | **string** | Tag of the template | [optional]
|
7 |
+
**sender** | [**\SendinBlue\Client\Model\CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | |
|
8 |
+
**templateName** | **string** | Name of the template |
|
9 |
+
**htmlContent** | **string** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional]
|
10 |
+
**htmlUrl** | **string** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
|
11 |
+
**subject** | **string** | Subject of the template |
|
12 |
+
**replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional]
|
13 |
+
**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]
|
14 |
+
**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]
|
15 |
+
**isActive** | **bool** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSmtpTemplateSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSmtpTemplateSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the sender. If not passed, will be set to default | [optional]
|
7 |
+
**email** | **string** | Email of the sender | [optional]
|
8 |
+
**id** | **int** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSubAccount.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSubAccount
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**companyName** | **string** | Set the name of the sub-account company |
|
7 |
+
**email** | **string** | Email address for the organization |
|
8 |
+
**language** | **string** | Set the language of the sub-account | [optional]
|
9 |
+
**timezone** | **string** | Set the timezone of the sub-account | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateSubAccountResponse.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateSubAccountResponse
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the sub-account created |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateUpdateContactModel.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateUpdateContactModel
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the contact when a new contact is created | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateUpdateFolder.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateUpdateFolder
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the folder | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreateWebhook.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreateWebhook
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**url** | **string** | URL of the webhook |
|
7 |
+
**description** | **string** | Description of the webhook | [optional]
|
8 |
+
**events** | **string[]** | - 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` |
|
9 |
+
**type** | **string** | Type of the webhook | [optional] [default to 'transactional']
|
10 |
+
**domain** | **string** | Inbound domain of webhook, required in case of event type `inbound` | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/CreatedProcessId.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# CreatedProcessId
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**processId** | **int** | Id of the process created |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/DeleteHardbounces.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# DeleteHardbounces
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
**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]
|
8 |
+
**contactEmail** | **string** | Target a specific email address | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/EmailExportRecipients.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# EmailExportRecipients
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**notifyURL** | **string** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional]
|
7 |
+
**recipientsType** | **string** | Type of recipients to export for a campaign |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/ErrorModel.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# ErrorModel
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**code** | **string** | Error code displayed in case of a failure |
|
7 |
+
**message** | **string** | Readable message associated to the failure |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/FileData.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# FileData
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**url** | **string** | Url of uploaded file | [optional]
|
7 |
+
**id** | **string** | Id of uploaded file | [optional]
|
8 |
+
**name** | **string** | Name of uploaded file | [optional]
|
9 |
+
**authorId** | **string** | Account id of user which created the file | [optional]
|
10 |
+
**author** | **object** | Account details of user which created the file | [optional]
|
11 |
+
**contactId** | **int** | Contact id of contact on which file is uploaded | [optional]
|
12 |
+
**dealIds** | **string[]** | Deal ids linked to a file | [optional]
|
13 |
+
**size** | **int** | Size of file uploaded | [optional]
|
14 |
+
**createdAt** | [**\DateTime**] | File created date/time | [optional]
|
15 |
+
**updatedAt** | [**\DateTime**] | File updated date/time | [optional]
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAccount.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAccount
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Login Email |
|
7 |
+
**firstName** | **string** | First Name |
|
8 |
+
**lastName** | **string** | Last Name |
|
9 |
+
**companyName** | **string** | Name of the company |
|
10 |
+
**address** | [**\SendinBlue\Client\Model\GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
|
11 |
+
**plan** | [**\SendinBlue\Client\Model\GetAccountPlan[]**](GetAccountPlan.md) | Information about your plans and credits |
|
12 |
+
**relay** | [**\SendinBlue\Client\Model\GetAccountRelay**](GetAccountRelay.md) | |
|
13 |
+
**marketingAutomation** | [**\SendinBlue\Client\Model\GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional]
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAccountMarketingAutomation.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAccountMarketingAutomation
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**key** | **string** | Marketing Automation Tracker ID | [optional]
|
7 |
+
**enabled** | **bool** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAccountPlan.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAccountPlan
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**type** | **string** | Displays the plan type of the user |
|
7 |
+
**creditsType** | **string** | 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. |
|
8 |
+
**credits** | **float** | Remaining credits of the user |
|
9 |
+
**startDate** | [**\DateTime**] | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional]
|
10 |
+
**endDate** | [**\DateTime**] | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional]
|
11 |
+
**userLimit** | **int** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAccountRelay.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAccountRelay
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**enabled** | **bool** | Status of your transactional email Account (true=Enabled, false=Disabled) |
|
7 |
+
**data** | [**\SendinBlue\Client\Model\GetAccountRelayData**](GetAccountRelayData.md) | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAccountRelayData.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAccountRelayData
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**userName** | **string** | Email to use as login on transactional platform |
|
7 |
+
**relay** | **string** | URL of the SMTP Relay |
|
8 |
+
**port** | **int** | Port used for SMTP Relay |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAggregatedReport.md
ADDED
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAggregatedReport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**range** | **string** | Time frame of the report | [optional]
|
7 |
+
**requests** | **int** | Number of requests for the timeframe | [optional]
|
8 |
+
**delivered** | **int** | Number of delivered emails for the timeframe | [optional]
|
9 |
+
**hardBounces** | **int** | Number of hardbounces for the timeframe | [optional]
|
10 |
+
**softBounces** | **int** | Number of softbounces for the timeframe | [optional]
|
11 |
+
**clicks** | **int** | Number of clicks for the timeframe | [optional]
|
12 |
+
**uniqueClicks** | **int** | Number of unique clicks for the timeframe | [optional]
|
13 |
+
**opens** | **int** | Number of openings for the timeframe | [optional]
|
14 |
+
**uniqueOpens** | **int** | Number of unique openings for the timeframe | [optional]
|
15 |
+
**spamReports** | **int** | Number of complaint (spam report) for the timeframe | [optional]
|
16 |
+
**blocked** | **int** | Number of blocked contact emails for the timeframe | [optional]
|
17 |
+
**invalid** | **int** | Number of invalid emails for the timeframe | [optional]
|
18 |
+
**unsubscribed** | **int** | Number of unsubscribed emails for the timeframe | [optional]
|
19 |
+
|
20 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
21 |
+
|
22 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAttributes.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAttributes
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**attributes** | [**\SendinBlue\Client\Model\GetAttributesAttributes[]**](GetAttributesAttributes.md) | Listing of available contact attributes in your account |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAttributesAttributes.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAttributesAttributes
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the attribute |
|
7 |
+
**category** | **string** | Category of the attribute |
|
8 |
+
**type** | **string** | Type of the attribute | [optional]
|
9 |
+
**enumeration** | [**\SendinBlue\Client\Model\GetAttributesEnumeration[]**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional]
|
10 |
+
**calculatedValue** | **string** | Calculated value formula | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetAttributesEnumeration.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetAttributesEnumeration
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**value** | **int** | ID of Value of the \"category\" type attribute |
|
7 |
+
**label** | **string** | Label of the \"category\" type attribute |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetBlockedDomains.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetBlockedDomains
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**domains** | **string[]** | List of all blocked domains |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetCampaignOverview.md
ADDED
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetCampaignOverview
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the campaign |
|
7 |
+
**name** | **string** | Name of the campaign |
|
8 |
+
**subject** | **string** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
9 |
+
**type** | **string** | Type of campaign |
|
10 |
+
**status** | **string** | Status of the campaign |
|
11 |
+
**scheduledAt** | **string** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
12 |
+
**abTesting** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
13 |
+
**subjectA** | **string** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
14 |
+
**subjectB** | **string** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
15 |
+
**splitRule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
16 |
+
**winnerCriteria** | **string** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
17 |
+
**winnerDelay** | **int** | 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]
|
18 |
+
**sendAtBestTime** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
|
19 |
+
|
20 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
21 |
+
|
22 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetCampaignRecipients.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetCampaignRecipients
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**lists** | **int[]** | |
|
7 |
+
**exclusionLists** | **int[]** | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetCampaignStats.md
ADDED
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetCampaignStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**listId** | **int** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional]
|
7 |
+
**uniqueClicks** | **int** | Number of unique clicks for the campaign |
|
8 |
+
**clickers** | **int** | Number of total clicks for the campaign |
|
9 |
+
**complaints** | **int** | Number of complaints (Spam reports) for the campaign |
|
10 |
+
**delivered** | **int** | Number of delivered emails for the campaign |
|
11 |
+
**sent** | **int** | Number of sent emails for the campaign |
|
12 |
+
**softBounces** | **int** | Number of softbounce for the campaign |
|
13 |
+
**hardBounces** | **int** | Number of harbounce for the campaign |
|
14 |
+
**uniqueViews** | **int** | Number of unique openings for the campaign |
|
15 |
+
**trackableViews** | **int** | Recipients without any privacy protection option enabled in their email client |
|
16 |
+
**unsubscriptions** | **int** | Number of unsubscription for the campaign |
|
17 |
+
**viewed** | **int** | Number of openings for the campaign |
|
18 |
+
**deferred** | **int** | Number of deferred emails for the campaign | [optional]
|
19 |
+
**returnBounce** | **int** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
20 |
+
|
21 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
22 |
+
|
23 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildAccountCreationStatus.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildAccountCreationStatus
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**childAccountCreated** | **bool** | Status of child account creation whether it is successfully created (exists) or not. |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildDomain.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildDomain
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**domain** | **string** | Sender domain | [optional]
|
7 |
+
**active** | **bool** | indicates whether a domain is verified or not | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildDomains.md
ADDED
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildDomains
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
|
7 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
8 |
+
|
9 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfo.md
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildInfo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Login Email |
|
7 |
+
**firstName** | **string** | First Name |
|
8 |
+
**lastName** | **string** | Last Name |
|
9 |
+
**companyName** | **string** | Name of the company |
|
10 |
+
**credits** | [**\SendinBlue\Client\Model\GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional]
|
11 |
+
**statistics** | [**\SendinBlue\Client\Model\GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional]
|
12 |
+
**password** | **string** | The encrypted password of child account |
|
13 |
+
**ips** | **string[]** | IP(s) associated to a child account user | [optional]
|
14 |
+
**apiKeys** | [**\SendinBlue\Client\Model\GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional]
|
15 |
+
|
16 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
17 |
+
|
18 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoApiKeys.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildInfoApiKeys
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**v2** | [**\SendinBlue\Client\Model\GetChildInfoApiKeysV2[]**](GetChildInfoApiKeysV2.md) | |
|
7 |
+
**v3** | [**\SendinBlue\Client\Model\GetChildInfoApiKeysV3[]**](GetChildInfoApiKeysV3.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoApiKeysV2.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildInfoApiKeysV2
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the key for version 2 |
|
7 |
+
**key** | **string** | API Key for version 2 |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoApiKeysV3.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildInfoApiKeysV3
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the key for version 3 |
|
7 |
+
**key** | **string** | API Key for version 3 |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoCredits.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildInfoCredits
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**emailCredits** | **int** | Email credits available for your child | [optional]
|
7 |
+
**smsCredits** | **int** | SMS credits available for your child | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildInfoStatistics.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildInfoStatistics
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**previousMonthTotalSent** | **int** | Overall emails sent for the previous month | [optional]
|
7 |
+
**currentMonthTotalSent** | **int** | Overall emails sent for current month | [optional]
|
8 |
+
**totalSent** | **int** | Overall emails sent for since the account exists | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetChildrenList.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetChildrenList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**children** | **object[]** | Your children's account information | [optional]
|
7 |
+
**count** | **int** | Number of child accounts | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetClient.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetClient
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Login Email |
|
7 |
+
**firstName** | **string** | First Name |
|
8 |
+
**lastName** | **string** | Last Name |
|
9 |
+
**companyName** | **string** | Name of the company |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStats.md
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContactCampaignStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**messagesSent** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
|
7 |
+
**hardBounces** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
|
8 |
+
**softBounces** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
|
9 |
+
**complaints** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
|
10 |
+
**unsubscriptions** | [**\SendinBlue\Client\Model\GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) | | [optional]
|
11 |
+
**opened** | [**\SendinBlue\Client\Model\GetContactCampaignStatsOpened[]**](GetContactCampaignStatsOpened.md) | | [optional]
|
12 |
+
**clicked** | [**\SendinBlue\Client\Model\GetContactCampaignStatsClicked[]**](GetContactCampaignStatsClicked.md) | | [optional]
|
13 |
+
**transacAttributes** | [**\SendinBlue\Client\Model\GetContactCampaignStatsTransacAttributes[]**](GetContactCampaignStatsTransacAttributes.md) | | [optional]
|
14 |
+
**delivered** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
|
15 |
+
|
16 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
17 |
+
|
18 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsClicked.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContactCampaignStatsClicked
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**links** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsLinks[]**](GetExtendedContactDetailsStatisticsLinks.md) | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsOpened.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContactCampaignStatsOpened
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**count** | **int** | Number of openings of the campaign |
|
8 |
+
**eventTime** | **string** | UTC date-time of the event |
|
9 |
+
**ip** | **string** | IP from which the user has opened the campaign |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsTransacAttributes.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContactCampaignStatsTransacAttributes
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**orderDate** | [**\DateTime**] | Date of the order |
|
7 |
+
**orderPrice** | **float** | Price of the order |
|
8 |
+
**orderId** | **int** | ID of the order |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContactCampaignStatsUnsubscriptions.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContactCampaignStatsUnsubscriptions
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**userUnsubscription** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email |
|
7 |
+
**adminUnsubscription** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContactDetails.md
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContactDetails
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the contact for which you requested the details |
|
7 |
+
**id** | **int** | ID of the contact for which you requested the details |
|
8 |
+
**emailBlacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
9 |
+
**smsBlacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
10 |
+
**createdAt** | **string** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
11 |
+
**modifiedAt** | **string** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12 |
+
**listIds** | **int[]** | |
|
13 |
+
**listUnsubscribed** | **int[]** | | [optional]
|
14 |
+
**attributes** | **object** | Set of attributes of the contact |
|
15 |
+
|
16 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
17 |
+
|
18 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetContacts.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetContacts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**contacts** | **object[]** | |
|
7 |
+
**count** | **int** | Number of contacts |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetDeviceBrowserStats.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetDeviceBrowserStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**clickers** | **int** | Number of total clicks for the campaign using the particular browser |
|
7 |
+
**uniqueClicks** | **int** | Number of unique clicks for the campaign using the particular browser |
|
8 |
+
**viewed** | **int** | Number of openings for the campaign using the particular browser |
|
9 |
+
**uniqueViews** | **int** | Number of unique openings for the campaign using the particular browser |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetEmailCampaign.md
ADDED
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetEmailCampaign
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the campaign |
|
7 |
+
**name** | **string** | Name of the campaign |
|
8 |
+
**subject** | **string** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
9 |
+
**type** | **string** | Type of campaign |
|
10 |
+
**status** | **string** | Status of the campaign |
|
11 |
+
**scheduledAt** | **string** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
12 |
+
**abTesting** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
13 |
+
**subjectA** | **string** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
14 |
+
**subjectB** | **string** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
15 |
+
**splitRule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
16 |
+
**winnerCriteria** | **string** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
17 |
+
**winnerDelay** | **int** | 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]
|
18 |
+
**sendAtBestTime** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
|
19 |
+
**testSent** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
|
20 |
+
**header** | **string** | Header of the campaign |
|
21 |
+
**footer** | **string** | Footer of the campaign |
|
22 |
+
**sender** | [**\SendinBlue\Client\Model\GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
23 |
+
**replyTo** | **string** | Email defined as the \"Reply to\" of the campaign |
|
24 |
+
**toField** | **string** | Customisation of the \"to\" field of the campaign | [optional]
|
25 |
+
**htmlContent** | **string** | HTML content of the campaign |
|
26 |
+
**shareLink** | **string** | Link to share the campaign on social medias | [optional]
|
27 |
+
**tag** | **string** | Tag of the campaign | [optional]
|
28 |
+
**createdAt** | **string** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
29 |
+
**modifiedAt** | **string** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
30 |
+
**inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
31 |
+
**mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
32 |
+
**recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
33 |
+
**sentDate** | **string** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34 |
+
**returnBounce** | **int** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
35 |
+
**recipients** | **object** | |
|
36 |
+
**statistics** | **object** | |
|
37 |
+
|
38 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
39 |
+
|
40 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetEmailCampaigns.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetEmailCampaigns
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaigns** | **object[]** | | [optional]
|
7 |
+
**count** | **int** | Number of Email campaigns retrieved | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetEmailEventReport.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetEmailEventReport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**events** | [**\SendinBlue\Client\Model\GetEmailEventReportEvents[]**](GetEmailEventReportEvents.md) | | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetEmailEventReportEvents.md
ADDED
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetEmailEventReportEvents
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address which generates the event |
|
7 |
+
**date** | **string** | UTC date-time on which the event has been generated |
|
8 |
+
**subject** | **string** | Subject of the event | [optional]
|
9 |
+
**messageId** | **string** | Message ID which generated the event |
|
10 |
+
**event** | **string** | Event which occurred |
|
11 |
+
**reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
|
12 |
+
**tag** | **string** | Tag of the email which generated the event | [optional]
|
13 |
+
**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]
|
14 |
+
**link** | **string** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
|
15 |
+
**from** | **string** | Sender email from which the emails are sent | [optional]
|
16 |
+
**templateId** | **int** | ID of the template (only available if the email is template based) | [optional]
|
17 |
+
|
18 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
19 |
+
|
20 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedCampaignOverview.md
ADDED
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedCampaignOverview
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the campaign |
|
7 |
+
**name** | **string** | Name of the campaign |
|
8 |
+
**subject** | **string** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
9 |
+
**type** | **string** | Type of campaign |
|
10 |
+
**status** | **string** | Status of the campaign |
|
11 |
+
**scheduledAt** | **string** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
12 |
+
**abTesting** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
13 |
+
**subjectA** | **string** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
14 |
+
**subjectB** | **string** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
15 |
+
**splitRule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
16 |
+
**winnerCriteria** | **string** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
17 |
+
**winnerDelay** | **int** | 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]
|
18 |
+
**sendAtBestTime** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
|
19 |
+
**testSent** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
|
20 |
+
**header** | **string** | Header of the campaign |
|
21 |
+
**footer** | **string** | Footer of the campaign |
|
22 |
+
**sender** | [**\SendinBlue\Client\Model\GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
23 |
+
**replyTo** | **string** | Email defined as the \"Reply to\" of the campaign |
|
24 |
+
**toField** | **string** | Customisation of the \"to\" field of the campaign | [optional]
|
25 |
+
**htmlContent** | **string** | HTML content of the campaign |
|
26 |
+
**shareLink** | **string** | Link to share the campaign on social medias | [optional]
|
27 |
+
**tag** | **string** | Tag of the campaign | [optional]
|
28 |
+
**createdAt** | **string** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
29 |
+
**modifiedAt** | **string** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
30 |
+
**inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
31 |
+
**mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
32 |
+
**recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
33 |
+
**sentDate** | **string** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34 |
+
**returnBounce** | **int** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
35 |
+
|
36 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
37 |
+
|
38 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedCampaignOverviewSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedCampaignOverviewSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Sender name of the campaign | [optional]
|
7 |
+
**email** | **string** | Sender email of the campaign | [optional]
|
8 |
+
**id** | **string** | Sender id of the campaign | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedCampaignStats.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedCampaignStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**globalStats** | **object** | Overall statistics of the campaign |
|
7 |
+
**campaignStats** | **object[]** | List-wise statistics of the campaign. |
|
8 |
+
**mirrorClick** | **int** | Number of clicks on mirror link |
|
9 |
+
**remaining** | **int** | Number of remaning emails to send |
|
10 |
+
**linksStats** | **object** | Statistics about the number of clicks for the links |
|
11 |
+
**statsByDomain** | [**\SendinBlue\Client\Model\GetStatsByDomain**](GetStatsByDomain.md) | |
|
12 |
+
**statsByDevice** | [**\SendinBlue\Client\Model\GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices |
|
13 |
+
**statsByBrowser** | [**\SendinBlue\Client\Model\GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers |
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedClient.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedClient
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Login Email |
|
7 |
+
**firstName** | **string** | First Name |
|
8 |
+
**lastName** | **string** | Last Name |
|
9 |
+
**companyName** | **string** | Name of the company |
|
10 |
+
**address** | [**\SendinBlue\Client\Model\GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedClientAddress.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedClientAddress
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**street** | **string** | Street information |
|
7 |
+
**city** | **string** | City information |
|
8 |
+
**zipCode** | **string** | Zip Code information |
|
9 |
+
**country** | **string** | Country information |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetails.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetails
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the contact for which you requested the details |
|
7 |
+
**id** | **int** | ID of the contact for which you requested the details |
|
8 |
+
**emailBlacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
9 |
+
**smsBlacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
10 |
+
**createdAt** | **string** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
11 |
+
**modifiedAt** | **string** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12 |
+
**listIds** | **int[]** | |
|
13 |
+
**listUnsubscribed** | **int[]** | | [optional]
|
14 |
+
**attributes** | **object** | Set of attributes of the contact |
|
15 |
+
**statistics** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatistics.md
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatistics
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**messagesSent** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the sent campaign for the contact | [optional]
|
7 |
+
**hardBounces** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the hardbounes generated by the contact | [optional]
|
8 |
+
**softBounces** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the softbounes generated by the contact | [optional]
|
9 |
+
**complaints** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the complaints generated by the contact | [optional]
|
10 |
+
**unsubscriptions** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptions**](GetExtendedContactDetailsStatisticsUnsubscriptions.md) | | [optional]
|
11 |
+
**opened** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsOpened[]**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional]
|
12 |
+
**clicked** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsClicked[]**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional]
|
13 |
+
**transacAttributes** | **object[]** | Listing of the transactional attributes for the contact | [optional]
|
14 |
+
**delivered** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsDelivered[]**](GetExtendedContactDetailsStatisticsDelivered.md) | Listing of the delivered campaign for the contact | [optional]
|
15 |
+
|
16 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
17 |
+
|
18 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsClicked.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsClicked
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**links** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsLinks[]**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsDelivered.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsDelivered
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**eventTime** | **string** | UTC date-time of the event |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsLinks.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsLinks
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**count** | **int** | Number of clicks on this link for the campaign |
|
7 |
+
**eventTime** | **string** | UTC date-time of the event |
|
8 |
+
**ip** | **string** | IP from which the user has clicked on the link |
|
9 |
+
**url** | **string** | URL of the clicked link |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsMessagesSent
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**eventTime** | **string** | UTC date-time of the event |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsOpened.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsOpened
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**count** | **int** | Number of openings for the campaign |
|
8 |
+
**eventTime** | **string** | UTC date-time of the event |
|
9 |
+
**ip** | **string** | IP from which the user has opened the email |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsUnsubscriptions
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**userUnsubscription** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign |
|
7 |
+
**adminUnsubscription** | [**\SendinBlue\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**eventTime** | **string** | UTC date-time of the event |
|
7 |
+
**ip** | **string** | IP from which the user has been unsubscribed | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign which generated the event |
|
7 |
+
**eventTime** | **string** | UTC date-time of the event |
|
8 |
+
**ip** | **string** | IP from which the user has unsubscribed | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedList.md
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the list |
|
7 |
+
**name** | **string** | Name of the list |
|
8 |
+
**totalBlacklisted** | **int** | Number of blacklisted contacts in the list |
|
9 |
+
**totalSubscribers** | **int** | Number of contacts in the list |
|
10 |
+
**uniqueSubscribers** | **int** | Number of unique contacts in the list |
|
11 |
+
**folderId** | **int** | ID of the folder |
|
12 |
+
**createdAt** | **string** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13 |
+
**campaignStats** | [**\SendinBlue\Client\Model\GetExtendedListCampaignStats[]**](GetExtendedListCampaignStats.md) | | [optional]
|
14 |
+
**dynamicList** | **bool** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
|
15 |
+
|
16 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
17 |
+
|
18 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetExtendedListCampaignStats.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetExtendedListCampaignStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaignId** | **int** | ID of the campaign |
|
7 |
+
**stats** | [**\SendinBlue\Client\Model\GetCampaignStats**](GetCampaignStats.md) | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetFolder.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetFolder
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the folder |
|
7 |
+
**name** | **string** | Name of the folder |
|
8 |
+
**totalBlacklisted** | **int** | Number of blacklisted contacts in the folder |
|
9 |
+
**totalSubscribers** | **int** | Number of contacts in the folder |
|
10 |
+
**uniqueSubscribers** | **int** | Number of unique contacts in the folder |
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetFolderLists.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetFolderLists
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**lists** | **object[]** | | [optional]
|
7 |
+
**count** | **int** | Number of lists in the folder | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetFolders.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetFolders
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**folders** | **object[]** | | [optional]
|
7 |
+
**count** | **int** | Number of folders available in your account | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEvents.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetInboundEmailEvents
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**events** | [**\SendinBlue\Client\Model\GetInboundEmailEventsEvents[]**](GetInboundEmailEventsEvents.md) | | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsByUuid.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetInboundEmailEventsByUuid
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**receivedAt** | [**\DateTime**] | Date when email was received on SMTP relay | [optional]
|
7 |
+
**deliveredAt** | [**\DateTime**] | Date when email was delivered successfully to client’s webhook | [optional]
|
8 |
+
**recipient** | **string** | Recipient’s email address | [optional]
|
9 |
+
**sender** | **string** | Sender’s email address | [optional]
|
10 |
+
**messageId** | **string** | Value of the Message-ID header. This will be present only after the processing is done. | [optional]
|
11 |
+
**subject** | **string** | Value of the Subject header. This will be present only after the processing is done. | [optional]
|
12 |
+
**attachments** | [**\SendinBlue\Client\Model\GetInboundEmailEventsByUuidAttachments[]**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional]
|
13 |
+
**logs** | [**\SendinBlue\Client\Model\GetInboundEmailEventsByUuidLogs[]**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional]
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsByUuidAttachments.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetInboundEmailEventsByUuidAttachments
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | filename specified in the Content-Disposition header of the attachment | [optional]
|
7 |
+
**contentType** | **string** | value of the Content-Type header of the attachment | [optional]
|
8 |
+
**contentId** | **string** | value of the Content-ID header of the attachment. | [optional]
|
9 |
+
**contentLength** | **int** | size of the attachment in bytes | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsByUuidLogs.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetInboundEmailEventsByUuidLogs
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**date** | [**\DateTime**] | Date of the event | [optional]
|
7 |
+
**type** | **string** | Type of the event | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetInboundEmailEventsEvents.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetInboundEmailEventsEvents
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**uuid** | **string** | UUID that can be used to fetch additional data |
|
7 |
+
**date** | [**\DateTime**] | Date when email was received on SMTP relay |
|
8 |
+
**sender** | **string** | Sender’s email address |
|
9 |
+
**recipient** | **string** | Recipient’s email address |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetIp.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetIp
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the dedicated IP |
|
7 |
+
**ip** | **string** | Dedicated IP |
|
8 |
+
**active** | **bool** | Status of the IP (true=active, false=inactive) |
|
9 |
+
**domain** | **string** | Domain associated to the IP |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetIpFromSender.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetIpFromSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the dedicated IP |
|
7 |
+
**ip** | **string** | Dedicated IP |
|
8 |
+
**domain** | **string** | Domain associated to the IP |
|
9 |
+
**weight** | **int** | Weight of the IP |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetIps.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetIps
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**ips** | [**\SendinBlue\Client\Model\GetIp[]**](GetIp.md) | Dedicated IP(s) available on your account |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetIpsFromSender.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetIpsFromSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**ips** | [**\SendinBlue\Client\Model\GetIpFromSender[]**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetList.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the list |
|
7 |
+
**name** | **string** | Name of the list |
|
8 |
+
**totalBlacklisted** | **int** | Number of blacklisted contacts in the list |
|
9 |
+
**totalSubscribers** | **int** | Number of contacts in the list |
|
10 |
+
**uniqueSubscribers** | **int** | Number of unique contacts in the list |
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetLists.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetLists
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**lists** | **object[]** | Listing of all the lists available in your account | [optional]
|
7 |
+
**count** | **int** | Number of lists in your account | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetProcess.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetProcess
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | Id of the process |
|
7 |
+
**status** | **string** | Status of the process |
|
8 |
+
**name** | **string** | Process name |
|
9 |
+
**exportUrl** | **string** | URL on which send export the of contacts once the process is completed | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetProcesses.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetProcesses
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**processes** | [**\SendinBlue\Client\Model\GetProcess[]**](GetProcess.md) | List of processes available on your account | [optional]
|
7 |
+
**count** | **int** | Number of processes available on your account | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetReports.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetReports
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**reports** | [**\SendinBlue\Client\Model\GetReportsReports[]**](GetReportsReports.md) | | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetReportsReports.md
ADDED
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetReportsReports
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**date** | [**\DateTime**] | Date of the statistics |
|
7 |
+
**requests** | **int** | Number of requests for the date |
|
8 |
+
**delivered** | **int** | Number of delivered emails for the date |
|
9 |
+
**hardBounces** | **int** | Number of hardbounces for the date |
|
10 |
+
**softBounces** | **int** | Number of softbounces for the date |
|
11 |
+
**clicks** | **int** | Number of clicks for the date |
|
12 |
+
**uniqueClicks** | **int** | Number of unique clicks for the date |
|
13 |
+
**opens** | **int** | Number of openings for the date |
|
14 |
+
**uniqueOpens** | **int** | Number of unique openings for the date |
|
15 |
+
**spamReports** | **int** | Number of complaints (spam reports) for the date |
|
16 |
+
**blocked** | **int** | Number of blocked emails for the date |
|
17 |
+
**invalid** | **int** | Number of invalid emails for the date |
|
18 |
+
**unsubscribed** | **int** | Number of unsubscribed emails for the date |
|
19 |
+
|
20 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
21 |
+
|
22 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetScheduledEmailByBatchId.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetScheduledEmailByBatchId
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**count** | **int** | Total number of batches | [optional]
|
7 |
+
**batches** | [**\SendinBlue\Client\Model\GetScheduledEmailByBatchIdBatches[]**](GetScheduledEmailByBatchIdBatches.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetScheduledEmailByBatchIdBatches.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetScheduledEmailByBatchIdBatches
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**scheduledAt** | [**\DateTime**] | Datetime for which the batch was scheduled |
|
7 |
+
**createdAt** | [**\DateTime**] | Datetime on which the batch was scheduled |
|
8 |
+
**status** | **string** | Current status of the scheduled batch |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetScheduledEmailByMessageId.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetScheduledEmailByMessageId
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**scheduledAt** | [**\DateTime**] | Datetime for which the email was scheduled |
|
7 |
+
**createdAt** | [**\DateTime**] | Datetime on which the email was scheduled |
|
8 |
+
**status** | **string** | Current status of the scheduled email |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSendersList.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSendersList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**senders** | [**\SendinBlue\Client\Model\GetSendersListSenders[]**](GetSendersListSenders.md) | List of the senders available in your account | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSendersListIps.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSendersListIps
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**ip** | **string** | Dedicated IP available in your account |
|
7 |
+
**domain** | **string** | Domain of the IP |
|
8 |
+
**weight** | **int** | Weight of the IP for this sender |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSendersListSenders.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSendersListSenders
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | Id of the sender |
|
7 |
+
**name** | **string** | From Name associated to the sender |
|
8 |
+
**email** | **string** | From Email associated to the sender |
|
9 |
+
**active** | **bool** | Status of sender (true=activated, false=deactivated) |
|
10 |
+
**ips** | [**\SendinBlue\Client\Model\GetSendersListIps[]**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSharedTemplateUrl.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSharedTemplateUrl
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sharedUrl** | **string** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaign.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmsCampaign
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the SMS Campaign |
|
7 |
+
**name** | **string** | Name of the SMS Campaign |
|
8 |
+
**status** | **string** | Status of the SMS Campaign |
|
9 |
+
**content** | **string** | Content of the SMS Campaign |
|
10 |
+
**scheduledAt** | **string** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11 |
+
**sender** | **string** | Sender of the SMS Campaign |
|
12 |
+
**createdAt** | **string** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13 |
+
**modifiedAt** | **string** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14 |
+
**recipients** | **object** | |
|
15 |
+
**statistics** | **object** | |
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaignOverview.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmsCampaignOverview
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the SMS Campaign |
|
7 |
+
**name** | **string** | Name of the SMS Campaign |
|
8 |
+
**status** | **string** | Status of the SMS Campaign |
|
9 |
+
**content** | **string** | Content of the SMS Campaign |
|
10 |
+
**scheduledAt** | **string** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11 |
+
**sender** | **string** | Sender of the SMS Campaign |
|
12 |
+
**createdAt** | **string** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13 |
+
**modifiedAt** | **string** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaignStats.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmsCampaignStats
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**delivered** | **int** | Number of delivered SMS |
|
7 |
+
**sent** | **int** | Number of sent SMS |
|
8 |
+
**processing** | **int** | Number of processing SMS |
|
9 |
+
**softBounces** | **int** | Number of softbounced SMS |
|
10 |
+
**hardBounces** | **int** | Number of hardbounced SMS |
|
11 |
+
**unsubscriptions** | **int** | Number of unsubscription SMS |
|
12 |
+
**answered** | **int** | Number of replies to the SMS |
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmsCampaigns.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmsCampaigns
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**campaigns** | **object[]** | | [optional]
|
7 |
+
**count** | **int** | Number of SMS campaigns retrieved | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmsEventReport.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmsEventReport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**events** | [**\SendinBlue\Client\Model\GetSmsEventReportEvents[]**](GetSmsEventReportEvents.md) | | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmsEventReportEvents.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmsEventReportEvents
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**phoneNumber** | **string** | Phone number which has generated the event | [optional]
|
7 |
+
**date** | **string** | UTC date-time on which the event has been generated | [optional]
|
8 |
+
**messageId** | **string** | Message ID which generated the event | [optional]
|
9 |
+
**event** | **string** | Event which occurred | [optional]
|
10 |
+
**reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
|
11 |
+
**reply** | **string** | | [optional]
|
12 |
+
**tag** | **string** | Tag of the SMS which generated the event | [optional]
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmtpTemplateOverview.md
ADDED
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmtpTemplateOverview
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | ID of the template |
|
7 |
+
**name** | **string** | Name of the template |
|
8 |
+
**subject** | **string** | Subject of the template |
|
9 |
+
**isActive** | **bool** | Status of template (true=active, false=inactive) |
|
10 |
+
**testSent** | **bool** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) |
|
11 |
+
**sender** | [**\SendinBlue\Client\Model\GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | |
|
12 |
+
**replyTo** | **string** | Email defined as the \"Reply to\" for the template |
|
13 |
+
**toField** | **string** | Customisation of the \"to\" field for the template |
|
14 |
+
**tag** | **string** | Tag of the template |
|
15 |
+
**htmlContent** | **string** | HTML content of the template |
|
16 |
+
**createdAt** | **string** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
17 |
+
**modifiedAt** | **string** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
18 |
+
**doiTemplate** | **bool** | 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]
|
19 |
+
|
20 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
21 |
+
|
22 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmtpTemplateOverviewSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmtpTemplateOverviewSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | From email for the template | [optional]
|
7 |
+
**email** | **string** | From email for the template | [optional]
|
8 |
+
**id** | **string** | Sender id of the template | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSmtpTemplates.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSmtpTemplates
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**count** | **int** | Count of transactional email templates | [optional]
|
7 |
+
**templates** | [**\SendinBlue\Client\Model\GetSmtpTemplateOverview[]**](GetSmtpTemplateOverview.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetSsoToken.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetSsoToken
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**token** | **string** | Session token, it will remain valid for 15 days. |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetStatsByBrowser.md
ADDED
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetStatsByBrowser
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
|
7 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
8 |
+
|
9 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetStatsByDevice.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetStatsByDevice
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**desktop** | [**map[string,\SendinBlue\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional]
|
7 |
+
**mobile** | [**map[string,\SendinBlue\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional]
|
8 |
+
**tablet** | [**map[string,\SendinBlue\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional]
|
9 |
+
**unknown** | [**map[string,\SendinBlue\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetStatsByDomain.md
ADDED
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetStatsByDomain
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
|
7 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
8 |
+
|
9 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacAggregatedSmsReport.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacAggregatedSmsReport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**range** | **string** | Time frame of the report | [optional]
|
7 |
+
**requests** | **int** | Number of requests for the timeframe | [optional]
|
8 |
+
**delivered** | **int** | Number of delivered SMS for the timeframe | [optional]
|
9 |
+
**hardBounces** | **int** | Number of hardbounces for the timeframe | [optional]
|
10 |
+
**softBounces** | **int** | Number of softbounces for the timeframe | [optional]
|
11 |
+
**blocked** | **int** | Number of blocked contact for the timeframe | [optional]
|
12 |
+
**unsubscribed** | **int** | Number of unsubscription for the timeframe | [optional]
|
13 |
+
**replied** | **int** | Number of answered SMS for the timeframe | [optional]
|
14 |
+
**accepted** | **int** | Number of accepted for the timeframe | [optional]
|
15 |
+
**rejected** | **int** | Number of rejected for the timeframe | [optional]
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacBlockedContacts.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacBlockedContacts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**count** | **int** | Count of blocked or unsubscribed contact | [optional]
|
7 |
+
**contacts** | [**\SendinBlue\Client\Model\GetTransacBlockedContactsContacts[]**](GetTransacBlockedContactsContacts.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacBlockedContactsContacts.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacBlockedContactsContacts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the blocked or unsubscribed contact |
|
7 |
+
**senderEmail** | **string** | Sender email address of the blocked or unsubscribed contact |
|
8 |
+
**reason** | [**\SendinBlue\Client\Model\GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
|
9 |
+
**blockedAt** | **string** | Date when the contact was blocked or unsubscribed on |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacBlockedContactsReason.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacBlockedContactsReason
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**code** | **string** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional]
|
7 |
+
**message** | **string** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailContent.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacEmailContent
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address to which transactional email has been sent |
|
7 |
+
**subject** | **string** | Subject of the sent email |
|
8 |
+
**templateId** | **int** | Id of the template | [optional]
|
9 |
+
**date** | **string** | Date on which transactional email was sent |
|
10 |
+
**events** | [**\SendinBlue\Client\Model\GetTransacEmailContentEvents[]**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email |
|
11 |
+
**body** | **string** | Actual content of the transactional email that has been sent |
|
12 |
+
**attachmentCount** | **int** | Count of the attachments that were sent in the email |
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailContentEvents.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacEmailContentEvents
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the event that occurred on the sent email |
|
7 |
+
**time** | **string** | Time at which the event occurred |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailsList.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacEmailsList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**count** | **int** | Total number of transactional emails available on your account according to the passed filter | [optional]
|
7 |
+
**transactionalEmails** | [**\SendinBlue\Client\Model\GetTransacEmailsListTransactionalEmails[]**](GetTransacEmailsListTransactionalEmails.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacEmailsListTransactionalEmails.md
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacEmailsListTransactionalEmails
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address to which transactional email has been sent |
|
7 |
+
**subject** | **string** | Subject of the sent email |
|
8 |
+
**templateId** | **int** | Id of the template | [optional]
|
9 |
+
**messageId** | **string** | Message Id of the sent email |
|
10 |
+
**uuid** | **string** | Unique id of the email sent to a particular contact |
|
11 |
+
**date** | **string** | Date on which transactional email was sent |
|
12 |
+
**from** | **string** | Email address of the sender from which the email was sent | [optional]
|
13 |
+
**tags** | **string[]** | Tags used for your email | [optional]
|
14 |
+
|
15 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
16 |
+
|
17 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacSmsReport.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacSmsReport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**reports** | [**\SendinBlue\Client\Model\GetTransacSmsReportReports[]**](GetTransacSmsReportReports.md) | | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetTransacSmsReportReports.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetTransacSmsReportReports
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**date** | [**\DateTime**] | Date for which statistics are retrieved | [optional]
|
7 |
+
**requests** | **int** | Number of requests for the date | [optional]
|
8 |
+
**delivered** | **int** | Number of delivered SMS for the date | [optional]
|
9 |
+
**hardBounces** | **int** | Number of hardbounces for the date | [optional]
|
10 |
+
**softBounces** | **int** | Number of softbounces for the date | [optional]
|
11 |
+
**blocked** | **int** | Number of blocked contact for the date | [optional]
|
12 |
+
**unsubscribed** | **int** | Number of unsubscription for the date | [optional]
|
13 |
+
**replied** | **int** | Number of answered SMS for the date | [optional]
|
14 |
+
**accepted** | **int** | Number of accepted for the date | [optional]
|
15 |
+
**rejected** | **int** | Number of rejected for the date | [optional]
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetWebhook.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetWebhook
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**url** | **string** | URL of the webhook |
|
7 |
+
**id** | **int** | ID of the webhook |
|
8 |
+
**description** | **string** | Description of the webhook |
|
9 |
+
**events** | **string[]** | |
|
10 |
+
**type** | **string** | Type of webhook (marketing or transac) |
|
11 |
+
**createdAt** | **string** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12 |
+
**modifiedAt** | **string** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/GetWebhooks.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# GetWebhooks
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**webhooks** | **object[]** | |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/InlineResponse201.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# InlineResponse201
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **string** | Unique task id |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/ManageIp.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# ManageIp
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**ip** | **string** | Dedicated ID | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponse.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# MasterDetailsResponse
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email id of master account | [optional]
|
7 |
+
**companyName** | **string** | Company name of master account organization | [optional]
|
8 |
+
**id** | **int** | Unique identifier of the master account organization | [optional]
|
9 |
+
**currencyCode** | **string** | Currency code of the master account organization | [optional]
|
10 |
+
**timezone** | **string** | Timezone of the master account organization | [optional]
|
11 |
+
**billingInfo** | [**\SendinBlue\Client\Model\MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) | | [optional]
|
12 |
+
**planInfo** | [**\SendinBlue\Client\Model\MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) | | [optional]
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponseBillingInfo.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# MasterDetailsResponseBillingInfo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Billing email id of master account | [optional]
|
7 |
+
**companyName** | **string** | Company name of master account | [optional]
|
8 |
+
**name** | [**\SendinBlue\Client\Model\MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) | | [optional]
|
9 |
+
**address** | [**\SendinBlue\Client\Model\MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) | | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponseBillingInfoAddress.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# MasterDetailsResponseBillingInfoAddress
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**streetAddress** | **string** | Street address | [optional]
|
7 |
+
**locality** | **string** | Locality | [optional]
|
8 |
+
**postalCode** | **string** | Postal code | [optional]
|
9 |
+
**stateCode** | **string** | State code | [optional]
|
10 |
+
**countryCode** | **string** | Country code | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponseBillingInfoName.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# MasterDetailsResponseBillingInfoName
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**givenName** | **string** | First name for billing | [optional]
|
7 |
+
**familyName** | **string** | Last name for billing | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponsePlanInfo.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# MasterDetailsResponsePlanInfo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**currencyCode** | **string** | Plan currency | [optional]
|
7 |
+
**nextBillingAt** | **int** | Timestamp of next billing date | [optional]
|
8 |
+
**price** | **float** | Plan amount | [optional]
|
9 |
+
**planPeriod** | **string** | Plan period type | [optional]
|
10 |
+
**subAccounts** | **int** | Number of sub-accounts | [optional]
|
11 |
+
**features** | [**\SendinBlue\Client\Model\MasterDetailsResponsePlanInfoFeatures[]**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/MasterDetailsResponsePlanInfoFeatures.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# MasterDetailsResponsePlanInfoFeatures
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the feature | [optional]
|
7 |
+
**unitValue** | **string** | Unit value of the feature | [optional]
|
8 |
+
**quantity** | **int** | Quantity provided in the plan | [optional]
|
9 |
+
**used** | **int** | Quantity consumed by master | [optional]
|
10 |
+
**remaining** | **int** | Quantity remaining in the plan | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/Note.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Note
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **string** | Unique note Id | [optional]
|
7 |
+
**text** | **string** | Text content of a note |
|
8 |
+
**contactIds** | **int[]** | Contact ids linked to a note | [optional]
|
9 |
+
**dealIds** | **string[]** | Deal ids linked to a note | [optional]
|
10 |
+
**authorId** | **object** | Account details of user which created the note | [optional]
|
11 |
+
**createdAt** | [**\DateTime**] | Note created date/time | [optional]
|
12 |
+
**updatedAt** | [**\DateTime**] | Note updated date/time | [optional]
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/NoteData.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# NoteData
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**text** | **string** | Text content of a note |
|
7 |
+
**contactIds** | **int[]** | Contact Ids linked to a note | [optional]
|
8 |
+
**dealIds** | **string[]** | Deal Ids linked to a note | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/PostContactInfo.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# PostContactInfo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**contacts** | [**\SendinBlue\Client\Model\PostContactInfoContacts**](PostContactInfoContacts.md) | |
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/PostContactInfoContacts.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# PostContactInfoContacts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**success** | **string[]** | | [optional]
|
7 |
+
**failure** | **string[]** | | [optional]
|
8 |
+
**total** | **int** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional]
|
9 |
+
**processId** | **int** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/PostSendFailed.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# PostSendFailed
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**code** | **int** | Response code |
|
7 |
+
**message** | **string** | Response message |
|
8 |
+
**unexistingEmails** | **string[]** | | [optional]
|
9 |
+
**withoutListEmails** | **string[]** | | [optional]
|
10 |
+
**blackListedEmails** | **string[]** | | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/PostSendSmsTestFailed.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# PostSendSmsTestFailed
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**code** | **int** | Response code |
|
7 |
+
**message** | **string** | Response message |
|
8 |
+
**unexistingSms** | **string[]** | | [optional]
|
9 |
+
**withoutListSms** | **string[]** | | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RemainingCreditModel.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RemainingCreditModel
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**child** | [**\SendinBlue\Client\Model\RemainingCreditModelChild**](RemainingCreditModelChild.md) | |
|
7 |
+
**reseller** | [**\SendinBlue\Client\Model\RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RemainingCreditModelChild.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RemainingCreditModelChild
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sms** | **double** | SMS Credits remaining for child account |
|
7 |
+
**email** | **double** | Email Credits remaining for child account |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RemainingCreditModelReseller.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RemainingCreditModelReseller
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sms** | **double** | SMS Credits remaining for reseller account |
|
7 |
+
**email** | **double** | Email Credits remaining for reseller account |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RemoveContactFromList.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RemoveContactFromList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**emails** | **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]
|
7 |
+
**ids** | **int[]** | 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]
|
8 |
+
**all** | **bool** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RemoveCredits.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RemoveCredits
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sms** | **int** | Required if email credits are empty. SMS credits to be removed from the child account | [optional]
|
7 |
+
**email** | **int** | Required if sms credits are empty. Email credits to be removed from the child account | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RequestContactExport.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RequestContactExport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**exportAttributes** | **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]
|
7 |
+
**customContactFilter** | [**\SendinBlue\Client\Model\RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | |
|
8 |
+
**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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RequestContactExportCustomContactFilter.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RequestContactExportCustomContactFilter
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**actionForContacts** | **string** | Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. | [optional]
|
7 |
+
**actionForEmailCampaigns** | **string** | Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). | [optional]
|
8 |
+
**actionForSmsCampaigns** | **string** | Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. | [optional]
|
9 |
+
**listId** | **int** | Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. | [optional]
|
10 |
+
**emailCampaignId** | **int** | Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. | [optional]
|
11 |
+
**smsCampaignId** | **int** | Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. | [optional]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RequestContactImport.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RequestContactImport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
**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]
|
8 |
+
**jsonBody** | [**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]
|
9 |
+
**listIds** | **int[]** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional]
|
10 |
+
**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]
|
11 |
+
**newList** | [**\SendinBlue\Client\Model\RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional]
|
12 |
+
**emailBlacklist** | **bool** | To blacklist all the contacts for email | [optional] [default to false]
|
13 |
+
**smsBlacklist** | **bool** | To blacklist all the contacts for sms | [optional] [default to false]
|
14 |
+
**updateExistingContacts** | **bool** | To facilitate the choice to update the existing contacts | [optional] [default to true]
|
15 |
+
**emptyContactsAttributes** | **bool** | 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] [default to false]
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RequestContactImportNewList.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RequestContactImportNewList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**listName** | **string** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional]
|
7 |
+
**folderId** | **int** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/RequestSmsRecipientExport.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# RequestSmsRecipientExport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
**recipientsType** | **string** | Filter the recipients based on how they interacted with the campaign |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendReport.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendReport
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**language** | **string** | Language of email content for campaign report sending. | [optional] [default to 'fr']
|
7 |
+
**email** | [**\SendinBlue\Client\Model\SendReportEmail**](SendReportEmail.md) | |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendReportEmail.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendReportEmail
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**to** | **string[]** | Email addresses of the recipients |
|
7 |
+
**body** | **string** | Custom text message to be presented in the report email. |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSms.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSms
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**reference** | **string** | |
|
7 |
+
**messageId** | **int** | |
|
8 |
+
**smsCount** | **int** | Count of SMS's to send multiple text messages | [optional]
|
9 |
+
**usedCredits** | **float** | SMS credits used per text message | [optional]
|
10 |
+
**remainingCredits** | **float** | Remaining SMS credits of the user | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmail.md
ADDED
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmail
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sender** | [**\SendinBlue\Client\Model\SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
|
7 |
+
**to** | [**\SendinBlue\Client\Model\SendSmtpEmailTo[]**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
|
8 |
+
**bcc** | [**\SendinBlue\Client\Model\SendSmtpEmailBcc[]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9 |
+
**cc** | [**\SendinBlue\Client\Model\SendSmtpEmailCc[]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10 |
+
**htmlContent** | **string** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
|
11 |
+
**textContent** | **string** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
|
12 |
+
**subject** | **string** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
|
13 |
+
**replyTo** | [**\SendinBlue\Client\Model\SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14 |
+
**attachment** | [**\SendinBlue\Client\Model\SendSmtpEmailAttachment[]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
15 |
+
**headers** | **object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
|
16 |
+
**templateId** | **int** | Id of the template. | [optional]
|
17 |
+
**params** | **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]
|
18 |
+
**messageVersions** | [**\SendinBlue\Client\Model\SendSmtpEmailMessageVersions[]**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional]
|
19 |
+
**tags** | **string[]** | Tag your emails to find them more easily | [optional]
|
20 |
+
**scheduledAt** | [**\DateTime**] | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
21 |
+
|
22 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
23 |
+
|
24 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailAttachment.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailAttachment
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**url** | **string** | Absolute url of the attachment (no local file). | [optional]
|
7 |
+
**content** | **string** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
|
8 |
+
**name** | **string** | Required if content is passed. Name of the attachment | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailBcc.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailBcc
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the recipient in bcc |
|
7 |
+
**name** | **string** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailCc.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailCc
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the recipient in cc |
|
7 |
+
**name** | **string** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailMessageVersions.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailMessageVersions
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**to** | [**\SendinBlue\Client\Model\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\"}] |
|
7 |
+
**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]
|
8 |
+
**bcc** | [**\SendinBlue\Client\Model\SendSmtpEmailBcc[]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9 |
+
**cc** | [**\SendinBlue\Client\Model\SendSmtpEmailCc[]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10 |
+
**replyTo** | [**\SendinBlue\Client\Model\SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional]
|
11 |
+
**subject** | **string** | Custom subject specific to message version | [optional]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailReplyTo.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailReplyTo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address in reply to |
|
7 |
+
**name** | **string** | Name in reply to. Maximum allowed characters are 70. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailReplyTo1.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailReplyTo1
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address in reply to |
|
7 |
+
**name** | **string** | Name in reply to. Maximum allowed characters are 70. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
**email** | **string** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional]
|
8 |
+
**id** | **int** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailTo.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailTo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the recipient |
|
7 |
+
**name** | **string** | Name of the recipient. Maximum allowed characters are 70. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendSmtpEmailTo1.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendSmtpEmailTo1
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | Email address of the recipient |
|
7 |
+
**name** | **string** | Name of the recipient. **Maximum allowed characters are 70**. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendTestEmail.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendTestEmail
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**emailTo** | **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]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendTestSms.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendTestSms
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SendTransacSms.md
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SendTransacSms
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
|
7 |
+
**recipient** | **string** | Mobile number to send SMS with the country code |
|
8 |
+
**content** | **string** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
|
9 |
+
**type** | **string** | 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] [default to 'transactional']
|
10 |
+
**tag** | **string** | Tag of the message | [optional]
|
11 |
+
**webUrl** | **string** | Webhook to call for each event triggered by the message (delivered etc.) | [optional]
|
12 |
+
**unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
|
13 |
+
|
14 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
15 |
+
|
16 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SsoTokenRequest.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SsoTokenRequest
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | Id of the sub-account organization |
|
7 |
+
**email** | **string** | User email of sub-account organization | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponse.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponse
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the sub-account user | [optional]
|
7 |
+
**email** | **string** | Email id of the sub-account organization | [optional]
|
8 |
+
**companyName** | **string** | Sub-account company name | [optional]
|
9 |
+
**planInfo** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) | | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfo.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfo
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**credits** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfoCredits**](SubAccountDetailsResponsePlanInfoCredits.md) | | [optional]
|
7 |
+
**features** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) | | [optional]
|
8 |
+
**planType** | **string** | type of the plan | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoCredits.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfoCredits
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**sms** | **int** | SMS credits remaining on the sub-account | [optional]
|
7 |
+
**emails** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfoCreditsEmails
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**quantity** | **int** | Quantity of email messaging limits provided | [optional]
|
7 |
+
**remaining** | **int** | Available email messaging limits for use | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfoFeatures
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**inbox** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesInbox**](SubAccountDetailsResponsePlanInfoFeaturesInbox.md) | | [optional]
|
7 |
+
**landingPage** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) | | [optional]
|
8 |
+
**users** | [**\SendinBlue\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesUsers.md) | | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfoFeaturesInbox
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**quantity** | **int** | Quantity of inbox provided | [optional]
|
7 |
+
**remaining** | **int** | Available inboxes for use | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfoFeaturesLandingPage
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**quantity** | **int** | Quantity of landing pages provided | [optional]
|
7 |
+
**remaining** | **int** | Available landing pages for use | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountDetailsResponsePlanInfoFeaturesUsers
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**quantity** | **int** | Quantity of multi-account's provided | [optional]
|
7 |
+
**remaining** | **int** | Available multi-accounts for use | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountUpdatePlanRequest.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountUpdatePlanRequest
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**credits** | [**\SendinBlue\Client\Model\SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) | | [optional]
|
7 |
+
**features** | [**\SendinBlue\Client\Model\SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountUpdatePlanRequestCredits.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountUpdatePlanRequestCredits
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **int** | Number of email credits | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountUpdatePlanRequestFeatures.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountUpdatePlanRequestFeatures
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**users** | **int** | Number of multi-users | [optional]
|
7 |
+
**landingPage** | **int** | Number of landing pages | [optional]
|
8 |
+
**inbox** | **int** | Number of inboxes | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountsResponse.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountsResponse
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**count** | **int** | Total number of subaccounts | [optional]
|
7 |
+
**subAccounts** | [**\SendinBlue\Client\Model\SubAccountsResponseSubAccounts[]**](SubAccountsResponseSubAccounts.md) | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/SubAccountsResponseSubAccounts.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# SubAccountsResponseSubAccounts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **int** | id of the sub-account |
|
7 |
+
**companyName** | **string** | Name of the sub-account company |
|
8 |
+
**active** | **bool** | Whether the sub-account is active or not |
|
9 |
+
**createdAt** | **int** | Timestamp when the sub-account was created |
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/Task.md
ADDED
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Task
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**firstContact** | [**\SendinBlue\Client\Model\Contact**](Contact.md) | | [optional]
|
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** | **int[]** | Contact ids for contacts linked to this task | [optional]
|
11 |
+
**contacts** | [**\SendinBlue\Client\Model\Contact[]**](Contact.md) | Contact details for contacts linked to this task | [optional]
|
12 |
+
**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional]
|
13 |
+
**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional]
|
14 |
+
**assignToId** | **string** | User id to whom task is assigned | [optional]
|
15 |
+
**date** | [**\DateTime**] | Task date/time |
|
16 |
+
**duration** | **int** | Duration of task | [optional]
|
17 |
+
**notes** | **string** | Notes added to a task | [optional]
|
18 |
+
**done** | **bool** | Task marked as done | [optional]
|
19 |
+
**reminder** | [**\SendinBlue\Client\Model\TaskReminder**](TaskReminder.md) | Task reminder date/time for a task | [optional]
|
20 |
+
**createdAt** | [**\DateTime**] | Task created date/time | [optional]
|
21 |
+
**updatedAt** | [**\DateTime**] | Task update date/time | [optional]
|
22 |
+
**refs** | **object** | | [optional]
|
23 |
+
|
24 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
25 |
+
|
26 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/TaskReminder.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# TaskReminder
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**value** | **int** | Value of time unit before reminder is to be sent |
|
7 |
+
**unit** | **string** | Unit of time before reminder is to be sent |
|
8 |
+
**types** | **string[]** | Type of task reminder e.g email, push |
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/TaskTypes.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# TaskTypes
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**id** | **string** | Id of task type | [optional]
|
7 |
+
**icon** | **string** | Icon of task type | [optional]
|
8 |
+
**title** | **string** | Title of task type | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateAttribute.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateAttribute
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**value** | **string** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
7 |
+
**enumeration** | [**\SendinBlue\Client\Model\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]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateAttributeEnumeration.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateAttributeEnumeration
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**value** | **int** | Id of the value |
|
7 |
+
**label** | **string** | Label of the value |
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateBatchContacts.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateBatchContacts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**contacts** | [**\SendinBlue\Client\Model\UpdateBatchContactsContacts[]**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateBatchContactsContacts.md
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateBatchContactsContacts
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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]
|
7 |
+
**id** | **int** | id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional]
|
8 |
+
**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]
|
9 |
+
**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]
|
10 |
+
**emailBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
|
11 |
+
**smsBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
|
12 |
+
**listIds** | **int[]** | Ids of the lists to add the contact to | [optional]
|
13 |
+
**unlinkListIds** | **int[]** | Ids of the lists to remove the contact from | [optional]
|
14 |
+
**smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact | [optional]
|
15 |
+
|
16 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
17 |
+
|
18 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateBatchContactsModel.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateBatchContactsModel
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**successIds** | **int[]** | | [optional]
|
7 |
+
**failureIds** | **int[]** | | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateCampaignStatus.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateCampaignStatus
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**status** | **string** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateChild.md
ADDED
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateChild
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**email** | **string** | New Email address to update the child account | [optional]
|
7 |
+
**firstName** | **string** | New First name to use to update the child account | [optional]
|
8 |
+
**lastName** | **string** | New Last name to use to update the child account | [optional]
|
9 |
+
**companyName** | **string** | New Company name to use to update the child account | [optional]
|
10 |
+
**password** | **string** | New password for the child account to login | [optional]
|
11 |
+
|
12 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
13 |
+
|
14 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateChildAccountStatus.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateChildAccountStatus
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**transactionalEmail** | **bool** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional]
|
7 |
+
**transactionalSms** | **bool** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional]
|
8 |
+
**marketingAutomation** | **bool** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional]
|
9 |
+
**smsCampaign** | **bool** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateChildDomain.md
ADDED
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateChildDomain
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**domain** | **string** | Value for the sender domain that will replace the existing domain | [optional]
|
7 |
+
|
8 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
9 |
+
|
10 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateContact.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateContact
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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 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]
|
7 |
+
**emailBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
|
8 |
+
**smsBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
|
9 |
+
**listIds** | **int[]** | Ids of the lists to add the contact to | [optional]
|
10 |
+
**unlinkListIds** | **int[]** | Ids of the lists to remove the contact from | [optional]
|
11 |
+
**smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact | [optional]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateEmailCampaign.md
ADDED
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateEmailCampaign
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**tag** | **string** | Tag of the campaign | [optional]
|
7 |
+
**sender** | [**\SendinBlue\Client\Model\UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) | | [optional]
|
8 |
+
**name** | **string** | Name of the campaign | [optional]
|
9 |
+
**htmlContent** | **string** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional]
|
10 |
+
**htmlUrl** | **string** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
12 |
+
**subject** | **string** | Subject of the campaign | [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 |
+
**recipients** | [**\SendinBlue\Client\Model\UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional]
|
16 |
+
**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]
|
17 |
+
**inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
|
18 |
+
**mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
19 |
+
**recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false]
|
20 |
+
**footer** | **string** | Footer of the email campaign | [optional]
|
21 |
+
**header** | **string** | Header of the email campaign | [optional]
|
22 |
+
**utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
|
23 |
+
**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
|
24 |
+
**sendAtBestTime** | **bool** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional]
|
25 |
+
**abTesting** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
|
26 |
+
**subjectA** | **string** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
27 |
+
**subjectB** | **string** | Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
28 |
+
**splitRule** | **int** | Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
|
29 |
+
**winnerCriteria** | **string** | Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record | [optional]
|
30 |
+
**winnerDelay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record | [optional]
|
31 |
+
**ipWarmupEnable** | **bool** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
|
32 |
+
**initialQuota** | **int** | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
|
33 |
+
**increaseRate** | **int** | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
|
34 |
+
|
35 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
36 |
+
|
37 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateEmailCampaignRecipients.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateEmailCampaignRecipients
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [optional]
|
7 |
+
**listIds** | **int[]** | Lists Ids to send the campaign to. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateEmailCampaignSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateEmailCampaignSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Sender Name from which the campaign emails are sent | [optional]
|
7 |
+
**email** | **string** | Sender email from which the campaign emails are sent | [optional]
|
8 |
+
**id** | **int** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateList.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateList
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional]
|
7 |
+
**folderId** | **int** | 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]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | From Name to update the sender | [optional]
|
7 |
+
**email** | **string** | From Email to update the sender | [optional]
|
8 |
+
**ips** | [**\SendinBlue\Client\Model\CreateSenderIps[]**](CreateSenderIps.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateSmsCampaign.md
ADDED
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateSmsCampaign
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the campaign | [optional]
|
7 |
+
**sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional]
|
8 |
+
**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]
|
9 |
+
**recipients** | [**\SendinBlue\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10 |
+
**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]
|
11 |
+
**unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
|
12 |
+
|
13 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
14 |
+
|
15 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateSmtpTemplate.md
ADDED
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateSmtpTemplate
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**tag** | **string** | Tag of the template | [optional]
|
7 |
+
**sender** | [**\SendinBlue\Client\Model\UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional]
|
8 |
+
**templateName** | **string** | Name of the template | [optional]
|
9 |
+
**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]
|
10 |
+
**htmlUrl** | **string** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional]
|
11 |
+
**subject** | **string** | Subject of the email | [optional]
|
12 |
+
**replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional]
|
13 |
+
**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]
|
14 |
+
**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]
|
15 |
+
**isActive** | **bool** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional]
|
16 |
+
|
17 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
18 |
+
|
19 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateSmtpTemplateSender.md
ADDED
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateSmtpTemplateSender
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**name** | **string** | Name of the sender | [optional]
|
7 |
+
**email** | **string** | Email of the sender | [optional]
|
8 |
+
**id** | **int** | 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]
|
9 |
+
|
10 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
11 |
+
|
12 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UpdateWebhook.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UpdateWebhook
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**url** | **string** | URL of the webhook | [optional]
|
7 |
+
**description** | **string** | Description of the webhook | [optional]
|
8 |
+
**events** | **string[]** | - 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]
|
9 |
+
**domain** | **string** | Inbound domain of webhook, used in case of event type `inbound` | [optional]
|
10 |
+
|
11 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
12 |
+
|
13 |
+
|
Postman/Postman-Mail/sendinblue/docs/Model/UploadImageToGallery.md
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# UploadImageToGallery
|
2 |
+
|
3 |
+
## Properties
|
4 |
+
Name | Type | Description | Notes
|
5 |
+
------------ | ------------- | ------------- | -------------
|
6 |
+
**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. |
|
7 |
+
**name** | **string** | Name of the image. | [optional]
|
8 |
+
|
9 |
+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
10 |
+
|
11 |
+
|
Postman/Postman-Mail/sendinblue/lib/Api/AccountApi.php
ADDED
@@ -0,0 +1,368 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
/**
|
3 |
+
* AccountApi
|
4 |
+
* PHP version 5
|
5 |
+
*
|
6 |
+
* @category Class
|
7 |
+
* @package SendinBlue\Client
|
8 |
+
* @author Swagger Codegen team
|
9 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
10 |
+
*/
|
11 |
+
|
12 |
+
/**
|
13 |
+
* SendinBlue API
|
14 |
+
*
|
15 |
+
* 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 |
|
16 |
+
*
|
17 |
+
* OpenAPI spec version: 3.0.0
|
18 |
+
* Contact: contact@sendinblue.com
|
19 |
+
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
20 |
+
* Swagger Codegen version: 2.4.12
|
21 |
+
*/
|
22 |
+
|
23 |
+
/**
|
24 |
+
* NOTE: This class is auto generated by the swagger code generator program.
|
25 |
+
* https://github.com/swagger-api/swagger-codegen
|
26 |
+
* Do not edit the class manually.
|
27 |
+
*/
|
28 |
+
|
29 |
+
namespace SendinBlue\Client\Api;
|
30 |
+
|
31 |
+
use GuzzleHttp\Client;
|
32 |
+
use GuzzleHttp\ClientInterface;
|
33 |
+
use GuzzleHttp\Exception\RequestException;
|
34 |
+
use GuzzleHttp\Psr7\MultipartStream;
|
35 |
+
use GuzzleHttp\Psr7\Request;
|
36 |
+
use GuzzleHttp\RequestOptions;
|
37 |
+
use SendinBlue\Client\ApiException;
|
38 |
+
use SendinBlue\Client\Configuration;
|
39 |
+
use SendinBlue\Client\HeaderSelector;
|
40 |
+
use SendinBlue\Client\ObjectSerializer;
|
41 |
+
|
42 |
+
/**
|
43 |
+
* AccountApi Class Doc Comment
|
44 |
+
*
|
45 |
+
* @category Class
|
46 |
+
* @package SendinBlue\Client
|
47 |
+
* @author Swagger Codegen team
|
48 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
49 |
+
*/
|
50 |
+
class AccountApi
|
51 |
+
{
|
52 |
+
/**
|
53 |
+
* @var ClientInterface
|
54 |
+
*/
|
55 |
+
protected $client;
|
56 |
+
|
57 |
+
/**
|
58 |
+
* @var Configuration
|
59 |
+
*/
|
60 |
+
protected $config;
|
61 |
+
|
62 |
+
/**
|
63 |
+
* @var HeaderSelector
|
64 |
+
*/
|
65 |
+
protected $headerSelector;
|
66 |
+
|
67 |
+
/**
|
68 |
+
* @param ClientInterface $client
|
69 |
+
* @param Configuration $config
|
70 |
+
* @param HeaderSelector $selector
|
71 |
+
*/
|
72 |
+
public function __construct(
|
73 |
+
ClientInterface $client = null,
|
74 |
+
Configuration $config = null,
|
75 |
+
HeaderSelector $selector = null
|
76 |
+
) {
|
77 |
+
$this->client = $client ?: new Client();
|
78 |
+
$this->config = $config ?: new Configuration();
|
79 |
+
$this->headerSelector = $selector ?: new HeaderSelector();
|
80 |
+
}
|
81 |
+
|
82 |
+
/**
|
83 |
+
* @return Configuration
|
84 |
+
*/
|
85 |
+
public function getConfig()
|
86 |
+
{
|
87 |
+
return $this->config;
|
88 |
+
}
|
89 |
+
|
90 |
+
/**
|
91 |
+
* Operation getAccount
|
92 |
+
*
|
93 |
+
* Get your account information, plan and credits details
|
94 |
+
*
|
95 |
+
*
|
96 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
97 |
+
* @throws \InvalidArgumentException
|
98 |
+
* @return \SendinBlue\Client\Model\GetAccount
|
99 |
+
*/
|
100 |
+
public function getAccount()
|
101 |
+
{
|
102 |
+
list($response) = $this->getAccountWithHttpInfo();
|
103 |
+
return $response;
|
104 |
+
}
|
105 |
+
|
106 |
+
/**
|
107 |
+
* Operation getAccountWithHttpInfo
|
108 |
+
*
|
109 |
+
* Get your account information, plan and credits details
|
110 |
+
*
|
111 |
+
*
|
112 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
113 |
+
* @throws \InvalidArgumentException
|
114 |
+
* @return array of \SendinBlue\Client\Model\GetAccount, HTTP status code, HTTP response headers (array of strings)
|
115 |
+
*/
|
116 |
+
public function getAccountWithHttpInfo()
|
117 |
+
{
|
118 |
+
$returnType = '\SendinBlue\Client\Model\GetAccount';
|
119 |
+
$request = $this->getAccountRequest();
|
120 |
+
|
121 |
+
try {
|
122 |
+
$options = $this->createHttpClientOption();
|
123 |
+
try {
|
124 |
+
$response = $this->client->send($request, $options);
|
125 |
+
} catch (RequestException $e) {
|
126 |
+
throw new ApiException(
|
127 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
128 |
+
$e->getCode(),
|
129 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
130 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
131 |
+
);
|
132 |
+
}
|
133 |
+
|
134 |
+
$statusCode = $response->getStatusCode();
|
135 |
+
|
136 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
137 |
+
throw new ApiException(
|
138 |
+
sprintf(
|
139 |
+
'[%d] Error connecting to the API (%s)',
|
140 |
+
$statusCode,
|
141 |
+
$request->getUri()
|
142 |
+
),
|
143 |
+
$statusCode,
|
144 |
+
$response->getHeaders(),
|
145 |
+
$response->getBody()
|
146 |
+
);
|
147 |
+
}
|
148 |
+
|
149 |
+
$responseBody = $response->getBody();
|
150 |
+
if ($returnType === '\SplFileObject') {
|
151 |
+
$content = $responseBody; //stream goes to serializer
|
152 |
+
} else {
|
153 |
+
$content = $responseBody->getContents();
|
154 |
+
if ($returnType !== 'string') {
|
155 |
+
$content = json_decode($content);
|
156 |
+
}
|
157 |
+
}
|
158 |
+
|
159 |
+
return [
|
160 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
161 |
+
$response->getStatusCode(),
|
162 |
+
$response->getHeaders()
|
163 |
+
];
|
164 |
+
|
165 |
+
} catch (ApiException $e) {
|
166 |
+
switch ($e->getCode()) {
|
167 |
+
case 200:
|
168 |
+
$data = ObjectSerializer::deserialize(
|
169 |
+
$e->getResponseBody(),
|
170 |
+
'\SendinBlue\Client\Model\GetAccount',
|
171 |
+
$e->getResponseHeaders()
|
172 |
+
);
|
173 |
+
$e->setResponseObject($data);
|
174 |
+
break;
|
175 |
+
}
|
176 |
+
throw $e;
|
177 |
+
}
|
178 |
+
}
|
179 |
+
|
180 |
+
/**
|
181 |
+
* Operation getAccountAsync
|
182 |
+
*
|
183 |
+
* Get your account information, plan and credits details
|
184 |
+
*
|
185 |
+
*
|
186 |
+
* @throws \InvalidArgumentException
|
187 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
188 |
+
*/
|
189 |
+
public function getAccountAsync()
|
190 |
+
{
|
191 |
+
return $this->getAccountAsyncWithHttpInfo()
|
192 |
+
->then(
|
193 |
+
function ($response) {
|
194 |
+
return $response[0];
|
195 |
+
}
|
196 |
+
);
|
197 |
+
}
|
198 |
+
|
199 |
+
/**
|
200 |
+
* Operation getAccountAsyncWithHttpInfo
|
201 |
+
*
|
202 |
+
* Get your account information, plan and credits details
|
203 |
+
*
|
204 |
+
*
|
205 |
+
* @throws \InvalidArgumentException
|
206 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
207 |
+
*/
|
208 |
+
public function getAccountAsyncWithHttpInfo()
|
209 |
+
{
|
210 |
+
$returnType = '\SendinBlue\Client\Model\GetAccount';
|
211 |
+
$request = $this->getAccountRequest();
|
212 |
+
|
213 |
+
return $this->client
|
214 |
+
->sendAsync($request, $this->createHttpClientOption())
|
215 |
+
->then(
|
216 |
+
function ($response) use ($returnType) {
|
217 |
+
$responseBody = $response->getBody();
|
218 |
+
if ($returnType === '\SplFileObject') {
|
219 |
+
$content = $responseBody; //stream goes to serializer
|
220 |
+
} else {
|
221 |
+
$content = $responseBody->getContents();
|
222 |
+
if ($returnType !== 'string') {
|
223 |
+
$content = json_decode($content);
|
224 |
+
}
|
225 |
+
}
|
226 |
+
|
227 |
+
return [
|
228 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
229 |
+
$response->getStatusCode(),
|
230 |
+
$response->getHeaders()
|
231 |
+
];
|
232 |
+
},
|
233 |
+
function ($exception) {
|
234 |
+
$response = $exception->getResponse();
|
235 |
+
$statusCode = $response->getStatusCode();
|
236 |
+
throw new ApiException(
|
237 |
+
sprintf(
|
238 |
+
'[%d] Error connecting to the API (%s)',
|
239 |
+
$statusCode,
|
240 |
+
$exception->getRequest()->getUri()
|
241 |
+
),
|
242 |
+
$statusCode,
|
243 |
+
$response->getHeaders(),
|
244 |
+
$response->getBody()
|
245 |
+
);
|
246 |
+
}
|
247 |
+
);
|
248 |
+
}
|
249 |
+
|
250 |
+
/**
|
251 |
+
* Create request for operation 'getAccount'
|
252 |
+
*
|
253 |
+
*
|
254 |
+
* @throws \InvalidArgumentException
|
255 |
+
* @return \GuzzleHttp\Psr7\Request
|
256 |
+
*/
|
257 |
+
protected function getAccountRequest()
|
258 |
+
{
|
259 |
+
|
260 |
+
$resourcePath = '/account';
|
261 |
+
$formParams = [];
|
262 |
+
$queryParams = [];
|
263 |
+
$headerParams = [];
|
264 |
+
$httpBody = '';
|
265 |
+
$multipart = false;
|
266 |
+
|
267 |
+
|
268 |
+
|
269 |
+
// body params
|
270 |
+
$_tempBody = null;
|
271 |
+
|
272 |
+
if ($multipart) {
|
273 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
274 |
+
['application/json']
|
275 |
+
);
|
276 |
+
} else {
|
277 |
+
$headers = $this->headerSelector->selectHeaders(
|
278 |
+
['application/json'],
|
279 |
+
['application/json']
|
280 |
+
);
|
281 |
+
}
|
282 |
+
|
283 |
+
// for model (json/xml)
|
284 |
+
if (isset($_tempBody)) {
|
285 |
+
// $_tempBody is the method argument, if present
|
286 |
+
$httpBody = $_tempBody;
|
287 |
+
|
288 |
+
if($headers['Content-Type'] === 'application/json') {
|
289 |
+
// \stdClass has no __toString(), so we should encode it manually
|
290 |
+
if ($httpBody instanceof \stdClass) {
|
291 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
292 |
+
}
|
293 |
+
// array has no __toString(), so we should encode it manually
|
294 |
+
if(is_array($httpBody)) {
|
295 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
296 |
+
}
|
297 |
+
}
|
298 |
+
} elseif (count($formParams) > 0) {
|
299 |
+
if ($multipart) {
|
300 |
+
$multipartContents = [];
|
301 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
302 |
+
$multipartContents[] = [
|
303 |
+
'name' => $formParamName,
|
304 |
+
'contents' => $formParamValue
|
305 |
+
];
|
306 |
+
}
|
307 |
+
// for HTTP post (form)
|
308 |
+
$httpBody = new MultipartStream($multipartContents);
|
309 |
+
|
310 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
311 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
312 |
+
|
313 |
+
} else {
|
314 |
+
// for HTTP post (form)
|
315 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
316 |
+
}
|
317 |
+
}
|
318 |
+
|
319 |
+
// this endpoint requires API key authentication
|
320 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
321 |
+
if ($apiKey !== null) {
|
322 |
+
$headers['api-key'] = $apiKey;
|
323 |
+
}
|
324 |
+
// this endpoint requires API key authentication
|
325 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
326 |
+
if ($apiKey !== null) {
|
327 |
+
$headers['partner-key'] = $apiKey;
|
328 |
+
}
|
329 |
+
|
330 |
+
$defaultHeaders = [];
|
331 |
+
if ($this->config->getUserAgent()) {
|
332 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
333 |
+
}
|
334 |
+
|
335 |
+
$headers = array_merge(
|
336 |
+
$defaultHeaders,
|
337 |
+
$headerParams,
|
338 |
+
$headers
|
339 |
+
);
|
340 |
+
|
341 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
342 |
+
return new Request(
|
343 |
+
'GET',
|
344 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
345 |
+
$headers,
|
346 |
+
$httpBody
|
347 |
+
);
|
348 |
+
}
|
349 |
+
|
350 |
+
/**
|
351 |
+
* Create http client option
|
352 |
+
*
|
353 |
+
* @throws \RuntimeException on file opening failure
|
354 |
+
* @return array of http client options
|
355 |
+
*/
|
356 |
+
protected function createHttpClientOption()
|
357 |
+
{
|
358 |
+
$options = [];
|
359 |
+
if ($this->config->getDebug()) {
|
360 |
+
$options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
|
361 |
+
if (!$options[RequestOptions::DEBUG]) {
|
362 |
+
throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile());
|
363 |
+
}
|
364 |
+
}
|
365 |
+
|
366 |
+
return $options;
|
367 |
+
}
|
368 |
+
}
|
Postman/Postman-Mail/sendinblue/lib/Api/AttributesApi.php
ADDED
@@ -0,0 +1,1219 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
/**
|
3 |
+
* AttributesApi
|
4 |
+
* PHP version 5
|
5 |
+
*
|
6 |
+
* @category Class
|
7 |
+
* @package SendinBlue\Client
|
8 |
+
* @author Swagger Codegen team
|
9 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
10 |
+
*/
|
11 |
+
|
12 |
+
/**
|
13 |
+
* SendinBlue API
|
14 |
+
*
|
15 |
+
* 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 |
|
16 |
+
*
|
17 |
+
* OpenAPI spec version: 3.0.0
|
18 |
+
* Contact: contact@sendinblue.com
|
19 |
+
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
20 |
+
* Swagger Codegen version: 2.4.12
|
21 |
+
*/
|
22 |
+
|
23 |
+
/**
|
24 |
+
* NOTE: This class is auto generated by the swagger code generator program.
|
25 |
+
* https://github.com/swagger-api/swagger-codegen
|
26 |
+
* Do not edit the class manually.
|
27 |
+
*/
|
28 |
+
|
29 |
+
namespace SendinBlue\Client\Api;
|
30 |
+
|
31 |
+
use GuzzleHttp\Client;
|
32 |
+
use GuzzleHttp\ClientInterface;
|
33 |
+
use GuzzleHttp\Exception\RequestException;
|
34 |
+
use GuzzleHttp\Psr7\MultipartStream;
|
35 |
+
use GuzzleHttp\Psr7\Request;
|
36 |
+
use GuzzleHttp\RequestOptions;
|
37 |
+
use SendinBlue\Client\ApiException;
|
38 |
+
use SendinBlue\Client\Configuration;
|
39 |
+
use SendinBlue\Client\HeaderSelector;
|
40 |
+
use SendinBlue\Client\ObjectSerializer;
|
41 |
+
|
42 |
+
/**
|
43 |
+
* AttributesApi Class Doc Comment
|
44 |
+
*
|
45 |
+
* @category Class
|
46 |
+
* @package SendinBlue\Client
|
47 |
+
* @author Swagger Codegen team
|
48 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
49 |
+
*/
|
50 |
+
class AttributesApi
|
51 |
+
{
|
52 |
+
/**
|
53 |
+
* @var ClientInterface
|
54 |
+
*/
|
55 |
+
protected $client;
|
56 |
+
|
57 |
+
/**
|
58 |
+
* @var Configuration
|
59 |
+
*/
|
60 |
+
protected $config;
|
61 |
+
|
62 |
+
/**
|
63 |
+
* @var HeaderSelector
|
64 |
+
*/
|
65 |
+
protected $headerSelector;
|
66 |
+
|
67 |
+
/**
|
68 |
+
* @param ClientInterface $client
|
69 |
+
* @param Configuration $config
|
70 |
+
* @param HeaderSelector $selector
|
71 |
+
*/
|
72 |
+
public function __construct(
|
73 |
+
ClientInterface $client = null,
|
74 |
+
Configuration $config = null,
|
75 |
+
HeaderSelector $selector = null
|
76 |
+
) {
|
77 |
+
$this->client = $client ?: new Client();
|
78 |
+
$this->config = $config ?: new Configuration();
|
79 |
+
$this->headerSelector = $selector ?: new HeaderSelector();
|
80 |
+
}
|
81 |
+
|
82 |
+
/**
|
83 |
+
* @return Configuration
|
84 |
+
*/
|
85 |
+
public function getConfig()
|
86 |
+
{
|
87 |
+
return $this->config;
|
88 |
+
}
|
89 |
+
|
90 |
+
/**
|
91 |
+
* Operation createAttribute
|
92 |
+
*
|
93 |
+
* Create contact attribute
|
94 |
+
*
|
95 |
+
* @param string $attributeCategory Category of the attribute (required)
|
96 |
+
* @param string $attributeName Name of the attribute (required)
|
97 |
+
* @param \SendinBlue\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required)
|
98 |
+
*
|
99 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
100 |
+
* @throws \InvalidArgumentException
|
101 |
+
* @return void
|
102 |
+
*/
|
103 |
+
public function createAttribute($attributeCategory, $attributeName, $createAttribute)
|
104 |
+
{
|
105 |
+
$this->createAttributeWithHttpInfo($attributeCategory, $attributeName, $createAttribute);
|
106 |
+
}
|
107 |
+
|
108 |
+
/**
|
109 |
+
* Operation createAttributeWithHttpInfo
|
110 |
+
*
|
111 |
+
* Create contact attribute
|
112 |
+
*
|
113 |
+
* @param string $attributeCategory Category of the attribute (required)
|
114 |
+
* @param string $attributeName Name of the attribute (required)
|
115 |
+
* @param \SendinBlue\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required)
|
116 |
+
*
|
117 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
118 |
+
* @throws \InvalidArgumentException
|
119 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
120 |
+
*/
|
121 |
+
public function createAttributeWithHttpInfo($attributeCategory, $attributeName, $createAttribute)
|
122 |
+
{
|
123 |
+
$returnType = '';
|
124 |
+
$request = $this->createAttributeRequest($attributeCategory, $attributeName, $createAttribute);
|
125 |
+
|
126 |
+
try {
|
127 |
+
$options = $this->createHttpClientOption();
|
128 |
+
try {
|
129 |
+
$response = $this->client->send($request, $options);
|
130 |
+
} catch (RequestException $e) {
|
131 |
+
throw new ApiException(
|
132 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
133 |
+
$e->getCode(),
|
134 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
135 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
136 |
+
);
|
137 |
+
}
|
138 |
+
|
139 |
+
$statusCode = $response->getStatusCode();
|
140 |
+
|
141 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
142 |
+
throw new ApiException(
|
143 |
+
sprintf(
|
144 |
+
'[%d] Error connecting to the API (%s)',
|
145 |
+
$statusCode,
|
146 |
+
$request->getUri()
|
147 |
+
),
|
148 |
+
$statusCode,
|
149 |
+
$response->getHeaders(),
|
150 |
+
$response->getBody()
|
151 |
+
);
|
152 |
+
}
|
153 |
+
|
154 |
+
return [null, $statusCode, $response->getHeaders()];
|
155 |
+
|
156 |
+
} catch (ApiException $e) {
|
157 |
+
switch ($e->getCode()) {
|
158 |
+
case 400:
|
159 |
+
$data = ObjectSerializer::deserialize(
|
160 |
+
$e->getResponseBody(),
|
161 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
162 |
+
$e->getResponseHeaders()
|
163 |
+
);
|
164 |
+
$e->setResponseObject($data);
|
165 |
+
break;
|
166 |
+
}
|
167 |
+
throw $e;
|
168 |
+
}
|
169 |
+
}
|
170 |
+
|
171 |
+
/**
|
172 |
+
* Operation createAttributeAsync
|
173 |
+
*
|
174 |
+
* Create contact attribute
|
175 |
+
*
|
176 |
+
* @param string $attributeCategory Category of the attribute (required)
|
177 |
+
* @param string $attributeName Name of the attribute (required)
|
178 |
+
* @param \SendinBlue\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required)
|
179 |
+
*
|
180 |
+
* @throws \InvalidArgumentException
|
181 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
182 |
+
*/
|
183 |
+
public function createAttributeAsync($attributeCategory, $attributeName, $createAttribute)
|
184 |
+
{
|
185 |
+
return $this->createAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $createAttribute)
|
186 |
+
->then(
|
187 |
+
function ($response) {
|
188 |
+
return $response[0];
|
189 |
+
}
|
190 |
+
);
|
191 |
+
}
|
192 |
+
|
193 |
+
/**
|
194 |
+
* Operation createAttributeAsyncWithHttpInfo
|
195 |
+
*
|
196 |
+
* Create contact attribute
|
197 |
+
*
|
198 |
+
* @param string $attributeCategory Category of the attribute (required)
|
199 |
+
* @param string $attributeName Name of the attribute (required)
|
200 |
+
* @param \SendinBlue\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required)
|
201 |
+
*
|
202 |
+
* @throws \InvalidArgumentException
|
203 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
204 |
+
*/
|
205 |
+
public function createAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $createAttribute)
|
206 |
+
{
|
207 |
+
$returnType = '';
|
208 |
+
$request = $this->createAttributeRequest($attributeCategory, $attributeName, $createAttribute);
|
209 |
+
|
210 |
+
return $this->client
|
211 |
+
->sendAsync($request, $this->createHttpClientOption())
|
212 |
+
->then(
|
213 |
+
function ($response) use ($returnType) {
|
214 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
215 |
+
},
|
216 |
+
function ($exception) {
|
217 |
+
$response = $exception->getResponse();
|
218 |
+
$statusCode = $response->getStatusCode();
|
219 |
+
throw new ApiException(
|
220 |
+
sprintf(
|
221 |
+
'[%d] Error connecting to the API (%s)',
|
222 |
+
$statusCode,
|
223 |
+
$exception->getRequest()->getUri()
|
224 |
+
),
|
225 |
+
$statusCode,
|
226 |
+
$response->getHeaders(),
|
227 |
+
$response->getBody()
|
228 |
+
);
|
229 |
+
}
|
230 |
+
);
|
231 |
+
}
|
232 |
+
|
233 |
+
/**
|
234 |
+
* Create request for operation 'createAttribute'
|
235 |
+
*
|
236 |
+
* @param string $attributeCategory Category of the attribute (required)
|
237 |
+
* @param string $attributeName Name of the attribute (required)
|
238 |
+
* @param \SendinBlue\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required)
|
239 |
+
*
|
240 |
+
* @throws \InvalidArgumentException
|
241 |
+
* @return \GuzzleHttp\Psr7\Request
|
242 |
+
*/
|
243 |
+
protected function createAttributeRequest($attributeCategory, $attributeName, $createAttribute)
|
244 |
+
{
|
245 |
+
// verify the required parameter 'attributeCategory' is set
|
246 |
+
if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) {
|
247 |
+
throw new \InvalidArgumentException(
|
248 |
+
'Missing the required parameter $attributeCategory when calling createAttribute'
|
249 |
+
);
|
250 |
+
}
|
251 |
+
// verify the required parameter 'attributeName' is set
|
252 |
+
if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) {
|
253 |
+
throw new \InvalidArgumentException(
|
254 |
+
'Missing the required parameter $attributeName when calling createAttribute'
|
255 |
+
);
|
256 |
+
}
|
257 |
+
// verify the required parameter 'createAttribute' is set
|
258 |
+
if ($createAttribute === null || (is_array($createAttribute) && count($createAttribute) === 0)) {
|
259 |
+
throw new \InvalidArgumentException(
|
260 |
+
'Missing the required parameter $createAttribute when calling createAttribute'
|
261 |
+
);
|
262 |
+
}
|
263 |
+
|
264 |
+
$resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}';
|
265 |
+
$formParams = [];
|
266 |
+
$queryParams = [];
|
267 |
+
$headerParams = [];
|
268 |
+
$httpBody = '';
|
269 |
+
$multipart = false;
|
270 |
+
|
271 |
+
|
272 |
+
// path params
|
273 |
+
if ($attributeCategory !== null) {
|
274 |
+
$resourcePath = str_replace(
|
275 |
+
'{' . 'attributeCategory' . '}',
|
276 |
+
ObjectSerializer::toPathValue($attributeCategory),
|
277 |
+
$resourcePath
|
278 |
+
);
|
279 |
+
}
|
280 |
+
// path params
|
281 |
+
if ($attributeName !== null) {
|
282 |
+
$resourcePath = str_replace(
|
283 |
+
'{' . 'attributeName' . '}',
|
284 |
+
ObjectSerializer::toPathValue($attributeName),
|
285 |
+
$resourcePath
|
286 |
+
);
|
287 |
+
}
|
288 |
+
|
289 |
+
// body params
|
290 |
+
$_tempBody = null;
|
291 |
+
if (isset($createAttribute)) {
|
292 |
+
$_tempBody = $createAttribute;
|
293 |
+
}
|
294 |
+
|
295 |
+
if ($multipart) {
|
296 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
297 |
+
['application/json']
|
298 |
+
);
|
299 |
+
} else {
|
300 |
+
$headers = $this->headerSelector->selectHeaders(
|
301 |
+
['application/json'],
|
302 |
+
['application/json']
|
303 |
+
);
|
304 |
+
}
|
305 |
+
|
306 |
+
// for model (json/xml)
|
307 |
+
if (isset($_tempBody)) {
|
308 |
+
// $_tempBody is the method argument, if present
|
309 |
+
$httpBody = $_tempBody;
|
310 |
+
|
311 |
+
if($headers['Content-Type'] === 'application/json') {
|
312 |
+
// \stdClass has no __toString(), so we should encode it manually
|
313 |
+
if ($httpBody instanceof \stdClass) {
|
314 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
315 |
+
}
|
316 |
+
// array has no __toString(), so we should encode it manually
|
317 |
+
if(is_array($httpBody)) {
|
318 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
319 |
+
}
|
320 |
+
}
|
321 |
+
} elseif (count($formParams) > 0) {
|
322 |
+
if ($multipart) {
|
323 |
+
$multipartContents = [];
|
324 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
325 |
+
$multipartContents[] = [
|
326 |
+
'name' => $formParamName,
|
327 |
+
'contents' => $formParamValue
|
328 |
+
];
|
329 |
+
}
|
330 |
+
// for HTTP post (form)
|
331 |
+
$httpBody = new MultipartStream($multipartContents);
|
332 |
+
|
333 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
334 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
335 |
+
|
336 |
+
} else {
|
337 |
+
// for HTTP post (form)
|
338 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
339 |
+
}
|
340 |
+
}
|
341 |
+
|
342 |
+
// this endpoint requires API key authentication
|
343 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
344 |
+
if ($apiKey !== null) {
|
345 |
+
$headers['api-key'] = $apiKey;
|
346 |
+
}
|
347 |
+
// this endpoint requires API key authentication
|
348 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
349 |
+
if ($apiKey !== null) {
|
350 |
+
$headers['partner-key'] = $apiKey;
|
351 |
+
}
|
352 |
+
|
353 |
+
$defaultHeaders = [];
|
354 |
+
if ($this->config->getUserAgent()) {
|
355 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
356 |
+
}
|
357 |
+
|
358 |
+
$headers = array_merge(
|
359 |
+
$defaultHeaders,
|
360 |
+
$headerParams,
|
361 |
+
$headers
|
362 |
+
);
|
363 |
+
|
364 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
365 |
+
return new Request(
|
366 |
+
'POST',
|
367 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
368 |
+
$headers,
|
369 |
+
$httpBody
|
370 |
+
);
|
371 |
+
}
|
372 |
+
|
373 |
+
/**
|
374 |
+
* Operation deleteAttribute
|
375 |
+
*
|
376 |
+
* Delete an attribute
|
377 |
+
*
|
378 |
+
* @param string $attributeCategory Category of the attribute (required)
|
379 |
+
* @param string $attributeName Name of the existing attribute (required)
|
380 |
+
*
|
381 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
382 |
+
* @throws \InvalidArgumentException
|
383 |
+
* @return void
|
384 |
+
*/
|
385 |
+
public function deleteAttribute($attributeCategory, $attributeName)
|
386 |
+
{
|
387 |
+
$this->deleteAttributeWithHttpInfo($attributeCategory, $attributeName);
|
388 |
+
}
|
389 |
+
|
390 |
+
/**
|
391 |
+
* Operation deleteAttributeWithHttpInfo
|
392 |
+
*
|
393 |
+
* Delete an attribute
|
394 |
+
*
|
395 |
+
* @param string $attributeCategory Category of the attribute (required)
|
396 |
+
* @param string $attributeName Name of the existing attribute (required)
|
397 |
+
*
|
398 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
399 |
+
* @throws \InvalidArgumentException
|
400 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
401 |
+
*/
|
402 |
+
public function deleteAttributeWithHttpInfo($attributeCategory, $attributeName)
|
403 |
+
{
|
404 |
+
$returnType = '';
|
405 |
+
$request = $this->deleteAttributeRequest($attributeCategory, $attributeName);
|
406 |
+
|
407 |
+
try {
|
408 |
+
$options = $this->createHttpClientOption();
|
409 |
+
try {
|
410 |
+
$response = $this->client->send($request, $options);
|
411 |
+
} catch (RequestException $e) {
|
412 |
+
throw new ApiException(
|
413 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
414 |
+
$e->getCode(),
|
415 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
416 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
417 |
+
);
|
418 |
+
}
|
419 |
+
|
420 |
+
$statusCode = $response->getStatusCode();
|
421 |
+
|
422 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
423 |
+
throw new ApiException(
|
424 |
+
sprintf(
|
425 |
+
'[%d] Error connecting to the API (%s)',
|
426 |
+
$statusCode,
|
427 |
+
$request->getUri()
|
428 |
+
),
|
429 |
+
$statusCode,
|
430 |
+
$response->getHeaders(),
|
431 |
+
$response->getBody()
|
432 |
+
);
|
433 |
+
}
|
434 |
+
|
435 |
+
return [null, $statusCode, $response->getHeaders()];
|
436 |
+
|
437 |
+
} catch (ApiException $e) {
|
438 |
+
switch ($e->getCode()) {
|
439 |
+
case 400:
|
440 |
+
$data = ObjectSerializer::deserialize(
|
441 |
+
$e->getResponseBody(),
|
442 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
443 |
+
$e->getResponseHeaders()
|
444 |
+
);
|
445 |
+
$e->setResponseObject($data);
|
446 |
+
break;
|
447 |
+
case 404:
|
448 |
+
$data = ObjectSerializer::deserialize(
|
449 |
+
$e->getResponseBody(),
|
450 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
451 |
+
$e->getResponseHeaders()
|
452 |
+
);
|
453 |
+
$e->setResponseObject($data);
|
454 |
+
break;
|
455 |
+
}
|
456 |
+
throw $e;
|
457 |
+
}
|
458 |
+
}
|
459 |
+
|
460 |
+
/**
|
461 |
+
* Operation deleteAttributeAsync
|
462 |
+
*
|
463 |
+
* Delete an attribute
|
464 |
+
*
|
465 |
+
* @param string $attributeCategory Category of the attribute (required)
|
466 |
+
* @param string $attributeName Name of the existing attribute (required)
|
467 |
+
*
|
468 |
+
* @throws \InvalidArgumentException
|
469 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
470 |
+
*/
|
471 |
+
public function deleteAttributeAsync($attributeCategory, $attributeName)
|
472 |
+
{
|
473 |
+
return $this->deleteAttributeAsyncWithHttpInfo($attributeCategory, $attributeName)
|
474 |
+
->then(
|
475 |
+
function ($response) {
|
476 |
+
return $response[0];
|
477 |
+
}
|
478 |
+
);
|
479 |
+
}
|
480 |
+
|
481 |
+
/**
|
482 |
+
* Operation deleteAttributeAsyncWithHttpInfo
|
483 |
+
*
|
484 |
+
* Delete an attribute
|
485 |
+
*
|
486 |
+
* @param string $attributeCategory Category of the attribute (required)
|
487 |
+
* @param string $attributeName Name of the existing attribute (required)
|
488 |
+
*
|
489 |
+
* @throws \InvalidArgumentException
|
490 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
491 |
+
*/
|
492 |
+
public function deleteAttributeAsyncWithHttpInfo($attributeCategory, $attributeName)
|
493 |
+
{
|
494 |
+
$returnType = '';
|
495 |
+
$request = $this->deleteAttributeRequest($attributeCategory, $attributeName);
|
496 |
+
|
497 |
+
return $this->client
|
498 |
+
->sendAsync($request, $this->createHttpClientOption())
|
499 |
+
->then(
|
500 |
+
function ($response) use ($returnType) {
|
501 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
502 |
+
},
|
503 |
+
function ($exception) {
|
504 |
+
$response = $exception->getResponse();
|
505 |
+
$statusCode = $response->getStatusCode();
|
506 |
+
throw new ApiException(
|
507 |
+
sprintf(
|
508 |
+
'[%d] Error connecting to the API (%s)',
|
509 |
+
$statusCode,
|
510 |
+
$exception->getRequest()->getUri()
|
511 |
+
),
|
512 |
+
$statusCode,
|
513 |
+
$response->getHeaders(),
|
514 |
+
$response->getBody()
|
515 |
+
);
|
516 |
+
}
|
517 |
+
);
|
518 |
+
}
|
519 |
+
|
520 |
+
/**
|
521 |
+
* Create request for operation 'deleteAttribute'
|
522 |
+
*
|
523 |
+
* @param string $attributeCategory Category of the attribute (required)
|
524 |
+
* @param string $attributeName Name of the existing attribute (required)
|
525 |
+
*
|
526 |
+
* @throws \InvalidArgumentException
|
527 |
+
* @return \GuzzleHttp\Psr7\Request
|
528 |
+
*/
|
529 |
+
protected function deleteAttributeRequest($attributeCategory, $attributeName)
|
530 |
+
{
|
531 |
+
// verify the required parameter 'attributeCategory' is set
|
532 |
+
if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) {
|
533 |
+
throw new \InvalidArgumentException(
|
534 |
+
'Missing the required parameter $attributeCategory when calling deleteAttribute'
|
535 |
+
);
|
536 |
+
}
|
537 |
+
// verify the required parameter 'attributeName' is set
|
538 |
+
if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) {
|
539 |
+
throw new \InvalidArgumentException(
|
540 |
+
'Missing the required parameter $attributeName when calling deleteAttribute'
|
541 |
+
);
|
542 |
+
}
|
543 |
+
|
544 |
+
$resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}';
|
545 |
+
$formParams = [];
|
546 |
+
$queryParams = [];
|
547 |
+
$headerParams = [];
|
548 |
+
$httpBody = '';
|
549 |
+
$multipart = false;
|
550 |
+
|
551 |
+
|
552 |
+
// path params
|
553 |
+
if ($attributeCategory !== null) {
|
554 |
+
$resourcePath = str_replace(
|
555 |
+
'{' . 'attributeCategory' . '}',
|
556 |
+
ObjectSerializer::toPathValue($attributeCategory),
|
557 |
+
$resourcePath
|
558 |
+
);
|
559 |
+
}
|
560 |
+
// path params
|
561 |
+
if ($attributeName !== null) {
|
562 |
+
$resourcePath = str_replace(
|
563 |
+
'{' . 'attributeName' . '}',
|
564 |
+
ObjectSerializer::toPathValue($attributeName),
|
565 |
+
$resourcePath
|
566 |
+
);
|
567 |
+
}
|
568 |
+
|
569 |
+
// body params
|
570 |
+
$_tempBody = null;
|
571 |
+
|
572 |
+
if ($multipart) {
|
573 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
574 |
+
['application/json']
|
575 |
+
);
|
576 |
+
} else {
|
577 |
+
$headers = $this->headerSelector->selectHeaders(
|
578 |
+
['application/json'],
|
579 |
+
['application/json']
|
580 |
+
);
|
581 |
+
}
|
582 |
+
|
583 |
+
// for model (json/xml)
|
584 |
+
if (isset($_tempBody)) {
|
585 |
+
// $_tempBody is the method argument, if present
|
586 |
+
$httpBody = $_tempBody;
|
587 |
+
|
588 |
+
if($headers['Content-Type'] === 'application/json') {
|
589 |
+
// \stdClass has no __toString(), so we should encode it manually
|
590 |
+
if ($httpBody instanceof \stdClass) {
|
591 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
592 |
+
}
|
593 |
+
// array has no __toString(), so we should encode it manually
|
594 |
+
if(is_array($httpBody)) {
|
595 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
596 |
+
}
|
597 |
+
}
|
598 |
+
} elseif (count($formParams) > 0) {
|
599 |
+
if ($multipart) {
|
600 |
+
$multipartContents = [];
|
601 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
602 |
+
$multipartContents[] = [
|
603 |
+
'name' => $formParamName,
|
604 |
+
'contents' => $formParamValue
|
605 |
+
];
|
606 |
+
}
|
607 |
+
// for HTTP post (form)
|
608 |
+
$httpBody = new MultipartStream($multipartContents);
|
609 |
+
|
610 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
611 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
612 |
+
|
613 |
+
} else {
|
614 |
+
// for HTTP post (form)
|
615 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
616 |
+
}
|
617 |
+
}
|
618 |
+
|
619 |
+
// this endpoint requires API key authentication
|
620 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
621 |
+
if ($apiKey !== null) {
|
622 |
+
$headers['api-key'] = $apiKey;
|
623 |
+
}
|
624 |
+
// this endpoint requires API key authentication
|
625 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
626 |
+
if ($apiKey !== null) {
|
627 |
+
$headers['partner-key'] = $apiKey;
|
628 |
+
}
|
629 |
+
|
630 |
+
$defaultHeaders = [];
|
631 |
+
if ($this->config->getUserAgent()) {
|
632 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
633 |
+
}
|
634 |
+
|
635 |
+
$headers = array_merge(
|
636 |
+
$defaultHeaders,
|
637 |
+
$headerParams,
|
638 |
+
$headers
|
639 |
+
);
|
640 |
+
|
641 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
642 |
+
return new Request(
|
643 |
+
'DELETE',
|
644 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
645 |
+
$headers,
|
646 |
+
$httpBody
|
647 |
+
);
|
648 |
+
}
|
649 |
+
|
650 |
+
/**
|
651 |
+
* Operation getAttributes
|
652 |
+
*
|
653 |
+
* List all attributes
|
654 |
+
*
|
655 |
+
*
|
656 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
657 |
+
* @throws \InvalidArgumentException
|
658 |
+
* @return \SendinBlue\Client\Model\GetAttributes
|
659 |
+
*/
|
660 |
+
public function getAttributes()
|
661 |
+
{
|
662 |
+
list($response) = $this->getAttributesWithHttpInfo();
|
663 |
+
return $response;
|
664 |
+
}
|
665 |
+
|
666 |
+
/**
|
667 |
+
* Operation getAttributesWithHttpInfo
|
668 |
+
*
|
669 |
+
* List all attributes
|
670 |
+
*
|
671 |
+
*
|
672 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
673 |
+
* @throws \InvalidArgumentException
|
674 |
+
* @return array of \SendinBlue\Client\Model\GetAttributes, HTTP status code, HTTP response headers (array of strings)
|
675 |
+
*/
|
676 |
+
public function getAttributesWithHttpInfo()
|
677 |
+
{
|
678 |
+
$returnType = '\SendinBlue\Client\Model\GetAttributes';
|
679 |
+
$request = $this->getAttributesRequest();
|
680 |
+
|
681 |
+
try {
|
682 |
+
$options = $this->createHttpClientOption();
|
683 |
+
try {
|
684 |
+
$response = $this->client->send($request, $options);
|
685 |
+
} catch (RequestException $e) {
|
686 |
+
throw new ApiException(
|
687 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
688 |
+
$e->getCode(),
|
689 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
690 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
691 |
+
);
|
692 |
+
}
|
693 |
+
|
694 |
+
$statusCode = $response->getStatusCode();
|
695 |
+
|
696 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
697 |
+
throw new ApiException(
|
698 |
+
sprintf(
|
699 |
+
'[%d] Error connecting to the API (%s)',
|
700 |
+
$statusCode,
|
701 |
+
$request->getUri()
|
702 |
+
),
|
703 |
+
$statusCode,
|
704 |
+
$response->getHeaders(),
|
705 |
+
$response->getBody()
|
706 |
+
);
|
707 |
+
}
|
708 |
+
|
709 |
+
$responseBody = $response->getBody();
|
710 |
+
if ($returnType === '\SplFileObject') {
|
711 |
+
$content = $responseBody; //stream goes to serializer
|
712 |
+
} else {
|
713 |
+
$content = $responseBody->getContents();
|
714 |
+
if ($returnType !== 'string') {
|
715 |
+
$content = json_decode($content);
|
716 |
+
}
|
717 |
+
}
|
718 |
+
|
719 |
+
return [
|
720 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
721 |
+
$response->getStatusCode(),
|
722 |
+
$response->getHeaders()
|
723 |
+
];
|
724 |
+
|
725 |
+
} catch (ApiException $e) {
|
726 |
+
switch ($e->getCode()) {
|
727 |
+
case 200:
|
728 |
+
$data = ObjectSerializer::deserialize(
|
729 |
+
$e->getResponseBody(),
|
730 |
+
'\SendinBlue\Client\Model\GetAttributes',
|
731 |
+
$e->getResponseHeaders()
|
732 |
+
);
|
733 |
+
$e->setResponseObject($data);
|
734 |
+
break;
|
735 |
+
}
|
736 |
+
throw $e;
|
737 |
+
}
|
738 |
+
}
|
739 |
+
|
740 |
+
/**
|
741 |
+
* Operation getAttributesAsync
|
742 |
+
*
|
743 |
+
* List all attributes
|
744 |
+
*
|
745 |
+
*
|
746 |
+
* @throws \InvalidArgumentException
|
747 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
748 |
+
*/
|
749 |
+
public function getAttributesAsync()
|
750 |
+
{
|
751 |
+
return $this->getAttributesAsyncWithHttpInfo()
|
752 |
+
->then(
|
753 |
+
function ($response) {
|
754 |
+
return $response[0];
|
755 |
+
}
|
756 |
+
);
|
757 |
+
}
|
758 |
+
|
759 |
+
/**
|
760 |
+
* Operation getAttributesAsyncWithHttpInfo
|
761 |
+
*
|
762 |
+
* List all attributes
|
763 |
+
*
|
764 |
+
*
|
765 |
+
* @throws \InvalidArgumentException
|
766 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
767 |
+
*/
|
768 |
+
public function getAttributesAsyncWithHttpInfo()
|
769 |
+
{
|
770 |
+
$returnType = '\SendinBlue\Client\Model\GetAttributes';
|
771 |
+
$request = $this->getAttributesRequest();
|
772 |
+
|
773 |
+
return $this->client
|
774 |
+
->sendAsync($request, $this->createHttpClientOption())
|
775 |
+
->then(
|
776 |
+
function ($response) use ($returnType) {
|
777 |
+
$responseBody = $response->getBody();
|
778 |
+
if ($returnType === '\SplFileObject') {
|
779 |
+
$content = $responseBody; //stream goes to serializer
|
780 |
+
} else {
|
781 |
+
$content = $responseBody->getContents();
|
782 |
+
if ($returnType !== 'string') {
|
783 |
+
$content = json_decode($content);
|
784 |
+
}
|
785 |
+
}
|
786 |
+
|
787 |
+
return [
|
788 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
789 |
+
$response->getStatusCode(),
|
790 |
+
$response->getHeaders()
|
791 |
+
];
|
792 |
+
},
|
793 |
+
function ($exception) {
|
794 |
+
$response = $exception->getResponse();
|
795 |
+
$statusCode = $response->getStatusCode();
|
796 |
+
throw new ApiException(
|
797 |
+
sprintf(
|
798 |
+
'[%d] Error connecting to the API (%s)',
|
799 |
+
$statusCode,
|
800 |
+
$exception->getRequest()->getUri()
|
801 |
+
),
|
802 |
+
$statusCode,
|
803 |
+
$response->getHeaders(),
|
804 |
+
$response->getBody()
|
805 |
+
);
|
806 |
+
}
|
807 |
+
);
|
808 |
+
}
|
809 |
+
|
810 |
+
/**
|
811 |
+
* Create request for operation 'getAttributes'
|
812 |
+
*
|
813 |
+
*
|
814 |
+
* @throws \InvalidArgumentException
|
815 |
+
* @return \GuzzleHttp\Psr7\Request
|
816 |
+
*/
|
817 |
+
protected function getAttributesRequest()
|
818 |
+
{
|
819 |
+
|
820 |
+
$resourcePath = '/contacts/attributes';
|
821 |
+
$formParams = [];
|
822 |
+
$queryParams = [];
|
823 |
+
$headerParams = [];
|
824 |
+
$httpBody = '';
|
825 |
+
$multipart = false;
|
826 |
+
|
827 |
+
|
828 |
+
|
829 |
+
// body params
|
830 |
+
$_tempBody = null;
|
831 |
+
|
832 |
+
if ($multipart) {
|
833 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
834 |
+
['application/json']
|
835 |
+
);
|
836 |
+
} else {
|
837 |
+
$headers = $this->headerSelector->selectHeaders(
|
838 |
+
['application/json'],
|
839 |
+
['application/json']
|
840 |
+
);
|
841 |
+
}
|
842 |
+
|
843 |
+
// for model (json/xml)
|
844 |
+
if (isset($_tempBody)) {
|
845 |
+
// $_tempBody is the method argument, if present
|
846 |
+
$httpBody = $_tempBody;
|
847 |
+
|
848 |
+
if($headers['Content-Type'] === 'application/json') {
|
849 |
+
// \stdClass has no __toString(), so we should encode it manually
|
850 |
+
if ($httpBody instanceof \stdClass) {
|
851 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
852 |
+
}
|
853 |
+
// array has no __toString(), so we should encode it manually
|
854 |
+
if(is_array($httpBody)) {
|
855 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
856 |
+
}
|
857 |
+
}
|
858 |
+
} elseif (count($formParams) > 0) {
|
859 |
+
if ($multipart) {
|
860 |
+
$multipartContents = [];
|
861 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
862 |
+
$multipartContents[] = [
|
863 |
+
'name' => $formParamName,
|
864 |
+
'contents' => $formParamValue
|
865 |
+
];
|
866 |
+
}
|
867 |
+
// for HTTP post (form)
|
868 |
+
$httpBody = new MultipartStream($multipartContents);
|
869 |
+
|
870 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
871 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
872 |
+
|
873 |
+
} else {
|
874 |
+
// for HTTP post (form)
|
875 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
876 |
+
}
|
877 |
+
}
|
878 |
+
|
879 |
+
// this endpoint requires API key authentication
|
880 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
881 |
+
if ($apiKey !== null) {
|
882 |
+
$headers['api-key'] = $apiKey;
|
883 |
+
}
|
884 |
+
// this endpoint requires API key authentication
|
885 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
886 |
+
if ($apiKey !== null) {
|
887 |
+
$headers['partner-key'] = $apiKey;
|
888 |
+
}
|
889 |
+
|
890 |
+
$defaultHeaders = [];
|
891 |
+
if ($this->config->getUserAgent()) {
|
892 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
893 |
+
}
|
894 |
+
|
895 |
+
$headers = array_merge(
|
896 |
+
$defaultHeaders,
|
897 |
+
$headerParams,
|
898 |
+
$headers
|
899 |
+
);
|
900 |
+
|
901 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
902 |
+
return new Request(
|
903 |
+
'GET',
|
904 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
905 |
+
$headers,
|
906 |
+
$httpBody
|
907 |
+
);
|
908 |
+
}
|
909 |
+
|
910 |
+
/**
|
911 |
+
* Operation updateAttribute
|
912 |
+
*
|
913 |
+
* Update contact attribute
|
914 |
+
*
|
915 |
+
* @param string $attributeCategory Category of the attribute (required)
|
916 |
+
* @param string $attributeName Name of the existing attribute (required)
|
917 |
+
* @param \SendinBlue\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required)
|
918 |
+
*
|
919 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
920 |
+
* @throws \InvalidArgumentException
|
921 |
+
* @return void
|
922 |
+
*/
|
923 |
+
public function updateAttribute($attributeCategory, $attributeName, $updateAttribute)
|
924 |
+
{
|
925 |
+
$this->updateAttributeWithHttpInfo($attributeCategory, $attributeName, $updateAttribute);
|
926 |
+
}
|
927 |
+
|
928 |
+
/**
|
929 |
+
* Operation updateAttributeWithHttpInfo
|
930 |
+
*
|
931 |
+
* Update contact attribute
|
932 |
+
*
|
933 |
+
* @param string $attributeCategory Category of the attribute (required)
|
934 |
+
* @param string $attributeName Name of the existing attribute (required)
|
935 |
+
* @param \SendinBlue\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required)
|
936 |
+
*
|
937 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
938 |
+
* @throws \InvalidArgumentException
|
939 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
940 |
+
*/
|
941 |
+
public function updateAttributeWithHttpInfo($attributeCategory, $attributeName, $updateAttribute)
|
942 |
+
{
|
943 |
+
$returnType = '';
|
944 |
+
$request = $this->updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute);
|
945 |
+
|
946 |
+
try {
|
947 |
+
$options = $this->createHttpClientOption();
|
948 |
+
try {
|
949 |
+
$response = $this->client->send($request, $options);
|
950 |
+
} catch (RequestException $e) {
|
951 |
+
throw new ApiException(
|
952 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
953 |
+
$e->getCode(),
|
954 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
955 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
956 |
+
);
|
957 |
+
}
|
958 |
+
|
959 |
+
$statusCode = $response->getStatusCode();
|
960 |
+
|
961 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
962 |
+
throw new ApiException(
|
963 |
+
sprintf(
|
964 |
+
'[%d] Error connecting to the API (%s)',
|
965 |
+
$statusCode,
|
966 |
+
$request->getUri()
|
967 |
+
),
|
968 |
+
$statusCode,
|
969 |
+
$response->getHeaders(),
|
970 |
+
$response->getBody()
|
971 |
+
);
|
972 |
+
}
|
973 |
+
|
974 |
+
return [null, $statusCode, $response->getHeaders()];
|
975 |
+
|
976 |
+
} catch (ApiException $e) {
|
977 |
+
switch ($e->getCode()) {
|
978 |
+
case 400:
|
979 |
+
$data = ObjectSerializer::deserialize(
|
980 |
+
$e->getResponseBody(),
|
981 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
982 |
+
$e->getResponseHeaders()
|
983 |
+
);
|
984 |
+
$e->setResponseObject($data);
|
985 |
+
break;
|
986 |
+
case 404:
|
987 |
+
$data = ObjectSerializer::deserialize(
|
988 |
+
$e->getResponseBody(),
|
989 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
990 |
+
$e->getResponseHeaders()
|
991 |
+
);
|
992 |
+
$e->setResponseObject($data);
|
993 |
+
break;
|
994 |
+
}
|
995 |
+
throw $e;
|
996 |
+
}
|
997 |
+
}
|
998 |
+
|
999 |
+
/**
|
1000 |
+
* Operation updateAttributeAsync
|
1001 |
+
*
|
1002 |
+
* Update contact attribute
|
1003 |
+
*
|
1004 |
+
* @param string $attributeCategory Category of the attribute (required)
|
1005 |
+
* @param string $attributeName Name of the existing attribute (required)
|
1006 |
+
* @param \SendinBlue\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required)
|
1007 |
+
*
|
1008 |
+
* @throws \InvalidArgumentException
|
1009 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1010 |
+
*/
|
1011 |
+
public function updateAttributeAsync($attributeCategory, $attributeName, $updateAttribute)
|
1012 |
+
{
|
1013 |
+
return $this->updateAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $updateAttribute)
|
1014 |
+
->then(
|
1015 |
+
function ($response) {
|
1016 |
+
return $response[0];
|
1017 |
+
}
|
1018 |
+
);
|
1019 |
+
}
|
1020 |
+
|
1021 |
+
/**
|
1022 |
+
* Operation updateAttributeAsyncWithHttpInfo
|
1023 |
+
*
|
1024 |
+
* Update contact attribute
|
1025 |
+
*
|
1026 |
+
* @param string $attributeCategory Category of the attribute (required)
|
1027 |
+
* @param string $attributeName Name of the existing attribute (required)
|
1028 |
+
* @param \SendinBlue\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required)
|
1029 |
+
*
|
1030 |
+
* @throws \InvalidArgumentException
|
1031 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1032 |
+
*/
|
1033 |
+
public function updateAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $updateAttribute)
|
1034 |
+
{
|
1035 |
+
$returnType = '';
|
1036 |
+
$request = $this->updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute);
|
1037 |
+
|
1038 |
+
return $this->client
|
1039 |
+
->sendAsync($request, $this->createHttpClientOption())
|
1040 |
+
->then(
|
1041 |
+
function ($response) use ($returnType) {
|
1042 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
1043 |
+
},
|
1044 |
+
function ($exception) {
|
1045 |
+
$response = $exception->getResponse();
|
1046 |
+
$statusCode = $response->getStatusCode();
|
1047 |
+
throw new ApiException(
|
1048 |
+
sprintf(
|
1049 |
+
'[%d] Error connecting to the API (%s)',
|
1050 |
+
$statusCode,
|
1051 |
+
$exception->getRequest()->getUri()
|
1052 |
+
),
|
1053 |
+
$statusCode,
|
1054 |
+
$response->getHeaders(),
|
1055 |
+
$response->getBody()
|
1056 |
+
);
|
1057 |
+
}
|
1058 |
+
);
|
1059 |
+
}
|
1060 |
+
|
1061 |
+
/**
|
1062 |
+
* Create request for operation 'updateAttribute'
|
1063 |
+
*
|
1064 |
+
* @param string $attributeCategory Category of the attribute (required)
|
1065 |
+
* @param string $attributeName Name of the existing attribute (required)
|
1066 |
+
* @param \SendinBlue\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required)
|
1067 |
+
*
|
1068 |
+
* @throws \InvalidArgumentException
|
1069 |
+
* @return \GuzzleHttp\Psr7\Request
|
1070 |
+
*/
|
1071 |
+
protected function updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute)
|
1072 |
+
{
|
1073 |
+
// verify the required parameter 'attributeCategory' is set
|
1074 |
+
if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) {
|
1075 |
+
throw new \InvalidArgumentException(
|
1076 |
+
'Missing the required parameter $attributeCategory when calling updateAttribute'
|
1077 |
+
);
|
1078 |
+
}
|
1079 |
+
// verify the required parameter 'attributeName' is set
|
1080 |
+
if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) {
|
1081 |
+
throw new \InvalidArgumentException(
|
1082 |
+
'Missing the required parameter $attributeName when calling updateAttribute'
|
1083 |
+
);
|
1084 |
+
}
|
1085 |
+
// verify the required parameter 'updateAttribute' is set
|
1086 |
+
if ($updateAttribute === null || (is_array($updateAttribute) && count($updateAttribute) === 0)) {
|
1087 |
+
throw new \InvalidArgumentException(
|
1088 |
+
'Missing the required parameter $updateAttribute when calling updateAttribute'
|
1089 |
+
);
|
1090 |
+
}
|
1091 |
+
|
1092 |
+
$resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}';
|
1093 |
+
$formParams = [];
|
1094 |
+
$queryParams = [];
|
1095 |
+
$headerParams = [];
|
1096 |
+
$httpBody = '';
|
1097 |
+
$multipart = false;
|
1098 |
+
|
1099 |
+
|
1100 |
+
// path params
|
1101 |
+
if ($attributeCategory !== null) {
|
1102 |
+
$resourcePath = str_replace(
|
1103 |
+
'{' . 'attributeCategory' . '}',
|
1104 |
+
ObjectSerializer::toPathValue($attributeCategory),
|
1105 |
+
$resourcePath
|
1106 |
+
);
|
1107 |
+
}
|
1108 |
+
// path params
|
1109 |
+
if ($attributeName !== null) {
|
1110 |
+
$resourcePath = str_replace(
|
1111 |
+
'{' . 'attributeName' . '}',
|
1112 |
+
ObjectSerializer::toPathValue($attributeName),
|
1113 |
+
$resourcePath
|
1114 |
+
);
|
1115 |
+
}
|
1116 |
+
|
1117 |
+
// body params
|
1118 |
+
$_tempBody = null;
|
1119 |
+
if (isset($updateAttribute)) {
|
1120 |
+
$_tempBody = $updateAttribute;
|
1121 |
+
}
|
1122 |
+
|
1123 |
+
if ($multipart) {
|
1124 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
1125 |
+
['application/json']
|
1126 |
+
);
|
1127 |
+
} else {
|
1128 |
+
$headers = $this->headerSelector->selectHeaders(
|
1129 |
+
['application/json'],
|
1130 |
+
['application/json']
|
1131 |
+
);
|
1132 |
+
}
|
1133 |
+
|
1134 |
+
// for model (json/xml)
|
1135 |
+
if (isset($_tempBody)) {
|
1136 |
+
// $_tempBody is the method argument, if present
|
1137 |
+
$httpBody = $_tempBody;
|
1138 |
+
|
1139 |
+
if($headers['Content-Type'] === 'application/json') {
|
1140 |
+
// \stdClass has no __toString(), so we should encode it manually
|
1141 |
+
if ($httpBody instanceof \stdClass) {
|
1142 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
1143 |
+
}
|
1144 |
+
// array has no __toString(), so we should encode it manually
|
1145 |
+
if(is_array($httpBody)) {
|
1146 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
1147 |
+
}
|
1148 |
+
}
|
1149 |
+
} elseif (count($formParams) > 0) {
|
1150 |
+
if ($multipart) {
|
1151 |
+
$multipartContents = [];
|
1152 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
1153 |
+
$multipartContents[] = [
|
1154 |
+
'name' => $formParamName,
|
1155 |
+
'contents' => $formParamValue
|
1156 |
+
];
|
1157 |
+
}
|
1158 |
+
// for HTTP post (form)
|
1159 |
+
$httpBody = new MultipartStream($multipartContents);
|
1160 |
+
|
1161 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
1162 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
1163 |
+
|
1164 |
+
} else {
|
1165 |
+
// for HTTP post (form)
|
1166 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
1167 |
+
}
|
1168 |
+
}
|
1169 |
+
|
1170 |
+
// this endpoint requires API key authentication
|
1171 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
1172 |
+
if ($apiKey !== null) {
|
1173 |
+
$headers['api-key'] = $apiKey;
|
1174 |
+
}
|
1175 |
+
// this endpoint requires API key authentication
|
1176 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
1177 |
+
if ($apiKey !== null) {
|
1178 |
+
$headers['partner-key'] = $apiKey;
|
1179 |
+
}
|
1180 |
+
|
1181 |
+
$defaultHeaders = [];
|
1182 |
+
if ($this->config->getUserAgent()) {
|
1183 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
1184 |
+
}
|
1185 |
+
|
1186 |
+
$headers = array_merge(
|
1187 |
+
$defaultHeaders,
|
1188 |
+
$headerParams,
|
1189 |
+
$headers
|
1190 |
+
);
|
1191 |
+
|
1192 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
1193 |
+
return new Request(
|
1194 |
+
'PUT',
|
1195 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
1196 |
+
$headers,
|
1197 |
+
$httpBody
|
1198 |
+
);
|
1199 |
+
}
|
1200 |
+
|
1201 |
+
/**
|
1202 |
+
* Create http client option
|
1203 |
+
*
|
1204 |
+
* @throws \RuntimeException on file opening failure
|
1205 |
+
* @return array of http client options
|
1206 |
+
*/
|
1207 |
+
protected function createHttpClientOption()
|
1208 |
+
{
|
1209 |
+
$options = [];
|
1210 |
+
if ($this->config->getDebug()) {
|
1211 |
+
$options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
|
1212 |
+
if (!$options[RequestOptions::DEBUG]) {
|
1213 |
+
throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile());
|
1214 |
+
}
|
1215 |
+
}
|
1216 |
+
|
1217 |
+
return $options;
|
1218 |
+
}
|
1219 |
+
}
|
Postman/Postman-Mail/sendinblue/lib/Api/CRMApi.php
ADDED
@@ -0,0 +1,3768 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
/**
|
3 |
+
* CRMApi
|
4 |
+
* PHP version 5
|
5 |
+
*
|
6 |
+
* @category Class
|
7 |
+
* @package SendinBlue\Client
|
8 |
+
* @author Swagger Codegen team
|
9 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
10 |
+
*/
|
11 |
+
|
12 |
+
/**
|
13 |
+
* SendinBlue API
|
14 |
+
*
|
15 |
+
* 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 |
|
16 |
+
*
|
17 |
+
* OpenAPI spec version: 3.0.0
|
18 |
+
* Contact: contact@sendinblue.com
|
19 |
+
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
20 |
+
* Swagger Codegen version: 2.4.12
|
21 |
+
*/
|
22 |
+
|
23 |
+
/**
|
24 |
+
* NOTE: This class is auto generated by the swagger code generator program.
|
25 |
+
* https://github.com/swagger-api/swagger-codegen
|
26 |
+
* Do not edit the class manually.
|
27 |
+
*/
|
28 |
+
|
29 |
+
namespace SendinBlue\Client\Api;
|
30 |
+
|
31 |
+
use GuzzleHttp\Client;
|
32 |
+
use GuzzleHttp\ClientInterface;
|
33 |
+
use GuzzleHttp\Exception\RequestException;
|
34 |
+
use GuzzleHttp\Psr7\MultipartStream;
|
35 |
+
use GuzzleHttp\Psr7\Request;
|
36 |
+
use GuzzleHttp\RequestOptions;
|
37 |
+
use SendinBlue\Client\ApiException;
|
38 |
+
use SendinBlue\Client\Configuration;
|
39 |
+
use SendinBlue\Client\HeaderSelector;
|
40 |
+
use SendinBlue\Client\ObjectSerializer;
|
41 |
+
|
42 |
+
/**
|
43 |
+
* CRMApi Class Doc Comment
|
44 |
+
*
|
45 |
+
* @category Class
|
46 |
+
* @package SendinBlue\Client
|
47 |
+
* @author Swagger Codegen team
|
48 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
49 |
+
*/
|
50 |
+
class CRMApi
|
51 |
+
{
|
52 |
+
/**
|
53 |
+
* @var ClientInterface
|
54 |
+
*/
|
55 |
+
protected $client;
|
56 |
+
|
57 |
+
/**
|
58 |
+
* @var Configuration
|
59 |
+
*/
|
60 |
+
protected $config;
|
61 |
+
|
62 |
+
/**
|
63 |
+
* @var HeaderSelector
|
64 |
+
*/
|
65 |
+
protected $headerSelector;
|
66 |
+
|
67 |
+
/**
|
68 |
+
* @param ClientInterface $client
|
69 |
+
* @param Configuration $config
|
70 |
+
* @param HeaderSelector $selector
|
71 |
+
*/
|
72 |
+
public function __construct(
|
73 |
+
ClientInterface $client = null,
|
74 |
+
Configuration $config = null,
|
75 |
+
HeaderSelector $selector = null
|
76 |
+
) {
|
77 |
+
$this->client = $client ?: new Client();
|
78 |
+
$this->config = $config ?: new Configuration();
|
79 |
+
$this->headerSelector = $selector ?: new HeaderSelector();
|
80 |
+
}
|
81 |
+
|
82 |
+
/**
|
83 |
+
* @return Configuration
|
84 |
+
*/
|
85 |
+
public function getConfig()
|
86 |
+
{
|
87 |
+
return $this->config;
|
88 |
+
}
|
89 |
+
|
90 |
+
/**
|
91 |
+
* Operation crmFilesIdDataGet
|
92 |
+
*
|
93 |
+
* Get file details
|
94 |
+
*
|
95 |
+
* @param string $id File id to get file data. (required)
|
96 |
+
*
|
97 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
98 |
+
* @throws \InvalidArgumentException
|
99 |
+
* @return \SendinBlue\Client\Model\FileData
|
100 |
+
*/
|
101 |
+
public function crmFilesIdDataGet($id)
|
102 |
+
{
|
103 |
+
list($response) = $this->crmFilesIdDataGetWithHttpInfo($id);
|
104 |
+
return $response;
|
105 |
+
}
|
106 |
+
|
107 |
+
/**
|
108 |
+
* Operation crmFilesIdDataGetWithHttpInfo
|
109 |
+
*
|
110 |
+
* Get file details
|
111 |
+
*
|
112 |
+
* @param string $id File id to get file data. (required)
|
113 |
+
*
|
114 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
115 |
+
* @throws \InvalidArgumentException
|
116 |
+
* @return array of \SendinBlue\Client\Model\FileData, HTTP status code, HTTP response headers (array of strings)
|
117 |
+
*/
|
118 |
+
public function crmFilesIdDataGetWithHttpInfo($id)
|
119 |
+
{
|
120 |
+
$returnType = '\SendinBlue\Client\Model\FileData';
|
121 |
+
$request = $this->crmFilesIdDataGetRequest($id);
|
122 |
+
|
123 |
+
try {
|
124 |
+
$options = $this->createHttpClientOption();
|
125 |
+
try {
|
126 |
+
$response = $this->client->send($request, $options);
|
127 |
+
} catch (RequestException $e) {
|
128 |
+
throw new ApiException(
|
129 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
130 |
+
$e->getCode(),
|
131 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
132 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
133 |
+
);
|
134 |
+
}
|
135 |
+
|
136 |
+
$statusCode = $response->getStatusCode();
|
137 |
+
|
138 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
139 |
+
throw new ApiException(
|
140 |
+
sprintf(
|
141 |
+
'[%d] Error connecting to the API (%s)',
|
142 |
+
$statusCode,
|
143 |
+
$request->getUri()
|
144 |
+
),
|
145 |
+
$statusCode,
|
146 |
+
$response->getHeaders(),
|
147 |
+
$response->getBody()
|
148 |
+
);
|
149 |
+
}
|
150 |
+
|
151 |
+
$responseBody = $response->getBody();
|
152 |
+
if ($returnType === '\SplFileObject') {
|
153 |
+
$content = $responseBody; //stream goes to serializer
|
154 |
+
} else {
|
155 |
+
$content = $responseBody->getContents();
|
156 |
+
if ($returnType !== 'string') {
|
157 |
+
$content = json_decode($content);
|
158 |
+
}
|
159 |
+
}
|
160 |
+
|
161 |
+
return [
|
162 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
163 |
+
$response->getStatusCode(),
|
164 |
+
$response->getHeaders()
|
165 |
+
];
|
166 |
+
|
167 |
+
} catch (ApiException $e) {
|
168 |
+
switch ($e->getCode()) {
|
169 |
+
case 200:
|
170 |
+
$data = ObjectSerializer::deserialize(
|
171 |
+
$e->getResponseBody(),
|
172 |
+
'\SendinBlue\Client\Model\FileData',
|
173 |
+
$e->getResponseHeaders()
|
174 |
+
);
|
175 |
+
$e->setResponseObject($data);
|
176 |
+
break;
|
177 |
+
case 400:
|
178 |
+
$data = ObjectSerializer::deserialize(
|
179 |
+
$e->getResponseBody(),
|
180 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
181 |
+
$e->getResponseHeaders()
|
182 |
+
);
|
183 |
+
$e->setResponseObject($data);
|
184 |
+
break;
|
185 |
+
case 404:
|
186 |
+
$data = ObjectSerializer::deserialize(
|
187 |
+
$e->getResponseBody(),
|
188 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
189 |
+
$e->getResponseHeaders()
|
190 |
+
);
|
191 |
+
$e->setResponseObject($data);
|
192 |
+
break;
|
193 |
+
}
|
194 |
+
throw $e;
|
195 |
+
}
|
196 |
+
}
|
197 |
+
|
198 |
+
/**
|
199 |
+
* Operation crmFilesIdDataGetAsync
|
200 |
+
*
|
201 |
+
* Get file details
|
202 |
+
*
|
203 |
+
* @param string $id File id to get file data. (required)
|
204 |
+
*
|
205 |
+
* @throws \InvalidArgumentException
|
206 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
207 |
+
*/
|
208 |
+
public function crmFilesIdDataGetAsync($id)
|
209 |
+
{
|
210 |
+
return $this->crmFilesIdDataGetAsyncWithHttpInfo($id)
|
211 |
+
->then(
|
212 |
+
function ($response) {
|
213 |
+
return $response[0];
|
214 |
+
}
|
215 |
+
);
|
216 |
+
}
|
217 |
+
|
218 |
+
/**
|
219 |
+
* Operation crmFilesIdDataGetAsyncWithHttpInfo
|
220 |
+
*
|
221 |
+
* Get file details
|
222 |
+
*
|
223 |
+
* @param string $id File id to get file data. (required)
|
224 |
+
*
|
225 |
+
* @throws \InvalidArgumentException
|
226 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
227 |
+
*/
|
228 |
+
public function crmFilesIdDataGetAsyncWithHttpInfo($id)
|
229 |
+
{
|
230 |
+
$returnType = '\SendinBlue\Client\Model\FileData';
|
231 |
+
$request = $this->crmFilesIdDataGetRequest($id);
|
232 |
+
|
233 |
+
return $this->client
|
234 |
+
->sendAsync($request, $this->createHttpClientOption())
|
235 |
+
->then(
|
236 |
+
function ($response) use ($returnType) {
|
237 |
+
$responseBody = $response->getBody();
|
238 |
+
if ($returnType === '\SplFileObject') {
|
239 |
+
$content = $responseBody; //stream goes to serializer
|
240 |
+
} else {
|
241 |
+
$content = $responseBody->getContents();
|
242 |
+
if ($returnType !== 'string') {
|
243 |
+
$content = json_decode($content);
|
244 |
+
}
|
245 |
+
}
|
246 |
+
|
247 |
+
return [
|
248 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
249 |
+
$response->getStatusCode(),
|
250 |
+
$response->getHeaders()
|
251 |
+
];
|
252 |
+
},
|
253 |
+
function ($exception) {
|
254 |
+
$response = $exception->getResponse();
|
255 |
+
$statusCode = $response->getStatusCode();
|
256 |
+
throw new ApiException(
|
257 |
+
sprintf(
|
258 |
+
'[%d] Error connecting to the API (%s)',
|
259 |
+
$statusCode,
|
260 |
+
$exception->getRequest()->getUri()
|
261 |
+
),
|
262 |
+
$statusCode,
|
263 |
+
$response->getHeaders(),
|
264 |
+
$response->getBody()
|
265 |
+
);
|
266 |
+
}
|
267 |
+
);
|
268 |
+
}
|
269 |
+
|
270 |
+
/**
|
271 |
+
* Create request for operation 'crmFilesIdDataGet'
|
272 |
+
*
|
273 |
+
* @param string $id File id to get file data. (required)
|
274 |
+
*
|
275 |
+
* @throws \InvalidArgumentException
|
276 |
+
* @return \GuzzleHttp\Psr7\Request
|
277 |
+
*/
|
278 |
+
protected function crmFilesIdDataGetRequest($id)
|
279 |
+
{
|
280 |
+
// verify the required parameter 'id' is set
|
281 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
282 |
+
throw new \InvalidArgumentException(
|
283 |
+
'Missing the required parameter $id when calling crmFilesIdDataGet'
|
284 |
+
);
|
285 |
+
}
|
286 |
+
|
287 |
+
$resourcePath = '/crm/files/{id}/data';
|
288 |
+
$formParams = [];
|
289 |
+
$queryParams = [];
|
290 |
+
$headerParams = [];
|
291 |
+
$httpBody = '';
|
292 |
+
$multipart = false;
|
293 |
+
|
294 |
+
|
295 |
+
// path params
|
296 |
+
if ($id !== null) {
|
297 |
+
$resourcePath = str_replace(
|
298 |
+
'{' . 'id' . '}',
|
299 |
+
ObjectSerializer::toPathValue($id),
|
300 |
+
$resourcePath
|
301 |
+
);
|
302 |
+
}
|
303 |
+
|
304 |
+
// body params
|
305 |
+
$_tempBody = null;
|
306 |
+
|
307 |
+
if ($multipart) {
|
308 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
309 |
+
['application/json']
|
310 |
+
);
|
311 |
+
} else {
|
312 |
+
$headers = $this->headerSelector->selectHeaders(
|
313 |
+
['application/json'],
|
314 |
+
['application/json']
|
315 |
+
);
|
316 |
+
}
|
317 |
+
|
318 |
+
// for model (json/xml)
|
319 |
+
if (isset($_tempBody)) {
|
320 |
+
// $_tempBody is the method argument, if present
|
321 |
+
$httpBody = $_tempBody;
|
322 |
+
|
323 |
+
if($headers['Content-Type'] === 'application/json') {
|
324 |
+
// \stdClass has no __toString(), so we should encode it manually
|
325 |
+
if ($httpBody instanceof \stdClass) {
|
326 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
327 |
+
}
|
328 |
+
// array has no __toString(), so we should encode it manually
|
329 |
+
if(is_array($httpBody)) {
|
330 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
331 |
+
}
|
332 |
+
}
|
333 |
+
} elseif (count($formParams) > 0) {
|
334 |
+
if ($multipart) {
|
335 |
+
$multipartContents = [];
|
336 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
337 |
+
$multipartContents[] = [
|
338 |
+
'name' => $formParamName,
|
339 |
+
'contents' => $formParamValue
|
340 |
+
];
|
341 |
+
}
|
342 |
+
// for HTTP post (form)
|
343 |
+
$httpBody = new MultipartStream($multipartContents);
|
344 |
+
|
345 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
346 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
347 |
+
|
348 |
+
} else {
|
349 |
+
// for HTTP post (form)
|
350 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
351 |
+
}
|
352 |
+
}
|
353 |
+
|
354 |
+
// this endpoint requires API key authentication
|
355 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
356 |
+
if ($apiKey !== null) {
|
357 |
+
$headers['api-key'] = $apiKey;
|
358 |
+
}
|
359 |
+
// this endpoint requires API key authentication
|
360 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
361 |
+
if ($apiKey !== null) {
|
362 |
+
$headers['partner-key'] = $apiKey;
|
363 |
+
}
|
364 |
+
|
365 |
+
$defaultHeaders = [];
|
366 |
+
if ($this->config->getUserAgent()) {
|
367 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
368 |
+
}
|
369 |
+
|
370 |
+
$headers = array_merge(
|
371 |
+
$defaultHeaders,
|
372 |
+
$headerParams,
|
373 |
+
$headers
|
374 |
+
);
|
375 |
+
|
376 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
377 |
+
return new Request(
|
378 |
+
'GET',
|
379 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
380 |
+
$headers,
|
381 |
+
$httpBody
|
382 |
+
);
|
383 |
+
}
|
384 |
+
|
385 |
+
/**
|
386 |
+
* Operation crmFilesIdDelete
|
387 |
+
*
|
388 |
+
* Delete a file
|
389 |
+
*
|
390 |
+
* @param string $id File id to delete. (required)
|
391 |
+
*
|
392 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
393 |
+
* @throws \InvalidArgumentException
|
394 |
+
* @return void
|
395 |
+
*/
|
396 |
+
public function crmFilesIdDelete($id)
|
397 |
+
{
|
398 |
+
$this->crmFilesIdDeleteWithHttpInfo($id);
|
399 |
+
}
|
400 |
+
|
401 |
+
/**
|
402 |
+
* Operation crmFilesIdDeleteWithHttpInfo
|
403 |
+
*
|
404 |
+
* Delete a file
|
405 |
+
*
|
406 |
+
* @param string $id File id to delete. (required)
|
407 |
+
*
|
408 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
409 |
+
* @throws \InvalidArgumentException
|
410 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
411 |
+
*/
|
412 |
+
public function crmFilesIdDeleteWithHttpInfo($id)
|
413 |
+
{
|
414 |
+
$returnType = '';
|
415 |
+
$request = $this->crmFilesIdDeleteRequest($id);
|
416 |
+
|
417 |
+
try {
|
418 |
+
$options = $this->createHttpClientOption();
|
419 |
+
try {
|
420 |
+
$response = $this->client->send($request, $options);
|
421 |
+
} catch (RequestException $e) {
|
422 |
+
throw new ApiException(
|
423 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
424 |
+
$e->getCode(),
|
425 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
426 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
427 |
+
);
|
428 |
+
}
|
429 |
+
|
430 |
+
$statusCode = $response->getStatusCode();
|
431 |
+
|
432 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
433 |
+
throw new ApiException(
|
434 |
+
sprintf(
|
435 |
+
'[%d] Error connecting to the API (%s)',
|
436 |
+
$statusCode,
|
437 |
+
$request->getUri()
|
438 |
+
),
|
439 |
+
$statusCode,
|
440 |
+
$response->getHeaders(),
|
441 |
+
$response->getBody()
|
442 |
+
);
|
443 |
+
}
|
444 |
+
|
445 |
+
return [null, $statusCode, $response->getHeaders()];
|
446 |
+
|
447 |
+
} catch (ApiException $e) {
|
448 |
+
switch ($e->getCode()) {
|
449 |
+
case 400:
|
450 |
+
$data = ObjectSerializer::deserialize(
|
451 |
+
$e->getResponseBody(),
|
452 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
453 |
+
$e->getResponseHeaders()
|
454 |
+
);
|
455 |
+
$e->setResponseObject($data);
|
456 |
+
break;
|
457 |
+
case 404:
|
458 |
+
$data = ObjectSerializer::deserialize(
|
459 |
+
$e->getResponseBody(),
|
460 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
461 |
+
$e->getResponseHeaders()
|
462 |
+
);
|
463 |
+
$e->setResponseObject($data);
|
464 |
+
break;
|
465 |
+
}
|
466 |
+
throw $e;
|
467 |
+
}
|
468 |
+
}
|
469 |
+
|
470 |
+
/**
|
471 |
+
* Operation crmFilesIdDeleteAsync
|
472 |
+
*
|
473 |
+
* Delete a file
|
474 |
+
*
|
475 |
+
* @param string $id File id to delete. (required)
|
476 |
+
*
|
477 |
+
* @throws \InvalidArgumentException
|
478 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
479 |
+
*/
|
480 |
+
public function crmFilesIdDeleteAsync($id)
|
481 |
+
{
|
482 |
+
return $this->crmFilesIdDeleteAsyncWithHttpInfo($id)
|
483 |
+
->then(
|
484 |
+
function ($response) {
|
485 |
+
return $response[0];
|
486 |
+
}
|
487 |
+
);
|
488 |
+
}
|
489 |
+
|
490 |
+
/**
|
491 |
+
* Operation crmFilesIdDeleteAsyncWithHttpInfo
|
492 |
+
*
|
493 |
+
* Delete a file
|
494 |
+
*
|
495 |
+
* @param string $id File id to delete. (required)
|
496 |
+
*
|
497 |
+
* @throws \InvalidArgumentException
|
498 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
499 |
+
*/
|
500 |
+
public function crmFilesIdDeleteAsyncWithHttpInfo($id)
|
501 |
+
{
|
502 |
+
$returnType = '';
|
503 |
+
$request = $this->crmFilesIdDeleteRequest($id);
|
504 |
+
|
505 |
+
return $this->client
|
506 |
+
->sendAsync($request, $this->createHttpClientOption())
|
507 |
+
->then(
|
508 |
+
function ($response) use ($returnType) {
|
509 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
510 |
+
},
|
511 |
+
function ($exception) {
|
512 |
+
$response = $exception->getResponse();
|
513 |
+
$statusCode = $response->getStatusCode();
|
514 |
+
throw new ApiException(
|
515 |
+
sprintf(
|
516 |
+
'[%d] Error connecting to the API (%s)',
|
517 |
+
$statusCode,
|
518 |
+
$exception->getRequest()->getUri()
|
519 |
+
),
|
520 |
+
$statusCode,
|
521 |
+
$response->getHeaders(),
|
522 |
+
$response->getBody()
|
523 |
+
);
|
524 |
+
}
|
525 |
+
);
|
526 |
+
}
|
527 |
+
|
528 |
+
/**
|
529 |
+
* Create request for operation 'crmFilesIdDelete'
|
530 |
+
*
|
531 |
+
* @param string $id File id to delete. (required)
|
532 |
+
*
|
533 |
+
* @throws \InvalidArgumentException
|
534 |
+
* @return \GuzzleHttp\Psr7\Request
|
535 |
+
*/
|
536 |
+
protected function crmFilesIdDeleteRequest($id)
|
537 |
+
{
|
538 |
+
// verify the required parameter 'id' is set
|
539 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
540 |
+
throw new \InvalidArgumentException(
|
541 |
+
'Missing the required parameter $id when calling crmFilesIdDelete'
|
542 |
+
);
|
543 |
+
}
|
544 |
+
|
545 |
+
$resourcePath = '/crm/files/{id}';
|
546 |
+
$formParams = [];
|
547 |
+
$queryParams = [];
|
548 |
+
$headerParams = [];
|
549 |
+
$httpBody = '';
|
550 |
+
$multipart = false;
|
551 |
+
|
552 |
+
|
553 |
+
// path params
|
554 |
+
if ($id !== null) {
|
555 |
+
$resourcePath = str_replace(
|
556 |
+
'{' . 'id' . '}',
|
557 |
+
ObjectSerializer::toPathValue($id),
|
558 |
+
$resourcePath
|
559 |
+
);
|
560 |
+
}
|
561 |
+
|
562 |
+
// body params
|
563 |
+
$_tempBody = null;
|
564 |
+
|
565 |
+
if ($multipart) {
|
566 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
567 |
+
['application/json']
|
568 |
+
);
|
569 |
+
} else {
|
570 |
+
$headers = $this->headerSelector->selectHeaders(
|
571 |
+
['application/json'],
|
572 |
+
['application/json']
|
573 |
+
);
|
574 |
+
}
|
575 |
+
|
576 |
+
// for model (json/xml)
|
577 |
+
if (isset($_tempBody)) {
|
578 |
+
// $_tempBody is the method argument, if present
|
579 |
+
$httpBody = $_tempBody;
|
580 |
+
|
581 |
+
if($headers['Content-Type'] === 'application/json') {
|
582 |
+
// \stdClass has no __toString(), so we should encode it manually
|
583 |
+
if ($httpBody instanceof \stdClass) {
|
584 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
585 |
+
}
|
586 |
+
// array has no __toString(), so we should encode it manually
|
587 |
+
if(is_array($httpBody)) {
|
588 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
589 |
+
}
|
590 |
+
}
|
591 |
+
} elseif (count($formParams) > 0) {
|
592 |
+
if ($multipart) {
|
593 |
+
$multipartContents = [];
|
594 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
595 |
+
$multipartContents[] = [
|
596 |
+
'name' => $formParamName,
|
597 |
+
'contents' => $formParamValue
|
598 |
+
];
|
599 |
+
}
|
600 |
+
// for HTTP post (form)
|
601 |
+
$httpBody = new MultipartStream($multipartContents);
|
602 |
+
|
603 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
604 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
605 |
+
|
606 |
+
} else {
|
607 |
+
// for HTTP post (form)
|
608 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
609 |
+
}
|
610 |
+
}
|
611 |
+
|
612 |
+
// this endpoint requires API key authentication
|
613 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
614 |
+
if ($apiKey !== null) {
|
615 |
+
$headers['api-key'] = $apiKey;
|
616 |
+
}
|
617 |
+
// this endpoint requires API key authentication
|
618 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
619 |
+
if ($apiKey !== null) {
|
620 |
+
$headers['partner-key'] = $apiKey;
|
621 |
+
}
|
622 |
+
|
623 |
+
$defaultHeaders = [];
|
624 |
+
if ($this->config->getUserAgent()) {
|
625 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
626 |
+
}
|
627 |
+
|
628 |
+
$headers = array_merge(
|
629 |
+
$defaultHeaders,
|
630 |
+
$headerParams,
|
631 |
+
$headers
|
632 |
+
);
|
633 |
+
|
634 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
635 |
+
return new Request(
|
636 |
+
'DELETE',
|
637 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
638 |
+
$headers,
|
639 |
+
$httpBody
|
640 |
+
);
|
641 |
+
}
|
642 |
+
|
643 |
+
/**
|
644 |
+
* Operation crmFilesIdGet
|
645 |
+
*
|
646 |
+
* Download a file
|
647 |
+
*
|
648 |
+
* @param string $id File id to download. (required)
|
649 |
+
*
|
650 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
651 |
+
* @throws \InvalidArgumentException
|
652 |
+
* @return void
|
653 |
+
*/
|
654 |
+
public function crmFilesIdGet($id)
|
655 |
+
{
|
656 |
+
$this->crmFilesIdGetWithHttpInfo($id);
|
657 |
+
}
|
658 |
+
|
659 |
+
/**
|
660 |
+
* Operation crmFilesIdGetWithHttpInfo
|
661 |
+
*
|
662 |
+
* Download a file
|
663 |
+
*
|
664 |
+
* @param string $id File id to download. (required)
|
665 |
+
*
|
666 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
667 |
+
* @throws \InvalidArgumentException
|
668 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
669 |
+
*/
|
670 |
+
public function crmFilesIdGetWithHttpInfo($id)
|
671 |
+
{
|
672 |
+
$returnType = '';
|
673 |
+
$request = $this->crmFilesIdGetRequest($id);
|
674 |
+
|
675 |
+
try {
|
676 |
+
$options = $this->createHttpClientOption();
|
677 |
+
try {
|
678 |
+
$response = $this->client->send($request, $options);
|
679 |
+
} catch (RequestException $e) {
|
680 |
+
throw new ApiException(
|
681 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
682 |
+
$e->getCode(),
|
683 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
684 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
685 |
+
);
|
686 |
+
}
|
687 |
+
|
688 |
+
$statusCode = $response->getStatusCode();
|
689 |
+
|
690 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
691 |
+
throw new ApiException(
|
692 |
+
sprintf(
|
693 |
+
'[%d] Error connecting to the API (%s)',
|
694 |
+
$statusCode,
|
695 |
+
$request->getUri()
|
696 |
+
),
|
697 |
+
$statusCode,
|
698 |
+
$response->getHeaders(),
|
699 |
+
$response->getBody()
|
700 |
+
);
|
701 |
+
}
|
702 |
+
|
703 |
+
return [null, $statusCode, $response->getHeaders()];
|
704 |
+
|
705 |
+
} catch (ApiException $e) {
|
706 |
+
switch ($e->getCode()) {
|
707 |
+
case 400:
|
708 |
+
$data = ObjectSerializer::deserialize(
|
709 |
+
$e->getResponseBody(),
|
710 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
711 |
+
$e->getResponseHeaders()
|
712 |
+
);
|
713 |
+
$e->setResponseObject($data);
|
714 |
+
break;
|
715 |
+
case 404:
|
716 |
+
$data = ObjectSerializer::deserialize(
|
717 |
+
$e->getResponseBody(),
|
718 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
719 |
+
$e->getResponseHeaders()
|
720 |
+
);
|
721 |
+
$e->setResponseObject($data);
|
722 |
+
break;
|
723 |
+
}
|
724 |
+
throw $e;
|
725 |
+
}
|
726 |
+
}
|
727 |
+
|
728 |
+
/**
|
729 |
+
* Operation crmFilesIdGetAsync
|
730 |
+
*
|
731 |
+
* Download a file
|
732 |
+
*
|
733 |
+
* @param string $id File id to download. (required)
|
734 |
+
*
|
735 |
+
* @throws \InvalidArgumentException
|
736 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
737 |
+
*/
|
738 |
+
public function crmFilesIdGetAsync($id)
|
739 |
+
{
|
740 |
+
return $this->crmFilesIdGetAsyncWithHttpInfo($id)
|
741 |
+
->then(
|
742 |
+
function ($response) {
|
743 |
+
return $response[0];
|
744 |
+
}
|
745 |
+
);
|
746 |
+
}
|
747 |
+
|
748 |
+
/**
|
749 |
+
* Operation crmFilesIdGetAsyncWithHttpInfo
|
750 |
+
*
|
751 |
+
* Download a file
|
752 |
+
*
|
753 |
+
* @param string $id File id to download. (required)
|
754 |
+
*
|
755 |
+
* @throws \InvalidArgumentException
|
756 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
757 |
+
*/
|
758 |
+
public function crmFilesIdGetAsyncWithHttpInfo($id)
|
759 |
+
{
|
760 |
+
$returnType = '';
|
761 |
+
$request = $this->crmFilesIdGetRequest($id);
|
762 |
+
|
763 |
+
return $this->client
|
764 |
+
->sendAsync($request, $this->createHttpClientOption())
|
765 |
+
->then(
|
766 |
+
function ($response) use ($returnType) {
|
767 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
768 |
+
},
|
769 |
+
function ($exception) {
|
770 |
+
$response = $exception->getResponse();
|
771 |
+
$statusCode = $response->getStatusCode();
|
772 |
+
throw new ApiException(
|
773 |
+
sprintf(
|
774 |
+
'[%d] Error connecting to the API (%s)',
|
775 |
+
$statusCode,
|
776 |
+
$exception->getRequest()->getUri()
|
777 |
+
),
|
778 |
+
$statusCode,
|
779 |
+
$response->getHeaders(),
|
780 |
+
$response->getBody()
|
781 |
+
);
|
782 |
+
}
|
783 |
+
);
|
784 |
+
}
|
785 |
+
|
786 |
+
/**
|
787 |
+
* Create request for operation 'crmFilesIdGet'
|
788 |
+
*
|
789 |
+
* @param string $id File id to download. (required)
|
790 |
+
*
|
791 |
+
* @throws \InvalidArgumentException
|
792 |
+
* @return \GuzzleHttp\Psr7\Request
|
793 |
+
*/
|
794 |
+
protected function crmFilesIdGetRequest($id)
|
795 |
+
{
|
796 |
+
// verify the required parameter 'id' is set
|
797 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
798 |
+
throw new \InvalidArgumentException(
|
799 |
+
'Missing the required parameter $id when calling crmFilesIdGet'
|
800 |
+
);
|
801 |
+
}
|
802 |
+
|
803 |
+
$resourcePath = '/crm/files/{id}';
|
804 |
+
$formParams = [];
|
805 |
+
$queryParams = [];
|
806 |
+
$headerParams = [];
|
807 |
+
$httpBody = '';
|
808 |
+
$multipart = false;
|
809 |
+
|
810 |
+
|
811 |
+
// path params
|
812 |
+
if ($id !== null) {
|
813 |
+
$resourcePath = str_replace(
|
814 |
+
'{' . 'id' . '}',
|
815 |
+
ObjectSerializer::toPathValue($id),
|
816 |
+
$resourcePath
|
817 |
+
);
|
818 |
+
}
|
819 |
+
|
820 |
+
// body params
|
821 |
+
$_tempBody = null;
|
822 |
+
|
823 |
+
if ($multipart) {
|
824 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
825 |
+
['application/json']
|
826 |
+
);
|
827 |
+
} else {
|
828 |
+
$headers = $this->headerSelector->selectHeaders(
|
829 |
+
['application/json'],
|
830 |
+
['application/json']
|
831 |
+
);
|
832 |
+
}
|
833 |
+
|
834 |
+
// for model (json/xml)
|
835 |
+
if (isset($_tempBody)) {
|
836 |
+
// $_tempBody is the method argument, if present
|
837 |
+
$httpBody = $_tempBody;
|
838 |
+
|
839 |
+
if($headers['Content-Type'] === 'application/json') {
|
840 |
+
// \stdClass has no __toString(), so we should encode it manually
|
841 |
+
if ($httpBody instanceof \stdClass) {
|
842 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
843 |
+
}
|
844 |
+
// array has no __toString(), so we should encode it manually
|
845 |
+
if(is_array($httpBody)) {
|
846 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
847 |
+
}
|
848 |
+
}
|
849 |
+
} elseif (count($formParams) > 0) {
|
850 |
+
if ($multipart) {
|
851 |
+
$multipartContents = [];
|
852 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
853 |
+
$multipartContents[] = [
|
854 |
+
'name' => $formParamName,
|
855 |
+
'contents' => $formParamValue
|
856 |
+
];
|
857 |
+
}
|
858 |
+
// for HTTP post (form)
|
859 |
+
$httpBody = new MultipartStream($multipartContents);
|
860 |
+
|
861 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
862 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
863 |
+
|
864 |
+
} else {
|
865 |
+
// for HTTP post (form)
|
866 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
867 |
+
}
|
868 |
+
}
|
869 |
+
|
870 |
+
// this endpoint requires API key authentication
|
871 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
872 |
+
if ($apiKey !== null) {
|
873 |
+
$headers['api-key'] = $apiKey;
|
874 |
+
}
|
875 |
+
// this endpoint requires API key authentication
|
876 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
877 |
+
if ($apiKey !== null) {
|
878 |
+
$headers['partner-key'] = $apiKey;
|
879 |
+
}
|
880 |
+
|
881 |
+
$defaultHeaders = [];
|
882 |
+
if ($this->config->getUserAgent()) {
|
883 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
884 |
+
}
|
885 |
+
|
886 |
+
$headers = array_merge(
|
887 |
+
$defaultHeaders,
|
888 |
+
$headerParams,
|
889 |
+
$headers
|
890 |
+
);
|
891 |
+
|
892 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
893 |
+
return new Request(
|
894 |
+
'GET',
|
895 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
896 |
+
$headers,
|
897 |
+
$httpBody
|
898 |
+
);
|
899 |
+
}
|
900 |
+
|
901 |
+
/**
|
902 |
+
* Operation crmFilesPost
|
903 |
+
*
|
904 |
+
* Upload a file
|
905 |
+
*
|
906 |
+
* @param \SplFileObject $file File data to create a file. (required)
|
907 |
+
* @param string[] $dealsIds Deal ids linked to a file (optional)
|
908 |
+
*
|
909 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
910 |
+
* @throws \InvalidArgumentException
|
911 |
+
* @return \SendinBlue\Client\Model\FileData
|
912 |
+
*/
|
913 |
+
public function crmFilesPost($file, $dealsIds = null)
|
914 |
+
{
|
915 |
+
list($response) = $this->crmFilesPostWithHttpInfo($file, $dealsIds);
|
916 |
+
return $response;
|
917 |
+
}
|
918 |
+
|
919 |
+
/**
|
920 |
+
* Operation crmFilesPostWithHttpInfo
|
921 |
+
*
|
922 |
+
* Upload a file
|
923 |
+
*
|
924 |
+
* @param \SplFileObject $file File data to create a file. (required)
|
925 |
+
* @param string[] $dealsIds Deal ids linked to a file (optional)
|
926 |
+
*
|
927 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
928 |
+
* @throws \InvalidArgumentException
|
929 |
+
* @return array of \SendinBlue\Client\Model\FileData, HTTP status code, HTTP response headers (array of strings)
|
930 |
+
*/
|
931 |
+
public function crmFilesPostWithHttpInfo($file, $dealsIds = null)
|
932 |
+
{
|
933 |
+
$returnType = '\SendinBlue\Client\Model\FileData';
|
934 |
+
$request = $this->crmFilesPostRequest($file, $dealsIds);
|
935 |
+
|
936 |
+
try {
|
937 |
+
$options = $this->createHttpClientOption();
|
938 |
+
try {
|
939 |
+
$response = $this->client->send($request, $options);
|
940 |
+
} catch (RequestException $e) {
|
941 |
+
throw new ApiException(
|
942 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
943 |
+
$e->getCode(),
|
944 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
945 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
946 |
+
);
|
947 |
+
}
|
948 |
+
|
949 |
+
$statusCode = $response->getStatusCode();
|
950 |
+
|
951 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
952 |
+
throw new ApiException(
|
953 |
+
sprintf(
|
954 |
+
'[%d] Error connecting to the API (%s)',
|
955 |
+
$statusCode,
|
956 |
+
$request->getUri()
|
957 |
+
),
|
958 |
+
$statusCode,
|
959 |
+
$response->getHeaders(),
|
960 |
+
$response->getBody()
|
961 |
+
);
|
962 |
+
}
|
963 |
+
|
964 |
+
$responseBody = $response->getBody();
|
965 |
+
if ($returnType === '\SplFileObject') {
|
966 |
+
$content = $responseBody; //stream goes to serializer
|
967 |
+
} else {
|
968 |
+
$content = $responseBody->getContents();
|
969 |
+
if ($returnType !== 'string') {
|
970 |
+
$content = json_decode($content);
|
971 |
+
}
|
972 |
+
}
|
973 |
+
|
974 |
+
return [
|
975 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
976 |
+
$response->getStatusCode(),
|
977 |
+
$response->getHeaders()
|
978 |
+
];
|
979 |
+
|
980 |
+
} catch (ApiException $e) {
|
981 |
+
switch ($e->getCode()) {
|
982 |
+
case 201:
|
983 |
+
$data = ObjectSerializer::deserialize(
|
984 |
+
$e->getResponseBody(),
|
985 |
+
'\SendinBlue\Client\Model\FileData',
|
986 |
+
$e->getResponseHeaders()
|
987 |
+
);
|
988 |
+
$e->setResponseObject($data);
|
989 |
+
break;
|
990 |
+
case 400:
|
991 |
+
$data = ObjectSerializer::deserialize(
|
992 |
+
$e->getResponseBody(),
|
993 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
994 |
+
$e->getResponseHeaders()
|
995 |
+
);
|
996 |
+
$e->setResponseObject($data);
|
997 |
+
break;
|
998 |
+
}
|
999 |
+
throw $e;
|
1000 |
+
}
|
1001 |
+
}
|
1002 |
+
|
1003 |
+
/**
|
1004 |
+
* Operation crmFilesPostAsync
|
1005 |
+
*
|
1006 |
+
* Upload a file
|
1007 |
+
*
|
1008 |
+
* @param \SplFileObject $file File data to create a file. (required)
|
1009 |
+
* @param string[] $dealsIds Deal ids linked to a file (optional)
|
1010 |
+
*
|
1011 |
+
* @throws \InvalidArgumentException
|
1012 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1013 |
+
*/
|
1014 |
+
public function crmFilesPostAsync($file, $dealsIds = null)
|
1015 |
+
{
|
1016 |
+
return $this->crmFilesPostAsyncWithHttpInfo($file, $dealsIds)
|
1017 |
+
->then(
|
1018 |
+
function ($response) {
|
1019 |
+
return $response[0];
|
1020 |
+
}
|
1021 |
+
);
|
1022 |
+
}
|
1023 |
+
|
1024 |
+
/**
|
1025 |
+
* Operation crmFilesPostAsyncWithHttpInfo
|
1026 |
+
*
|
1027 |
+
* Upload a file
|
1028 |
+
*
|
1029 |
+
* @param \SplFileObject $file File data to create a file. (required)
|
1030 |
+
* @param string[] $dealsIds Deal ids linked to a file (optional)
|
1031 |
+
*
|
1032 |
+
* @throws \InvalidArgumentException
|
1033 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1034 |
+
*/
|
1035 |
+
public function crmFilesPostAsyncWithHttpInfo($file, $dealsIds = null)
|
1036 |
+
{
|
1037 |
+
$returnType = '\SendinBlue\Client\Model\FileData';
|
1038 |
+
$request = $this->crmFilesPostRequest($file, $dealsIds);
|
1039 |
+
|
1040 |
+
return $this->client
|
1041 |
+
->sendAsync($request, $this->createHttpClientOption())
|
1042 |
+
->then(
|
1043 |
+
function ($response) use ($returnType) {
|
1044 |
+
$responseBody = $response->getBody();
|
1045 |
+
if ($returnType === '\SplFileObject') {
|
1046 |
+
$content = $responseBody; //stream goes to serializer
|
1047 |
+
} else {
|
1048 |
+
$content = $responseBody->getContents();
|
1049 |
+
if ($returnType !== 'string') {
|
1050 |
+
$content = json_decode($content);
|
1051 |
+
}
|
1052 |
+
}
|
1053 |
+
|
1054 |
+
return [
|
1055 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
1056 |
+
$response->getStatusCode(),
|
1057 |
+
$response->getHeaders()
|
1058 |
+
];
|
1059 |
+
},
|
1060 |
+
function ($exception) {
|
1061 |
+
$response = $exception->getResponse();
|
1062 |
+
$statusCode = $response->getStatusCode();
|
1063 |
+
throw new ApiException(
|
1064 |
+
sprintf(
|
1065 |
+
'[%d] Error connecting to the API (%s)',
|
1066 |
+
$statusCode,
|
1067 |
+
$exception->getRequest()->getUri()
|
1068 |
+
),
|
1069 |
+
$statusCode,
|
1070 |
+
$response->getHeaders(),
|
1071 |
+
$response->getBody()
|
1072 |
+
);
|
1073 |
+
}
|
1074 |
+
);
|
1075 |
+
}
|
1076 |
+
|
1077 |
+
/**
|
1078 |
+
* Create request for operation 'crmFilesPost'
|
1079 |
+
*
|
1080 |
+
* @param \SplFileObject $file File data to create a file. (required)
|
1081 |
+
* @param string[] $dealsIds Deal ids linked to a file (optional)
|
1082 |
+
*
|
1083 |
+
* @throws \InvalidArgumentException
|
1084 |
+
* @return \GuzzleHttp\Psr7\Request
|
1085 |
+
*/
|
1086 |
+
protected function crmFilesPostRequest($file, $dealsIds = null)
|
1087 |
+
{
|
1088 |
+
// verify the required parameter 'file' is set
|
1089 |
+
if ($file === null || (is_array($file) && count($file) === 0)) {
|
1090 |
+
throw new \InvalidArgumentException(
|
1091 |
+
'Missing the required parameter $file when calling crmFilesPost'
|
1092 |
+
);
|
1093 |
+
}
|
1094 |
+
|
1095 |
+
$resourcePath = '/crm/files';
|
1096 |
+
$formParams = [];
|
1097 |
+
$queryParams = [];
|
1098 |
+
$headerParams = [];
|
1099 |
+
$httpBody = '';
|
1100 |
+
$multipart = false;
|
1101 |
+
|
1102 |
+
|
1103 |
+
|
1104 |
+
// form params
|
1105 |
+
if ($file !== null) {
|
1106 |
+
$multipart = true;
|
1107 |
+
$formParams['file'] = \GuzzleHttp\Psr7\try_fopen(ObjectSerializer::toFormValue($file), 'rb');
|
1108 |
+
}
|
1109 |
+
// form params
|
1110 |
+
if ($dealsIds !== null) {
|
1111 |
+
$formParams['dealsIds'] = ObjectSerializer::toFormValue($dealsIds);
|
1112 |
+
}
|
1113 |
+
// body params
|
1114 |
+
$_tempBody = null;
|
1115 |
+
|
1116 |
+
if ($multipart) {
|
1117 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
1118 |
+
['application/json']
|
1119 |
+
);
|
1120 |
+
} else {
|
1121 |
+
$headers = $this->headerSelector->selectHeaders(
|
1122 |
+
['application/json'],
|
1123 |
+
['multipart/form-data']
|
1124 |
+
);
|
1125 |
+
}
|
1126 |
+
|
1127 |
+
// for model (json/xml)
|
1128 |
+
if (isset($_tempBody)) {
|
1129 |
+
// $_tempBody is the method argument, if present
|
1130 |
+
$httpBody = $_tempBody;
|
1131 |
+
|
1132 |
+
if($headers['Content-Type'] === 'application/json') {
|
1133 |
+
// \stdClass has no __toString(), so we should encode it manually
|
1134 |
+
if ($httpBody instanceof \stdClass) {
|
1135 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
1136 |
+
}
|
1137 |
+
// array has no __toString(), so we should encode it manually
|
1138 |
+
if(is_array($httpBody)) {
|
1139 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
1140 |
+
}
|
1141 |
+
}
|
1142 |
+
} elseif (count($formParams) > 0) {
|
1143 |
+
if ($multipart) {
|
1144 |
+
$multipartContents = [];
|
1145 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
1146 |
+
$multipartContents[] = [
|
1147 |
+
'name' => $formParamName,
|
1148 |
+
'contents' => $formParamValue
|
1149 |
+
];
|
1150 |
+
}
|
1151 |
+
// for HTTP post (form)
|
1152 |
+
$httpBody = new MultipartStream($multipartContents);
|
1153 |
+
|
1154 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
1155 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
1156 |
+
|
1157 |
+
} else {
|
1158 |
+
// for HTTP post (form)
|
1159 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
1160 |
+
}
|
1161 |
+
}
|
1162 |
+
|
1163 |
+
// this endpoint requires API key authentication
|
1164 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
1165 |
+
if ($apiKey !== null) {
|
1166 |
+
$headers['api-key'] = $apiKey;
|
1167 |
+
}
|
1168 |
+
// this endpoint requires API key authentication
|
1169 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
1170 |
+
if ($apiKey !== null) {
|
1171 |
+
$headers['partner-key'] = $apiKey;
|
1172 |
+
}
|
1173 |
+
|
1174 |
+
$defaultHeaders = [];
|
1175 |
+
if ($this->config->getUserAgent()) {
|
1176 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
1177 |
+
}
|
1178 |
+
|
1179 |
+
$headers = array_merge(
|
1180 |
+
$defaultHeaders,
|
1181 |
+
$headerParams,
|
1182 |
+
$headers
|
1183 |
+
);
|
1184 |
+
|
1185 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
1186 |
+
return new Request(
|
1187 |
+
'POST',
|
1188 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
1189 |
+
$headers,
|
1190 |
+
$httpBody
|
1191 |
+
);
|
1192 |
+
}
|
1193 |
+
|
1194 |
+
/**
|
1195 |
+
* Operation crmNotesIdDelete
|
1196 |
+
*
|
1197 |
+
* Delete a note
|
1198 |
+
*
|
1199 |
+
* @param string $id Note ID to delete (required)
|
1200 |
+
*
|
1201 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
1202 |
+
* @throws \InvalidArgumentException
|
1203 |
+
* @return void
|
1204 |
+
*/
|
1205 |
+
public function crmNotesIdDelete($id)
|
1206 |
+
{
|
1207 |
+
$this->crmNotesIdDeleteWithHttpInfo($id);
|
1208 |
+
}
|
1209 |
+
|
1210 |
+
/**
|
1211 |
+
* Operation crmNotesIdDeleteWithHttpInfo
|
1212 |
+
*
|
1213 |
+
* Delete a note
|
1214 |
+
*
|
1215 |
+
* @param string $id Note ID to delete (required)
|
1216 |
+
*
|
1217 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
1218 |
+
* @throws \InvalidArgumentException
|
1219 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
1220 |
+
*/
|
1221 |
+
public function crmNotesIdDeleteWithHttpInfo($id)
|
1222 |
+
{
|
1223 |
+
$returnType = '';
|
1224 |
+
$request = $this->crmNotesIdDeleteRequest($id);
|
1225 |
+
|
1226 |
+
try {
|
1227 |
+
$options = $this->createHttpClientOption();
|
1228 |
+
try {
|
1229 |
+
$response = $this->client->send($request, $options);
|
1230 |
+
} catch (RequestException $e) {
|
1231 |
+
throw new ApiException(
|
1232 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
1233 |
+
$e->getCode(),
|
1234 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
1235 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
1236 |
+
);
|
1237 |
+
}
|
1238 |
+
|
1239 |
+
$statusCode = $response->getStatusCode();
|
1240 |
+
|
1241 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
1242 |
+
throw new ApiException(
|
1243 |
+
sprintf(
|
1244 |
+
'[%d] Error connecting to the API (%s)',
|
1245 |
+
$statusCode,
|
1246 |
+
$request->getUri()
|
1247 |
+
),
|
1248 |
+
$statusCode,
|
1249 |
+
$response->getHeaders(),
|
1250 |
+
$response->getBody()
|
1251 |
+
);
|
1252 |
+
}
|
1253 |
+
|
1254 |
+
return [null, $statusCode, $response->getHeaders()];
|
1255 |
+
|
1256 |
+
} catch (ApiException $e) {
|
1257 |
+
switch ($e->getCode()) {
|
1258 |
+
case 400:
|
1259 |
+
$data = ObjectSerializer::deserialize(
|
1260 |
+
$e->getResponseBody(),
|
1261 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1262 |
+
$e->getResponseHeaders()
|
1263 |
+
);
|
1264 |
+
$e->setResponseObject($data);
|
1265 |
+
break;
|
1266 |
+
case 404:
|
1267 |
+
$data = ObjectSerializer::deserialize(
|
1268 |
+
$e->getResponseBody(),
|
1269 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1270 |
+
$e->getResponseHeaders()
|
1271 |
+
);
|
1272 |
+
$e->setResponseObject($data);
|
1273 |
+
break;
|
1274 |
+
}
|
1275 |
+
throw $e;
|
1276 |
+
}
|
1277 |
+
}
|
1278 |
+
|
1279 |
+
/**
|
1280 |
+
* Operation crmNotesIdDeleteAsync
|
1281 |
+
*
|
1282 |
+
* Delete a note
|
1283 |
+
*
|
1284 |
+
* @param string $id Note ID to delete (required)
|
1285 |
+
*
|
1286 |
+
* @throws \InvalidArgumentException
|
1287 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1288 |
+
*/
|
1289 |
+
public function crmNotesIdDeleteAsync($id)
|
1290 |
+
{
|
1291 |
+
return $this->crmNotesIdDeleteAsyncWithHttpInfo($id)
|
1292 |
+
->then(
|
1293 |
+
function ($response) {
|
1294 |
+
return $response[0];
|
1295 |
+
}
|
1296 |
+
);
|
1297 |
+
}
|
1298 |
+
|
1299 |
+
/**
|
1300 |
+
* Operation crmNotesIdDeleteAsyncWithHttpInfo
|
1301 |
+
*
|
1302 |
+
* Delete a note
|
1303 |
+
*
|
1304 |
+
* @param string $id Note ID to delete (required)
|
1305 |
+
*
|
1306 |
+
* @throws \InvalidArgumentException
|
1307 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1308 |
+
*/
|
1309 |
+
public function crmNotesIdDeleteAsyncWithHttpInfo($id)
|
1310 |
+
{
|
1311 |
+
$returnType = '';
|
1312 |
+
$request = $this->crmNotesIdDeleteRequest($id);
|
1313 |
+
|
1314 |
+
return $this->client
|
1315 |
+
->sendAsync($request, $this->createHttpClientOption())
|
1316 |
+
->then(
|
1317 |
+
function ($response) use ($returnType) {
|
1318 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
1319 |
+
},
|
1320 |
+
function ($exception) {
|
1321 |
+
$response = $exception->getResponse();
|
1322 |
+
$statusCode = $response->getStatusCode();
|
1323 |
+
throw new ApiException(
|
1324 |
+
sprintf(
|
1325 |
+
'[%d] Error connecting to the API (%s)',
|
1326 |
+
$statusCode,
|
1327 |
+
$exception->getRequest()->getUri()
|
1328 |
+
),
|
1329 |
+
$statusCode,
|
1330 |
+
$response->getHeaders(),
|
1331 |
+
$response->getBody()
|
1332 |
+
);
|
1333 |
+
}
|
1334 |
+
);
|
1335 |
+
}
|
1336 |
+
|
1337 |
+
/**
|
1338 |
+
* Create request for operation 'crmNotesIdDelete'
|
1339 |
+
*
|
1340 |
+
* @param string $id Note ID to delete (required)
|
1341 |
+
*
|
1342 |
+
* @throws \InvalidArgumentException
|
1343 |
+
* @return \GuzzleHttp\Psr7\Request
|
1344 |
+
*/
|
1345 |
+
protected function crmNotesIdDeleteRequest($id)
|
1346 |
+
{
|
1347 |
+
// verify the required parameter 'id' is set
|
1348 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
1349 |
+
throw new \InvalidArgumentException(
|
1350 |
+
'Missing the required parameter $id when calling crmNotesIdDelete'
|
1351 |
+
);
|
1352 |
+
}
|
1353 |
+
|
1354 |
+
$resourcePath = '/crm/notes/{id}';
|
1355 |
+
$formParams = [];
|
1356 |
+
$queryParams = [];
|
1357 |
+
$headerParams = [];
|
1358 |
+
$httpBody = '';
|
1359 |
+
$multipart = false;
|
1360 |
+
|
1361 |
+
|
1362 |
+
// path params
|
1363 |
+
if ($id !== null) {
|
1364 |
+
$resourcePath = str_replace(
|
1365 |
+
'{' . 'id' . '}',
|
1366 |
+
ObjectSerializer::toPathValue($id),
|
1367 |
+
$resourcePath
|
1368 |
+
);
|
1369 |
+
}
|
1370 |
+
|
1371 |
+
// body params
|
1372 |
+
$_tempBody = null;
|
1373 |
+
|
1374 |
+
if ($multipart) {
|
1375 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
1376 |
+
['application/json']
|
1377 |
+
);
|
1378 |
+
} else {
|
1379 |
+
$headers = $this->headerSelector->selectHeaders(
|
1380 |
+
['application/json'],
|
1381 |
+
['application/json']
|
1382 |
+
);
|
1383 |
+
}
|
1384 |
+
|
1385 |
+
// for model (json/xml)
|
1386 |
+
if (isset($_tempBody)) {
|
1387 |
+
// $_tempBody is the method argument, if present
|
1388 |
+
$httpBody = $_tempBody;
|
1389 |
+
|
1390 |
+
if($headers['Content-Type'] === 'application/json') {
|
1391 |
+
// \stdClass has no __toString(), so we should encode it manually
|
1392 |
+
if ($httpBody instanceof \stdClass) {
|
1393 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
1394 |
+
}
|
1395 |
+
// array has no __toString(), so we should encode it manually
|
1396 |
+
if(is_array($httpBody)) {
|
1397 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
1398 |
+
}
|
1399 |
+
}
|
1400 |
+
} elseif (count($formParams) > 0) {
|
1401 |
+
if ($multipart) {
|
1402 |
+
$multipartContents = [];
|
1403 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
1404 |
+
$multipartContents[] = [
|
1405 |
+
'name' => $formParamName,
|
1406 |
+
'contents' => $formParamValue
|
1407 |
+
];
|
1408 |
+
}
|
1409 |
+
// for HTTP post (form)
|
1410 |
+
$httpBody = new MultipartStream($multipartContents);
|
1411 |
+
|
1412 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
1413 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
1414 |
+
|
1415 |
+
} else {
|
1416 |
+
// for HTTP post (form)
|
1417 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
1418 |
+
}
|
1419 |
+
}
|
1420 |
+
|
1421 |
+
// this endpoint requires API key authentication
|
1422 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
1423 |
+
if ($apiKey !== null) {
|
1424 |
+
$headers['api-key'] = $apiKey;
|
1425 |
+
}
|
1426 |
+
// this endpoint requires API key authentication
|
1427 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
1428 |
+
if ($apiKey !== null) {
|
1429 |
+
$headers['partner-key'] = $apiKey;
|
1430 |
+
}
|
1431 |
+
|
1432 |
+
$defaultHeaders = [];
|
1433 |
+
if ($this->config->getUserAgent()) {
|
1434 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
1435 |
+
}
|
1436 |
+
|
1437 |
+
$headers = array_merge(
|
1438 |
+
$defaultHeaders,
|
1439 |
+
$headerParams,
|
1440 |
+
$headers
|
1441 |
+
);
|
1442 |
+
|
1443 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
1444 |
+
return new Request(
|
1445 |
+
'DELETE',
|
1446 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
1447 |
+
$headers,
|
1448 |
+
$httpBody
|
1449 |
+
);
|
1450 |
+
}
|
1451 |
+
|
1452 |
+
/**
|
1453 |
+
* Operation crmNotesIdGet
|
1454 |
+
*
|
1455 |
+
* Get a note
|
1456 |
+
*
|
1457 |
+
* @param string $id Note ID to get (required)
|
1458 |
+
*
|
1459 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
1460 |
+
* @throws \InvalidArgumentException
|
1461 |
+
* @return \SendinBlue\Client\Model\Note
|
1462 |
+
*/
|
1463 |
+
public function crmNotesIdGet($id)
|
1464 |
+
{
|
1465 |
+
list($response) = $this->crmNotesIdGetWithHttpInfo($id);
|
1466 |
+
return $response;
|
1467 |
+
}
|
1468 |
+
|
1469 |
+
/**
|
1470 |
+
* Operation crmNotesIdGetWithHttpInfo
|
1471 |
+
*
|
1472 |
+
* Get a note
|
1473 |
+
*
|
1474 |
+
* @param string $id Note ID to get (required)
|
1475 |
+
*
|
1476 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
1477 |
+
* @throws \InvalidArgumentException
|
1478 |
+
* @return array of \SendinBlue\Client\Model\Note, HTTP status code, HTTP response headers (array of strings)
|
1479 |
+
*/
|
1480 |
+
public function crmNotesIdGetWithHttpInfo($id)
|
1481 |
+
{
|
1482 |
+
$returnType = '\SendinBlue\Client\Model\Note';
|
1483 |
+
$request = $this->crmNotesIdGetRequest($id);
|
1484 |
+
|
1485 |
+
try {
|
1486 |
+
$options = $this->createHttpClientOption();
|
1487 |
+
try {
|
1488 |
+
$response = $this->client->send($request, $options);
|
1489 |
+
} catch (RequestException $e) {
|
1490 |
+
throw new ApiException(
|
1491 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
1492 |
+
$e->getCode(),
|
1493 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
1494 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
1495 |
+
);
|
1496 |
+
}
|
1497 |
+
|
1498 |
+
$statusCode = $response->getStatusCode();
|
1499 |
+
|
1500 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
1501 |
+
throw new ApiException(
|
1502 |
+
sprintf(
|
1503 |
+
'[%d] Error connecting to the API (%s)',
|
1504 |
+
$statusCode,
|
1505 |
+
$request->getUri()
|
1506 |
+
),
|
1507 |
+
$statusCode,
|
1508 |
+
$response->getHeaders(),
|
1509 |
+
$response->getBody()
|
1510 |
+
);
|
1511 |
+
}
|
1512 |
+
|
1513 |
+
$responseBody = $response->getBody();
|
1514 |
+
if ($returnType === '\SplFileObject') {
|
1515 |
+
$content = $responseBody; //stream goes to serializer
|
1516 |
+
} else {
|
1517 |
+
$content = $responseBody->getContents();
|
1518 |
+
if ($returnType !== 'string') {
|
1519 |
+
$content = json_decode($content);
|
1520 |
+
}
|
1521 |
+
}
|
1522 |
+
|
1523 |
+
return [
|
1524 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
1525 |
+
$response->getStatusCode(),
|
1526 |
+
$response->getHeaders()
|
1527 |
+
];
|
1528 |
+
|
1529 |
+
} catch (ApiException $e) {
|
1530 |
+
switch ($e->getCode()) {
|
1531 |
+
case 200:
|
1532 |
+
$data = ObjectSerializer::deserialize(
|
1533 |
+
$e->getResponseBody(),
|
1534 |
+
'\SendinBlue\Client\Model\Note',
|
1535 |
+
$e->getResponseHeaders()
|
1536 |
+
);
|
1537 |
+
$e->setResponseObject($data);
|
1538 |
+
break;
|
1539 |
+
case 400:
|
1540 |
+
$data = ObjectSerializer::deserialize(
|
1541 |
+
$e->getResponseBody(),
|
1542 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1543 |
+
$e->getResponseHeaders()
|
1544 |
+
);
|
1545 |
+
$e->setResponseObject($data);
|
1546 |
+
break;
|
1547 |
+
case 404:
|
1548 |
+
$data = ObjectSerializer::deserialize(
|
1549 |
+
$e->getResponseBody(),
|
1550 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1551 |
+
$e->getResponseHeaders()
|
1552 |
+
);
|
1553 |
+
$e->setResponseObject($data);
|
1554 |
+
break;
|
1555 |
+
}
|
1556 |
+
throw $e;
|
1557 |
+
}
|
1558 |
+
}
|
1559 |
+
|
1560 |
+
/**
|
1561 |
+
* Operation crmNotesIdGetAsync
|
1562 |
+
*
|
1563 |
+
* Get a note
|
1564 |
+
*
|
1565 |
+
* @param string $id Note ID to get (required)
|
1566 |
+
*
|
1567 |
+
* @throws \InvalidArgumentException
|
1568 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1569 |
+
*/
|
1570 |
+
public function crmNotesIdGetAsync($id)
|
1571 |
+
{
|
1572 |
+
return $this->crmNotesIdGetAsyncWithHttpInfo($id)
|
1573 |
+
->then(
|
1574 |
+
function ($response) {
|
1575 |
+
return $response[0];
|
1576 |
+
}
|
1577 |
+
);
|
1578 |
+
}
|
1579 |
+
|
1580 |
+
/**
|
1581 |
+
* Operation crmNotesIdGetAsyncWithHttpInfo
|
1582 |
+
*
|
1583 |
+
* Get a note
|
1584 |
+
*
|
1585 |
+
* @param string $id Note ID to get (required)
|
1586 |
+
*
|
1587 |
+
* @throws \InvalidArgumentException
|
1588 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1589 |
+
*/
|
1590 |
+
public function crmNotesIdGetAsyncWithHttpInfo($id)
|
1591 |
+
{
|
1592 |
+
$returnType = '\SendinBlue\Client\Model\Note';
|
1593 |
+
$request = $this->crmNotesIdGetRequest($id);
|
1594 |
+
|
1595 |
+
return $this->client
|
1596 |
+
->sendAsync($request, $this->createHttpClientOption())
|
1597 |
+
->then(
|
1598 |
+
function ($response) use ($returnType) {
|
1599 |
+
$responseBody = $response->getBody();
|
1600 |
+
if ($returnType === '\SplFileObject') {
|
1601 |
+
$content = $responseBody; //stream goes to serializer
|
1602 |
+
} else {
|
1603 |
+
$content = $responseBody->getContents();
|
1604 |
+
if ($returnType !== 'string') {
|
1605 |
+
$content = json_decode($content);
|
1606 |
+
}
|
1607 |
+
}
|
1608 |
+
|
1609 |
+
return [
|
1610 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
1611 |
+
$response->getStatusCode(),
|
1612 |
+
$response->getHeaders()
|
1613 |
+
];
|
1614 |
+
},
|
1615 |
+
function ($exception) {
|
1616 |
+
$response = $exception->getResponse();
|
1617 |
+
$statusCode = $response->getStatusCode();
|
1618 |
+
throw new ApiException(
|
1619 |
+
sprintf(
|
1620 |
+
'[%d] Error connecting to the API (%s)',
|
1621 |
+
$statusCode,
|
1622 |
+
$exception->getRequest()->getUri()
|
1623 |
+
),
|
1624 |
+
$statusCode,
|
1625 |
+
$response->getHeaders(),
|
1626 |
+
$response->getBody()
|
1627 |
+
);
|
1628 |
+
}
|
1629 |
+
);
|
1630 |
+
}
|
1631 |
+
|
1632 |
+
/**
|
1633 |
+
* Create request for operation 'crmNotesIdGet'
|
1634 |
+
*
|
1635 |
+
* @param string $id Note ID to get (required)
|
1636 |
+
*
|
1637 |
+
* @throws \InvalidArgumentException
|
1638 |
+
* @return \GuzzleHttp\Psr7\Request
|
1639 |
+
*/
|
1640 |
+
protected function crmNotesIdGetRequest($id)
|
1641 |
+
{
|
1642 |
+
// verify the required parameter 'id' is set
|
1643 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
1644 |
+
throw new \InvalidArgumentException(
|
1645 |
+
'Missing the required parameter $id when calling crmNotesIdGet'
|
1646 |
+
);
|
1647 |
+
}
|
1648 |
+
|
1649 |
+
$resourcePath = '/crm/notes/{id}';
|
1650 |
+
$formParams = [];
|
1651 |
+
$queryParams = [];
|
1652 |
+
$headerParams = [];
|
1653 |
+
$httpBody = '';
|
1654 |
+
$multipart = false;
|
1655 |
+
|
1656 |
+
|
1657 |
+
// path params
|
1658 |
+
if ($id !== null) {
|
1659 |
+
$resourcePath = str_replace(
|
1660 |
+
'{' . 'id' . '}',
|
1661 |
+
ObjectSerializer::toPathValue($id),
|
1662 |
+
$resourcePath
|
1663 |
+
);
|
1664 |
+
}
|
1665 |
+
|
1666 |
+
// body params
|
1667 |
+
$_tempBody = null;
|
1668 |
+
|
1669 |
+
if ($multipart) {
|
1670 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
1671 |
+
['application/json']
|
1672 |
+
);
|
1673 |
+
} else {
|
1674 |
+
$headers = $this->headerSelector->selectHeaders(
|
1675 |
+
['application/json'],
|
1676 |
+
['application/json']
|
1677 |
+
);
|
1678 |
+
}
|
1679 |
+
|
1680 |
+
// for model (json/xml)
|
1681 |
+
if (isset($_tempBody)) {
|
1682 |
+
// $_tempBody is the method argument, if present
|
1683 |
+
$httpBody = $_tempBody;
|
1684 |
+
|
1685 |
+
if($headers['Content-Type'] === 'application/json') {
|
1686 |
+
// \stdClass has no __toString(), so we should encode it manually
|
1687 |
+
if ($httpBody instanceof \stdClass) {
|
1688 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
1689 |
+
}
|
1690 |
+
// array has no __toString(), so we should encode it manually
|
1691 |
+
if(is_array($httpBody)) {
|
1692 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
1693 |
+
}
|
1694 |
+
}
|
1695 |
+
} elseif (count($formParams) > 0) {
|
1696 |
+
if ($multipart) {
|
1697 |
+
$multipartContents = [];
|
1698 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
1699 |
+
$multipartContents[] = [
|
1700 |
+
'name' => $formParamName,
|
1701 |
+
'contents' => $formParamValue
|
1702 |
+
];
|
1703 |
+
}
|
1704 |
+
// for HTTP post (form)
|
1705 |
+
$httpBody = new MultipartStream($multipartContents);
|
1706 |
+
|
1707 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
1708 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
1709 |
+
|
1710 |
+
} else {
|
1711 |
+
// for HTTP post (form)
|
1712 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
1713 |
+
}
|
1714 |
+
}
|
1715 |
+
|
1716 |
+
// this endpoint requires API key authentication
|
1717 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
1718 |
+
if ($apiKey !== null) {
|
1719 |
+
$headers['api-key'] = $apiKey;
|
1720 |
+
}
|
1721 |
+
// this endpoint requires API key authentication
|
1722 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
1723 |
+
if ($apiKey !== null) {
|
1724 |
+
$headers['partner-key'] = $apiKey;
|
1725 |
+
}
|
1726 |
+
|
1727 |
+
$defaultHeaders = [];
|
1728 |
+
if ($this->config->getUserAgent()) {
|
1729 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
1730 |
+
}
|
1731 |
+
|
1732 |
+
$headers = array_merge(
|
1733 |
+
$defaultHeaders,
|
1734 |
+
$headerParams,
|
1735 |
+
$headers
|
1736 |
+
);
|
1737 |
+
|
1738 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
1739 |
+
return new Request(
|
1740 |
+
'GET',
|
1741 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
1742 |
+
$headers,
|
1743 |
+
$httpBody
|
1744 |
+
);
|
1745 |
+
}
|
1746 |
+
|
1747 |
+
/**
|
1748 |
+
* Operation crmNotesIdPatch
|
1749 |
+
*
|
1750 |
+
* Update a note
|
1751 |
+
*
|
1752 |
+
* @param string $id Note ID to update (required)
|
1753 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to update a note (required)
|
1754 |
+
*
|
1755 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
1756 |
+
* @throws \InvalidArgumentException
|
1757 |
+
* @return \SendinBlue\Client\Model\Note
|
1758 |
+
*/
|
1759 |
+
public function crmNotesIdPatch($id, $body)
|
1760 |
+
{
|
1761 |
+
list($response) = $this->crmNotesIdPatchWithHttpInfo($id, $body);
|
1762 |
+
return $response;
|
1763 |
+
}
|
1764 |
+
|
1765 |
+
/**
|
1766 |
+
* Operation crmNotesIdPatchWithHttpInfo
|
1767 |
+
*
|
1768 |
+
* Update a note
|
1769 |
+
*
|
1770 |
+
* @param string $id Note ID to update (required)
|
1771 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to update a note (required)
|
1772 |
+
*
|
1773 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
1774 |
+
* @throws \InvalidArgumentException
|
1775 |
+
* @return array of \SendinBlue\Client\Model\Note, HTTP status code, HTTP response headers (array of strings)
|
1776 |
+
*/
|
1777 |
+
public function crmNotesIdPatchWithHttpInfo($id, $body)
|
1778 |
+
{
|
1779 |
+
$returnType = '\SendinBlue\Client\Model\Note';
|
1780 |
+
$request = $this->crmNotesIdPatchRequest($id, $body);
|
1781 |
+
|
1782 |
+
try {
|
1783 |
+
$options = $this->createHttpClientOption();
|
1784 |
+
try {
|
1785 |
+
$response = $this->client->send($request, $options);
|
1786 |
+
} catch (RequestException $e) {
|
1787 |
+
throw new ApiException(
|
1788 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
1789 |
+
$e->getCode(),
|
1790 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
1791 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
1792 |
+
);
|
1793 |
+
}
|
1794 |
+
|
1795 |
+
$statusCode = $response->getStatusCode();
|
1796 |
+
|
1797 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
1798 |
+
throw new ApiException(
|
1799 |
+
sprintf(
|
1800 |
+
'[%d] Error connecting to the API (%s)',
|
1801 |
+
$statusCode,
|
1802 |
+
$request->getUri()
|
1803 |
+
),
|
1804 |
+
$statusCode,
|
1805 |
+
$response->getHeaders(),
|
1806 |
+
$response->getBody()
|
1807 |
+
);
|
1808 |
+
}
|
1809 |
+
|
1810 |
+
$responseBody = $response->getBody();
|
1811 |
+
if ($returnType === '\SplFileObject') {
|
1812 |
+
$content = $responseBody; //stream goes to serializer
|
1813 |
+
} else {
|
1814 |
+
$content = $responseBody->getContents();
|
1815 |
+
if ($returnType !== 'string') {
|
1816 |
+
$content = json_decode($content);
|
1817 |
+
}
|
1818 |
+
}
|
1819 |
+
|
1820 |
+
return [
|
1821 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
1822 |
+
$response->getStatusCode(),
|
1823 |
+
$response->getHeaders()
|
1824 |
+
];
|
1825 |
+
|
1826 |
+
} catch (ApiException $e) {
|
1827 |
+
switch ($e->getCode()) {
|
1828 |
+
case 200:
|
1829 |
+
$data = ObjectSerializer::deserialize(
|
1830 |
+
$e->getResponseBody(),
|
1831 |
+
'\SendinBlue\Client\Model\Note',
|
1832 |
+
$e->getResponseHeaders()
|
1833 |
+
);
|
1834 |
+
$e->setResponseObject($data);
|
1835 |
+
break;
|
1836 |
+
case 400:
|
1837 |
+
$data = ObjectSerializer::deserialize(
|
1838 |
+
$e->getResponseBody(),
|
1839 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1840 |
+
$e->getResponseHeaders()
|
1841 |
+
);
|
1842 |
+
$e->setResponseObject($data);
|
1843 |
+
break;
|
1844 |
+
case 404:
|
1845 |
+
$data = ObjectSerializer::deserialize(
|
1846 |
+
$e->getResponseBody(),
|
1847 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1848 |
+
$e->getResponseHeaders()
|
1849 |
+
);
|
1850 |
+
$e->setResponseObject($data);
|
1851 |
+
break;
|
1852 |
+
case 415:
|
1853 |
+
$data = ObjectSerializer::deserialize(
|
1854 |
+
$e->getResponseBody(),
|
1855 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
1856 |
+
$e->getResponseHeaders()
|
1857 |
+
);
|
1858 |
+
$e->setResponseObject($data);
|
1859 |
+
break;
|
1860 |
+
}
|
1861 |
+
throw $e;
|
1862 |
+
}
|
1863 |
+
}
|
1864 |
+
|
1865 |
+
/**
|
1866 |
+
* Operation crmNotesIdPatchAsync
|
1867 |
+
*
|
1868 |
+
* Update a note
|
1869 |
+
*
|
1870 |
+
* @param string $id Note ID to update (required)
|
1871 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to update a note (required)
|
1872 |
+
*
|
1873 |
+
* @throws \InvalidArgumentException
|
1874 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1875 |
+
*/
|
1876 |
+
public function crmNotesIdPatchAsync($id, $body)
|
1877 |
+
{
|
1878 |
+
return $this->crmNotesIdPatchAsyncWithHttpInfo($id, $body)
|
1879 |
+
->then(
|
1880 |
+
function ($response) {
|
1881 |
+
return $response[0];
|
1882 |
+
}
|
1883 |
+
);
|
1884 |
+
}
|
1885 |
+
|
1886 |
+
/**
|
1887 |
+
* Operation crmNotesIdPatchAsyncWithHttpInfo
|
1888 |
+
*
|
1889 |
+
* Update a note
|
1890 |
+
*
|
1891 |
+
* @param string $id Note ID to update (required)
|
1892 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to update a note (required)
|
1893 |
+
*
|
1894 |
+
* @throws \InvalidArgumentException
|
1895 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
1896 |
+
*/
|
1897 |
+
public function crmNotesIdPatchAsyncWithHttpInfo($id, $body)
|
1898 |
+
{
|
1899 |
+
$returnType = '\SendinBlue\Client\Model\Note';
|
1900 |
+
$request = $this->crmNotesIdPatchRequest($id, $body);
|
1901 |
+
|
1902 |
+
return $this->client
|
1903 |
+
->sendAsync($request, $this->createHttpClientOption())
|
1904 |
+
->then(
|
1905 |
+
function ($response) use ($returnType) {
|
1906 |
+
$responseBody = $response->getBody();
|
1907 |
+
if ($returnType === '\SplFileObject') {
|
1908 |
+
$content = $responseBody; //stream goes to serializer
|
1909 |
+
} else {
|
1910 |
+
$content = $responseBody->getContents();
|
1911 |
+
if ($returnType !== 'string') {
|
1912 |
+
$content = json_decode($content);
|
1913 |
+
}
|
1914 |
+
}
|
1915 |
+
|
1916 |
+
return [
|
1917 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
1918 |
+
$response->getStatusCode(),
|
1919 |
+
$response->getHeaders()
|
1920 |
+
];
|
1921 |
+
},
|
1922 |
+
function ($exception) {
|
1923 |
+
$response = $exception->getResponse();
|
1924 |
+
$statusCode = $response->getStatusCode();
|
1925 |
+
throw new ApiException(
|
1926 |
+
sprintf(
|
1927 |
+
'[%d] Error connecting to the API (%s)',
|
1928 |
+
$statusCode,
|
1929 |
+
$exception->getRequest()->getUri()
|
1930 |
+
),
|
1931 |
+
$statusCode,
|
1932 |
+
$response->getHeaders(),
|
1933 |
+
$response->getBody()
|
1934 |
+
);
|
1935 |
+
}
|
1936 |
+
);
|
1937 |
+
}
|
1938 |
+
|
1939 |
+
/**
|
1940 |
+
* Create request for operation 'crmNotesIdPatch'
|
1941 |
+
*
|
1942 |
+
* @param string $id Note ID to update (required)
|
1943 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to update a note (required)
|
1944 |
+
*
|
1945 |
+
* @throws \InvalidArgumentException
|
1946 |
+
* @return \GuzzleHttp\Psr7\Request
|
1947 |
+
*/
|
1948 |
+
protected function crmNotesIdPatchRequest($id, $body)
|
1949 |
+
{
|
1950 |
+
// verify the required parameter 'id' is set
|
1951 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
1952 |
+
throw new \InvalidArgumentException(
|
1953 |
+
'Missing the required parameter $id when calling crmNotesIdPatch'
|
1954 |
+
);
|
1955 |
+
}
|
1956 |
+
// verify the required parameter 'body' is set
|
1957 |
+
if ($body === null || (is_array($body) && count($body) === 0)) {
|
1958 |
+
throw new \InvalidArgumentException(
|
1959 |
+
'Missing the required parameter $body when calling crmNotesIdPatch'
|
1960 |
+
);
|
1961 |
+
}
|
1962 |
+
|
1963 |
+
$resourcePath = '/crm/notes/{id}';
|
1964 |
+
$formParams = [];
|
1965 |
+
$queryParams = [];
|
1966 |
+
$headerParams = [];
|
1967 |
+
$httpBody = '';
|
1968 |
+
$multipart = false;
|
1969 |
+
|
1970 |
+
|
1971 |
+
// path params
|
1972 |
+
if ($id !== null) {
|
1973 |
+
$resourcePath = str_replace(
|
1974 |
+
'{' . 'id' . '}',
|
1975 |
+
ObjectSerializer::toPathValue($id),
|
1976 |
+
$resourcePath
|
1977 |
+
);
|
1978 |
+
}
|
1979 |
+
|
1980 |
+
// body params
|
1981 |
+
$_tempBody = null;
|
1982 |
+
if (isset($body)) {
|
1983 |
+
$_tempBody = $body;
|
1984 |
+
}
|
1985 |
+
|
1986 |
+
if ($multipart) {
|
1987 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
1988 |
+
['application/json']
|
1989 |
+
);
|
1990 |
+
} else {
|
1991 |
+
$headers = $this->headerSelector->selectHeaders(
|
1992 |
+
['application/json'],
|
1993 |
+
['application/json']
|
1994 |
+
);
|
1995 |
+
}
|
1996 |
+
|
1997 |
+
// for model (json/xml)
|
1998 |
+
if (isset($_tempBody)) {
|
1999 |
+
// $_tempBody is the method argument, if present
|
2000 |
+
$httpBody = $_tempBody;
|
2001 |
+
|
2002 |
+
if($headers['Content-Type'] === 'application/json') {
|
2003 |
+
// \stdClass has no __toString(), so we should encode it manually
|
2004 |
+
if ($httpBody instanceof \stdClass) {
|
2005 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
2006 |
+
}
|
2007 |
+
// array has no __toString(), so we should encode it manually
|
2008 |
+
if(is_array($httpBody)) {
|
2009 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
2010 |
+
}
|
2011 |
+
}
|
2012 |
+
} elseif (count($formParams) > 0) {
|
2013 |
+
if ($multipart) {
|
2014 |
+
$multipartContents = [];
|
2015 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
2016 |
+
$multipartContents[] = [
|
2017 |
+
'name' => $formParamName,
|
2018 |
+
'contents' => $formParamValue
|
2019 |
+
];
|
2020 |
+
}
|
2021 |
+
// for HTTP post (form)
|
2022 |
+
$httpBody = new MultipartStream($multipartContents);
|
2023 |
+
|
2024 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
2025 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
2026 |
+
|
2027 |
+
} else {
|
2028 |
+
// for HTTP post (form)
|
2029 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
2030 |
+
}
|
2031 |
+
}
|
2032 |
+
|
2033 |
+
// this endpoint requires API key authentication
|
2034 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
2035 |
+
if ($apiKey !== null) {
|
2036 |
+
$headers['api-key'] = $apiKey;
|
2037 |
+
}
|
2038 |
+
// this endpoint requires API key authentication
|
2039 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
2040 |
+
if ($apiKey !== null) {
|
2041 |
+
$headers['partner-key'] = $apiKey;
|
2042 |
+
}
|
2043 |
+
|
2044 |
+
$defaultHeaders = [];
|
2045 |
+
if ($this->config->getUserAgent()) {
|
2046 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
2047 |
+
}
|
2048 |
+
|
2049 |
+
$headers = array_merge(
|
2050 |
+
$defaultHeaders,
|
2051 |
+
$headerParams,
|
2052 |
+
$headers
|
2053 |
+
);
|
2054 |
+
|
2055 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
2056 |
+
return new Request(
|
2057 |
+
'PATCH',
|
2058 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
2059 |
+
$headers,
|
2060 |
+
$httpBody
|
2061 |
+
);
|
2062 |
+
}
|
2063 |
+
|
2064 |
+
/**
|
2065 |
+
* Operation crmNotesPost
|
2066 |
+
*
|
2067 |
+
* Create a note
|
2068 |
+
*
|
2069 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to create a note. (required)
|
2070 |
+
*
|
2071 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2072 |
+
* @throws \InvalidArgumentException
|
2073 |
+
* @return \SendinBlue\Client\Model\Note
|
2074 |
+
*/
|
2075 |
+
public function crmNotesPost($body)
|
2076 |
+
{
|
2077 |
+
list($response) = $this->crmNotesPostWithHttpInfo($body);
|
2078 |
+
return $response;
|
2079 |
+
}
|
2080 |
+
|
2081 |
+
/**
|
2082 |
+
* Operation crmNotesPostWithHttpInfo
|
2083 |
+
*
|
2084 |
+
* Create a note
|
2085 |
+
*
|
2086 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to create a note. (required)
|
2087 |
+
*
|
2088 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2089 |
+
* @throws \InvalidArgumentException
|
2090 |
+
* @return array of \SendinBlue\Client\Model\Note, HTTP status code, HTTP response headers (array of strings)
|
2091 |
+
*/
|
2092 |
+
public function crmNotesPostWithHttpInfo($body)
|
2093 |
+
{
|
2094 |
+
$returnType = '\SendinBlue\Client\Model\Note';
|
2095 |
+
$request = $this->crmNotesPostRequest($body);
|
2096 |
+
|
2097 |
+
try {
|
2098 |
+
$options = $this->createHttpClientOption();
|
2099 |
+
try {
|
2100 |
+
$response = $this->client->send($request, $options);
|
2101 |
+
} catch (RequestException $e) {
|
2102 |
+
throw new ApiException(
|
2103 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
2104 |
+
$e->getCode(),
|
2105 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
2106 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
2107 |
+
);
|
2108 |
+
}
|
2109 |
+
|
2110 |
+
$statusCode = $response->getStatusCode();
|
2111 |
+
|
2112 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
2113 |
+
throw new ApiException(
|
2114 |
+
sprintf(
|
2115 |
+
'[%d] Error connecting to the API (%s)',
|
2116 |
+
$statusCode,
|
2117 |
+
$request->getUri()
|
2118 |
+
),
|
2119 |
+
$statusCode,
|
2120 |
+
$response->getHeaders(),
|
2121 |
+
$response->getBody()
|
2122 |
+
);
|
2123 |
+
}
|
2124 |
+
|
2125 |
+
$responseBody = $response->getBody();
|
2126 |
+
if ($returnType === '\SplFileObject') {
|
2127 |
+
$content = $responseBody; //stream goes to serializer
|
2128 |
+
} else {
|
2129 |
+
$content = $responseBody->getContents();
|
2130 |
+
if ($returnType !== 'string') {
|
2131 |
+
$content = json_decode($content);
|
2132 |
+
}
|
2133 |
+
}
|
2134 |
+
|
2135 |
+
return [
|
2136 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
2137 |
+
$response->getStatusCode(),
|
2138 |
+
$response->getHeaders()
|
2139 |
+
];
|
2140 |
+
|
2141 |
+
} catch (ApiException $e) {
|
2142 |
+
switch ($e->getCode()) {
|
2143 |
+
case 200:
|
2144 |
+
$data = ObjectSerializer::deserialize(
|
2145 |
+
$e->getResponseBody(),
|
2146 |
+
'\SendinBlue\Client\Model\Note',
|
2147 |
+
$e->getResponseHeaders()
|
2148 |
+
);
|
2149 |
+
$e->setResponseObject($data);
|
2150 |
+
break;
|
2151 |
+
case 400:
|
2152 |
+
$data = ObjectSerializer::deserialize(
|
2153 |
+
$e->getResponseBody(),
|
2154 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
2155 |
+
$e->getResponseHeaders()
|
2156 |
+
);
|
2157 |
+
$e->setResponseObject($data);
|
2158 |
+
break;
|
2159 |
+
case 415:
|
2160 |
+
$data = ObjectSerializer::deserialize(
|
2161 |
+
$e->getResponseBody(),
|
2162 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
2163 |
+
$e->getResponseHeaders()
|
2164 |
+
);
|
2165 |
+
$e->setResponseObject($data);
|
2166 |
+
break;
|
2167 |
+
}
|
2168 |
+
throw $e;
|
2169 |
+
}
|
2170 |
+
}
|
2171 |
+
|
2172 |
+
/**
|
2173 |
+
* Operation crmNotesPostAsync
|
2174 |
+
*
|
2175 |
+
* Create a note
|
2176 |
+
*
|
2177 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to create a note. (required)
|
2178 |
+
*
|
2179 |
+
* @throws \InvalidArgumentException
|
2180 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
2181 |
+
*/
|
2182 |
+
public function crmNotesPostAsync($body)
|
2183 |
+
{
|
2184 |
+
return $this->crmNotesPostAsyncWithHttpInfo($body)
|
2185 |
+
->then(
|
2186 |
+
function ($response) {
|
2187 |
+
return $response[0];
|
2188 |
+
}
|
2189 |
+
);
|
2190 |
+
}
|
2191 |
+
|
2192 |
+
/**
|
2193 |
+
* Operation crmNotesPostAsyncWithHttpInfo
|
2194 |
+
*
|
2195 |
+
* Create a note
|
2196 |
+
*
|
2197 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to create a note. (required)
|
2198 |
+
*
|
2199 |
+
* @throws \InvalidArgumentException
|
2200 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
2201 |
+
*/
|
2202 |
+
public function crmNotesPostAsyncWithHttpInfo($body)
|
2203 |
+
{
|
2204 |
+
$returnType = '\SendinBlue\Client\Model\Note';
|
2205 |
+
$request = $this->crmNotesPostRequest($body);
|
2206 |
+
|
2207 |
+
return $this->client
|
2208 |
+
->sendAsync($request, $this->createHttpClientOption())
|
2209 |
+
->then(
|
2210 |
+
function ($response) use ($returnType) {
|
2211 |
+
$responseBody = $response->getBody();
|
2212 |
+
if ($returnType === '\SplFileObject') {
|
2213 |
+
$content = $responseBody; //stream goes to serializer
|
2214 |
+
} else {
|
2215 |
+
$content = $responseBody->getContents();
|
2216 |
+
if ($returnType !== 'string') {
|
2217 |
+
$content = json_decode($content);
|
2218 |
+
}
|
2219 |
+
}
|
2220 |
+
|
2221 |
+
return [
|
2222 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
2223 |
+
$response->getStatusCode(),
|
2224 |
+
$response->getHeaders()
|
2225 |
+
];
|
2226 |
+
},
|
2227 |
+
function ($exception) {
|
2228 |
+
$response = $exception->getResponse();
|
2229 |
+
$statusCode = $response->getStatusCode();
|
2230 |
+
throw new ApiException(
|
2231 |
+
sprintf(
|
2232 |
+
'[%d] Error connecting to the API (%s)',
|
2233 |
+
$statusCode,
|
2234 |
+
$exception->getRequest()->getUri()
|
2235 |
+
),
|
2236 |
+
$statusCode,
|
2237 |
+
$response->getHeaders(),
|
2238 |
+
$response->getBody()
|
2239 |
+
);
|
2240 |
+
}
|
2241 |
+
);
|
2242 |
+
}
|
2243 |
+
|
2244 |
+
/**
|
2245 |
+
* Create request for operation 'crmNotesPost'
|
2246 |
+
*
|
2247 |
+
* @param \SendinBlue\Client\Model\NoteData $body Note data to create a note. (required)
|
2248 |
+
*
|
2249 |
+
* @throws \InvalidArgumentException
|
2250 |
+
* @return \GuzzleHttp\Psr7\Request
|
2251 |
+
*/
|
2252 |
+
protected function crmNotesPostRequest($body)
|
2253 |
+
{
|
2254 |
+
// verify the required parameter 'body' is set
|
2255 |
+
if ($body === null || (is_array($body) && count($body) === 0)) {
|
2256 |
+
throw new \InvalidArgumentException(
|
2257 |
+
'Missing the required parameter $body when calling crmNotesPost'
|
2258 |
+
);
|
2259 |
+
}
|
2260 |
+
|
2261 |
+
$resourcePath = '/crm/notes';
|
2262 |
+
$formParams = [];
|
2263 |
+
$queryParams = [];
|
2264 |
+
$headerParams = [];
|
2265 |
+
$httpBody = '';
|
2266 |
+
$multipart = false;
|
2267 |
+
|
2268 |
+
|
2269 |
+
|
2270 |
+
// body params
|
2271 |
+
$_tempBody = null;
|
2272 |
+
if (isset($body)) {
|
2273 |
+
$_tempBody = $body;
|
2274 |
+
}
|
2275 |
+
|
2276 |
+
if ($multipart) {
|
2277 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
2278 |
+
['application/json']
|
2279 |
+
);
|
2280 |
+
} else {
|
2281 |
+
$headers = $this->headerSelector->selectHeaders(
|
2282 |
+
['application/json'],
|
2283 |
+
['application/json']
|
2284 |
+
);
|
2285 |
+
}
|
2286 |
+
|
2287 |
+
// for model (json/xml)
|
2288 |
+
if (isset($_tempBody)) {
|
2289 |
+
// $_tempBody is the method argument, if present
|
2290 |
+
$httpBody = $_tempBody;
|
2291 |
+
|
2292 |
+
if($headers['Content-Type'] === 'application/json') {
|
2293 |
+
// \stdClass has no __toString(), so we should encode it manually
|
2294 |
+
if ($httpBody instanceof \stdClass) {
|
2295 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
2296 |
+
}
|
2297 |
+
// array has no __toString(), so we should encode it manually
|
2298 |
+
if(is_array($httpBody)) {
|
2299 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
2300 |
+
}
|
2301 |
+
}
|
2302 |
+
} elseif (count($formParams) > 0) {
|
2303 |
+
if ($multipart) {
|
2304 |
+
$multipartContents = [];
|
2305 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
2306 |
+
$multipartContents[] = [
|
2307 |
+
'name' => $formParamName,
|
2308 |
+
'contents' => $formParamValue
|
2309 |
+
];
|
2310 |
+
}
|
2311 |
+
// for HTTP post (form)
|
2312 |
+
$httpBody = new MultipartStream($multipartContents);
|
2313 |
+
|
2314 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
2315 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
2316 |
+
|
2317 |
+
} else {
|
2318 |
+
// for HTTP post (form)
|
2319 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
2320 |
+
}
|
2321 |
+
}
|
2322 |
+
|
2323 |
+
// this endpoint requires API key authentication
|
2324 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
2325 |
+
if ($apiKey !== null) {
|
2326 |
+
$headers['api-key'] = $apiKey;
|
2327 |
+
}
|
2328 |
+
// this endpoint requires API key authentication
|
2329 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
2330 |
+
if ($apiKey !== null) {
|
2331 |
+
$headers['partner-key'] = $apiKey;
|
2332 |
+
}
|
2333 |
+
|
2334 |
+
$defaultHeaders = [];
|
2335 |
+
if ($this->config->getUserAgent()) {
|
2336 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
2337 |
+
}
|
2338 |
+
|
2339 |
+
$headers = array_merge(
|
2340 |
+
$defaultHeaders,
|
2341 |
+
$headerParams,
|
2342 |
+
$headers
|
2343 |
+
);
|
2344 |
+
|
2345 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
2346 |
+
return new Request(
|
2347 |
+
'POST',
|
2348 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
2349 |
+
$headers,
|
2350 |
+
$httpBody
|
2351 |
+
);
|
2352 |
+
}
|
2353 |
+
|
2354 |
+
/**
|
2355 |
+
* Operation crmTasksIdDelete
|
2356 |
+
*
|
2357 |
+
* Delete a task
|
2358 |
+
*
|
2359 |
+
* @param string $id id (required)
|
2360 |
+
*
|
2361 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2362 |
+
* @throws \InvalidArgumentException
|
2363 |
+
* @return void
|
2364 |
+
*/
|
2365 |
+
public function crmTasksIdDelete($id)
|
2366 |
+
{
|
2367 |
+
$this->crmTasksIdDeleteWithHttpInfo($id);
|
2368 |
+
}
|
2369 |
+
|
2370 |
+
/**
|
2371 |
+
* Operation crmTasksIdDeleteWithHttpInfo
|
2372 |
+
*
|
2373 |
+
* Delete a task
|
2374 |
+
*
|
2375 |
+
* @param string $id (required)
|
2376 |
+
*
|
2377 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2378 |
+
* @throws \InvalidArgumentException
|
2379 |
+
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
2380 |
+
*/
|
2381 |
+
public function crmTasksIdDeleteWithHttpInfo($id)
|
2382 |
+
{
|
2383 |
+
$returnType = '';
|
2384 |
+
$request = $this->crmTasksIdDeleteRequest($id);
|
2385 |
+
|
2386 |
+
try {
|
2387 |
+
$options = $this->createHttpClientOption();
|
2388 |
+
try {
|
2389 |
+
$response = $this->client->send($request, $options);
|
2390 |
+
} catch (RequestException $e) {
|
2391 |
+
throw new ApiException(
|
2392 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
2393 |
+
$e->getCode(),
|
2394 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
2395 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
2396 |
+
);
|
2397 |
+
}
|
2398 |
+
|
2399 |
+
$statusCode = $response->getStatusCode();
|
2400 |
+
|
2401 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
2402 |
+
throw new ApiException(
|
2403 |
+
sprintf(
|
2404 |
+
'[%d] Error connecting to the API (%s)',
|
2405 |
+
$statusCode,
|
2406 |
+
$request->getUri()
|
2407 |
+
),
|
2408 |
+
$statusCode,
|
2409 |
+
$response->getHeaders(),
|
2410 |
+
$response->getBody()
|
2411 |
+
);
|
2412 |
+
}
|
2413 |
+
|
2414 |
+
return [null, $statusCode, $response->getHeaders()];
|
2415 |
+
|
2416 |
+
} catch (ApiException $e) {
|
2417 |
+
switch ($e->getCode()) {
|
2418 |
+
case 400:
|
2419 |
+
$data = ObjectSerializer::deserialize(
|
2420 |
+
$e->getResponseBody(),
|
2421 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
2422 |
+
$e->getResponseHeaders()
|
2423 |
+
);
|
2424 |
+
$e->setResponseObject($data);
|
2425 |
+
break;
|
2426 |
+
case 404:
|
2427 |
+
$data = ObjectSerializer::deserialize(
|
2428 |
+
$e->getResponseBody(),
|
2429 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
2430 |
+
$e->getResponseHeaders()
|
2431 |
+
);
|
2432 |
+
$e->setResponseObject($data);
|
2433 |
+
break;
|
2434 |
+
}
|
2435 |
+
throw $e;
|
2436 |
+
}
|
2437 |
+
}
|
2438 |
+
|
2439 |
+
/**
|
2440 |
+
* Operation crmTasksIdDeleteAsync
|
2441 |
+
*
|
2442 |
+
* Delete a task
|
2443 |
+
*
|
2444 |
+
* @param string $id (required)
|
2445 |
+
*
|
2446 |
+
* @throws \InvalidArgumentException
|
2447 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
2448 |
+
*/
|
2449 |
+
public function crmTasksIdDeleteAsync($id)
|
2450 |
+
{
|
2451 |
+
return $this->crmTasksIdDeleteAsyncWithHttpInfo($id)
|
2452 |
+
->then(
|
2453 |
+
function ($response) {
|
2454 |
+
return $response[0];
|
2455 |
+
}
|
2456 |
+
);
|
2457 |
+
}
|
2458 |
+
|
2459 |
+
/**
|
2460 |
+
* Operation crmTasksIdDeleteAsyncWithHttpInfo
|
2461 |
+
*
|
2462 |
+
* Delete a task
|
2463 |
+
*
|
2464 |
+
* @param string $id (required)
|
2465 |
+
*
|
2466 |
+
* @throws \InvalidArgumentException
|
2467 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
2468 |
+
*/
|
2469 |
+
public function crmTasksIdDeleteAsyncWithHttpInfo($id)
|
2470 |
+
{
|
2471 |
+
$returnType = '';
|
2472 |
+
$request = $this->crmTasksIdDeleteRequest($id);
|
2473 |
+
|
2474 |
+
return $this->client
|
2475 |
+
->sendAsync($request, $this->createHttpClientOption())
|
2476 |
+
->then(
|
2477 |
+
function ($response) use ($returnType) {
|
2478 |
+
return [null, $response->getStatusCode(), $response->getHeaders()];
|
2479 |
+
},
|
2480 |
+
function ($exception) {
|
2481 |
+
$response = $exception->getResponse();
|
2482 |
+
$statusCode = $response->getStatusCode();
|
2483 |
+
throw new ApiException(
|
2484 |
+
sprintf(
|
2485 |
+
'[%d] Error connecting to the API (%s)',
|
2486 |
+
$statusCode,
|
2487 |
+
$exception->getRequest()->getUri()
|
2488 |
+
),
|
2489 |
+
$statusCode,
|
2490 |
+
$response->getHeaders(),
|
2491 |
+
$response->getBody()
|
2492 |
+
);
|
2493 |
+
}
|
2494 |
+
);
|
2495 |
+
}
|
2496 |
+
|
2497 |
+
/**
|
2498 |
+
* Create request for operation 'crmTasksIdDelete'
|
2499 |
+
*
|
2500 |
+
* @param string $id (required)
|
2501 |
+
*
|
2502 |
+
* @throws \InvalidArgumentException
|
2503 |
+
* @return \GuzzleHttp\Psr7\Request
|
2504 |
+
*/
|
2505 |
+
protected function crmTasksIdDeleteRequest($id)
|
2506 |
+
{
|
2507 |
+
// verify the required parameter 'id' is set
|
2508 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
2509 |
+
throw new \InvalidArgumentException(
|
2510 |
+
'Missing the required parameter $id when calling crmTasksIdDelete'
|
2511 |
+
);
|
2512 |
+
}
|
2513 |
+
|
2514 |
+
$resourcePath = '/crm/tasks/{id}';
|
2515 |
+
$formParams = [];
|
2516 |
+
$queryParams = [];
|
2517 |
+
$headerParams = [];
|
2518 |
+
$httpBody = '';
|
2519 |
+
$multipart = false;
|
2520 |
+
|
2521 |
+
|
2522 |
+
// path params
|
2523 |
+
if ($id !== null) {
|
2524 |
+
$resourcePath = str_replace(
|
2525 |
+
'{' . 'id' . '}',
|
2526 |
+
ObjectSerializer::toPathValue($id),
|
2527 |
+
$resourcePath
|
2528 |
+
);
|
2529 |
+
}
|
2530 |
+
|
2531 |
+
// body params
|
2532 |
+
$_tempBody = null;
|
2533 |
+
|
2534 |
+
if ($multipart) {
|
2535 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
2536 |
+
['application/json']
|
2537 |
+
);
|
2538 |
+
} else {
|
2539 |
+
$headers = $this->headerSelector->selectHeaders(
|
2540 |
+
['application/json'],
|
2541 |
+
['application/json']
|
2542 |
+
);
|
2543 |
+
}
|
2544 |
+
|
2545 |
+
// for model (json/xml)
|
2546 |
+
if (isset($_tempBody)) {
|
2547 |
+
// $_tempBody is the method argument, if present
|
2548 |
+
$httpBody = $_tempBody;
|
2549 |
+
|
2550 |
+
if($headers['Content-Type'] === 'application/json') {
|
2551 |
+
// \stdClass has no __toString(), so we should encode it manually
|
2552 |
+
if ($httpBody instanceof \stdClass) {
|
2553 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
2554 |
+
}
|
2555 |
+
// array has no __toString(), so we should encode it manually
|
2556 |
+
if(is_array($httpBody)) {
|
2557 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
2558 |
+
}
|
2559 |
+
}
|
2560 |
+
} elseif (count($formParams) > 0) {
|
2561 |
+
if ($multipart) {
|
2562 |
+
$multipartContents = [];
|
2563 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
2564 |
+
$multipartContents[] = [
|
2565 |
+
'name' => $formParamName,
|
2566 |
+
'contents' => $formParamValue
|
2567 |
+
];
|
2568 |
+
}
|
2569 |
+
// for HTTP post (form)
|
2570 |
+
$httpBody = new MultipartStream($multipartContents);
|
2571 |
+
|
2572 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
2573 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
2574 |
+
|
2575 |
+
} else {
|
2576 |
+
// for HTTP post (form)
|
2577 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
2578 |
+
}
|
2579 |
+
}
|
2580 |
+
|
2581 |
+
// this endpoint requires API key authentication
|
2582 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
2583 |
+
if ($apiKey !== null) {
|
2584 |
+
$headers['api-key'] = $apiKey;
|
2585 |
+
}
|
2586 |
+
// this endpoint requires API key authentication
|
2587 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
2588 |
+
if ($apiKey !== null) {
|
2589 |
+
$headers['partner-key'] = $apiKey;
|
2590 |
+
}
|
2591 |
+
|
2592 |
+
$defaultHeaders = [];
|
2593 |
+
if ($this->config->getUserAgent()) {
|
2594 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
2595 |
+
}
|
2596 |
+
|
2597 |
+
$headers = array_merge(
|
2598 |
+
$defaultHeaders,
|
2599 |
+
$headerParams,
|
2600 |
+
$headers
|
2601 |
+
);
|
2602 |
+
|
2603 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
2604 |
+
return new Request(
|
2605 |
+
'DELETE',
|
2606 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
2607 |
+
$headers,
|
2608 |
+
$httpBody
|
2609 |
+
);
|
2610 |
+
}
|
2611 |
+
|
2612 |
+
/**
|
2613 |
+
* Operation crmTasksIdGet
|
2614 |
+
*
|
2615 |
+
* Get a task
|
2616 |
+
*
|
2617 |
+
* @param string $id id (required)
|
2618 |
+
*
|
2619 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2620 |
+
* @throws \InvalidArgumentException
|
2621 |
+
* @return \SendinBlue\Client\Model\Task
|
2622 |
+
*/
|
2623 |
+
public function crmTasksIdGet($id)
|
2624 |
+
{
|
2625 |
+
list($response) = $this->crmTasksIdGetWithHttpInfo($id);
|
2626 |
+
return $response;
|
2627 |
+
}
|
2628 |
+
|
2629 |
+
/**
|
2630 |
+
* Operation crmTasksIdGetWithHttpInfo
|
2631 |
+
*
|
2632 |
+
* Get a task
|
2633 |
+
*
|
2634 |
+
* @param string $id (required)
|
2635 |
+
*
|
2636 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2637 |
+
* @throws \InvalidArgumentException
|
2638 |
+
* @return array of \SendinBlue\Client\Model\Task, HTTP status code, HTTP response headers (array of strings)
|
2639 |
+
*/
|
2640 |
+
public function crmTasksIdGetWithHttpInfo($id)
|
2641 |
+
{
|
2642 |
+
$returnType = '\SendinBlue\Client\Model\Task';
|
2643 |
+
$request = $this->crmTasksIdGetRequest($id);
|
2644 |
+
|
2645 |
+
try {
|
2646 |
+
$options = $this->createHttpClientOption();
|
2647 |
+
try {
|
2648 |
+
$response = $this->client->send($request, $options);
|
2649 |
+
} catch (RequestException $e) {
|
2650 |
+
throw new ApiException(
|
2651 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
2652 |
+
$e->getCode(),
|
2653 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
2654 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
2655 |
+
);
|
2656 |
+
}
|
2657 |
+
|
2658 |
+
$statusCode = $response->getStatusCode();
|
2659 |
+
|
2660 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
2661 |
+
throw new ApiException(
|
2662 |
+
sprintf(
|
2663 |
+
'[%d] Error connecting to the API (%s)',
|
2664 |
+
$statusCode,
|
2665 |
+
$request->getUri()
|
2666 |
+
),
|
2667 |
+
$statusCode,
|
2668 |
+
$response->getHeaders(),
|
2669 |
+
$response->getBody()
|
2670 |
+
);
|
2671 |
+
}
|
2672 |
+
|
2673 |
+
$responseBody = $response->getBody();
|
2674 |
+
if ($returnType === '\SplFileObject') {
|
2675 |
+
$content = $responseBody; //stream goes to serializer
|
2676 |
+
} else {
|
2677 |
+
$content = $responseBody->getContents();
|
2678 |
+
if ($returnType !== 'string') {
|
2679 |
+
$content = json_decode($content);
|
2680 |
+
}
|
2681 |
+
}
|
2682 |
+
|
2683 |
+
return [
|
2684 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
2685 |
+
$response->getStatusCode(),
|
2686 |
+
$response->getHeaders()
|
2687 |
+
];
|
2688 |
+
|
2689 |
+
} catch (ApiException $e) {
|
2690 |
+
switch ($e->getCode()) {
|
2691 |
+
case 200:
|
2692 |
+
$data = ObjectSerializer::deserialize(
|
2693 |
+
$e->getResponseBody(),
|
2694 |
+
'\SendinBlue\Client\Model\Task',
|
2695 |
+
$e->getResponseHeaders()
|
2696 |
+
);
|
2697 |
+
$e->setResponseObject($data);
|
2698 |
+
break;
|
2699 |
+
case 400:
|
2700 |
+
$data = ObjectSerializer::deserialize(
|
2701 |
+
$e->getResponseBody(),
|
2702 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
2703 |
+
$e->getResponseHeaders()
|
2704 |
+
);
|
2705 |
+
$e->setResponseObject($data);
|
2706 |
+
break;
|
2707 |
+
case 404:
|
2708 |
+
$data = ObjectSerializer::deserialize(
|
2709 |
+
$e->getResponseBody(),
|
2710 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
2711 |
+
$e->getResponseHeaders()
|
2712 |
+
);
|
2713 |
+
$e->setResponseObject($data);
|
2714 |
+
break;
|
2715 |
+
}
|
2716 |
+
throw $e;
|
2717 |
+
}
|
2718 |
+
}
|
2719 |
+
|
2720 |
+
/**
|
2721 |
+
* Operation crmTasksIdGetAsync
|
2722 |
+
*
|
2723 |
+
* Get a task
|
2724 |
+
*
|
2725 |
+
* @param string $id (required)
|
2726 |
+
*
|
2727 |
+
* @throws \InvalidArgumentException
|
2728 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
2729 |
+
*/
|
2730 |
+
public function crmTasksIdGetAsync($id)
|
2731 |
+
{
|
2732 |
+
return $this->crmTasksIdGetAsyncWithHttpInfo($id)
|
2733 |
+
->then(
|
2734 |
+
function ($response) {
|
2735 |
+
return $response[0];
|
2736 |
+
}
|
2737 |
+
);
|
2738 |
+
}
|
2739 |
+
|
2740 |
+
/**
|
2741 |
+
* Operation crmTasksIdGetAsyncWithHttpInfo
|
2742 |
+
*
|
2743 |
+
* Get a task
|
2744 |
+
*
|
2745 |
+
* @param string $id (required)
|
2746 |
+
*
|
2747 |
+
* @throws \InvalidArgumentException
|
2748 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
2749 |
+
*/
|
2750 |
+
public function crmTasksIdGetAsyncWithHttpInfo($id)
|
2751 |
+
{
|
2752 |
+
$returnType = '\SendinBlue\Client\Model\Task';
|
2753 |
+
$request = $this->crmTasksIdGetRequest($id);
|
2754 |
+
|
2755 |
+
return $this->client
|
2756 |
+
->sendAsync($request, $this->createHttpClientOption())
|
2757 |
+
->then(
|
2758 |
+
function ($response) use ($returnType) {
|
2759 |
+
$responseBody = $response->getBody();
|
2760 |
+
if ($returnType === '\SplFileObject') {
|
2761 |
+
$content = $responseBody; //stream goes to serializer
|
2762 |
+
} else {
|
2763 |
+
$content = $responseBody->getContents();
|
2764 |
+
if ($returnType !== 'string') {
|
2765 |
+
$content = json_decode($content);
|
2766 |
+
}
|
2767 |
+
}
|
2768 |
+
|
2769 |
+
return [
|
2770 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
2771 |
+
$response->getStatusCode(),
|
2772 |
+
$response->getHeaders()
|
2773 |
+
];
|
2774 |
+
},
|
2775 |
+
function ($exception) {
|
2776 |
+
$response = $exception->getResponse();
|
2777 |
+
$statusCode = $response->getStatusCode();
|
2778 |
+
throw new ApiException(
|
2779 |
+
sprintf(
|
2780 |
+
'[%d] Error connecting to the API (%s)',
|
2781 |
+
$statusCode,
|
2782 |
+
$exception->getRequest()->getUri()
|
2783 |
+
),
|
2784 |
+
$statusCode,
|
2785 |
+
$response->getHeaders(),
|
2786 |
+
$response->getBody()
|
2787 |
+
);
|
2788 |
+
}
|
2789 |
+
);
|
2790 |
+
}
|
2791 |
+
|
2792 |
+
/**
|
2793 |
+
* Create request for operation 'crmTasksIdGet'
|
2794 |
+
*
|
2795 |
+
* @param string $id (required)
|
2796 |
+
*
|
2797 |
+
* @throws \InvalidArgumentException
|
2798 |
+
* @return \GuzzleHttp\Psr7\Request
|
2799 |
+
*/
|
2800 |
+
protected function crmTasksIdGetRequest($id)
|
2801 |
+
{
|
2802 |
+
// verify the required parameter 'id' is set
|
2803 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
2804 |
+
throw new \InvalidArgumentException(
|
2805 |
+
'Missing the required parameter $id when calling crmTasksIdGet'
|
2806 |
+
);
|
2807 |
+
}
|
2808 |
+
|
2809 |
+
$resourcePath = '/crm/tasks/{id}';
|
2810 |
+
$formParams = [];
|
2811 |
+
$queryParams = [];
|
2812 |
+
$headerParams = [];
|
2813 |
+
$httpBody = '';
|
2814 |
+
$multipart = false;
|
2815 |
+
|
2816 |
+
|
2817 |
+
// path params
|
2818 |
+
if ($id !== null) {
|
2819 |
+
$resourcePath = str_replace(
|
2820 |
+
'{' . 'id' . '}',
|
2821 |
+
ObjectSerializer::toPathValue($id),
|
2822 |
+
$resourcePath
|
2823 |
+
);
|
2824 |
+
}
|
2825 |
+
|
2826 |
+
// body params
|
2827 |
+
$_tempBody = null;
|
2828 |
+
|
2829 |
+
if ($multipart) {
|
2830 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
2831 |
+
['application/json']
|
2832 |
+
);
|
2833 |
+
} else {
|
2834 |
+
$headers = $this->headerSelector->selectHeaders(
|
2835 |
+
['application/json'],
|
2836 |
+
['application/json']
|
2837 |
+
);
|
2838 |
+
}
|
2839 |
+
|
2840 |
+
// for model (json/xml)
|
2841 |
+
if (isset($_tempBody)) {
|
2842 |
+
// $_tempBody is the method argument, if present
|
2843 |
+
$httpBody = $_tempBody;
|
2844 |
+
|
2845 |
+
if($headers['Content-Type'] === 'application/json') {
|
2846 |
+
// \stdClass has no __toString(), so we should encode it manually
|
2847 |
+
if ($httpBody instanceof \stdClass) {
|
2848 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
2849 |
+
}
|
2850 |
+
// array has no __toString(), so we should encode it manually
|
2851 |
+
if(is_array($httpBody)) {
|
2852 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
2853 |
+
}
|
2854 |
+
}
|
2855 |
+
} elseif (count($formParams) > 0) {
|
2856 |
+
if ($multipart) {
|
2857 |
+
$multipartContents = [];
|
2858 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
2859 |
+
$multipartContents[] = [
|
2860 |
+
'name' => $formParamName,
|
2861 |
+
'contents' => $formParamValue
|
2862 |
+
];
|
2863 |
+
}
|
2864 |
+
// for HTTP post (form)
|
2865 |
+
$httpBody = new MultipartStream($multipartContents);
|
2866 |
+
|
2867 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
2868 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
2869 |
+
|
2870 |
+
} else {
|
2871 |
+
// for HTTP post (form)
|
2872 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
2873 |
+
}
|
2874 |
+
}
|
2875 |
+
|
2876 |
+
// this endpoint requires API key authentication
|
2877 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
2878 |
+
if ($apiKey !== null) {
|
2879 |
+
$headers['api-key'] = $apiKey;
|
2880 |
+
}
|
2881 |
+
// this endpoint requires API key authentication
|
2882 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
2883 |
+
if ($apiKey !== null) {
|
2884 |
+
$headers['partner-key'] = $apiKey;
|
2885 |
+
}
|
2886 |
+
|
2887 |
+
$defaultHeaders = [];
|
2888 |
+
if ($this->config->getUserAgent()) {
|
2889 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
2890 |
+
}
|
2891 |
+
|
2892 |
+
$headers = array_merge(
|
2893 |
+
$defaultHeaders,
|
2894 |
+
$headerParams,
|
2895 |
+
$headers
|
2896 |
+
);
|
2897 |
+
|
2898 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
2899 |
+
return new Request(
|
2900 |
+
'GET',
|
2901 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
2902 |
+
$headers,
|
2903 |
+
$httpBody
|
2904 |
+
);
|
2905 |
+
}
|
2906 |
+
|
2907 |
+
/**
|
2908 |
+
* Operation crmTasksIdPatch
|
2909 |
+
*
|
2910 |
+
* Update a task
|
2911 |
+
*
|
2912 |
+
* @param string $id id (required)
|
2913 |
+
* @param \SendinBlue\Client\Model\Body1 $body Updated task details. (required)
|
2914 |
+
*
|
2915 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2916 |
+
* @throws \InvalidArgumentException
|
2917 |
+
* @return \SendinBlue\Client\Model\Task
|
2918 |
+
*/
|
2919 |
+
public function crmTasksIdPatch($id, $body)
|
2920 |
+
{
|
2921 |
+
list($response) = $this->crmTasksIdPatchWithHttpInfo($id, $body);
|
2922 |
+
return $response;
|
2923 |
+
}
|
2924 |
+
|
2925 |
+
/**
|
2926 |
+
* Operation crmTasksIdPatchWithHttpInfo
|
2927 |
+
*
|
2928 |
+
* Update a task
|
2929 |
+
*
|
2930 |
+
* @param string $id (required)
|
2931 |
+
* @param \SendinBlue\Client\Model\Body1 $body Updated task details. (required)
|
2932 |
+
*
|
2933 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
2934 |
+
* @throws \InvalidArgumentException
|
2935 |
+
* @return array of \SendinBlue\Client\Model\Task, HTTP status code, HTTP response headers (array of strings)
|
2936 |
+
*/
|
2937 |
+
public function crmTasksIdPatchWithHttpInfo($id, $body)
|
2938 |
+
{
|
2939 |
+
$returnType = '\SendinBlue\Client\Model\Task';
|
2940 |
+
$request = $this->crmTasksIdPatchRequest($id, $body);
|
2941 |
+
|
2942 |
+
try {
|
2943 |
+
$options = $this->createHttpClientOption();
|
2944 |
+
try {
|
2945 |
+
$response = $this->client->send($request, $options);
|
2946 |
+
} catch (RequestException $e) {
|
2947 |
+
throw new ApiException(
|
2948 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
2949 |
+
$e->getCode(),
|
2950 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
2951 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
2952 |
+
);
|
2953 |
+
}
|
2954 |
+
|
2955 |
+
$statusCode = $response->getStatusCode();
|
2956 |
+
|
2957 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
2958 |
+
throw new ApiException(
|
2959 |
+
sprintf(
|
2960 |
+
'[%d] Error connecting to the API (%s)',
|
2961 |
+
$statusCode,
|
2962 |
+
$request->getUri()
|
2963 |
+
),
|
2964 |
+
$statusCode,
|
2965 |
+
$response->getHeaders(),
|
2966 |
+
$response->getBody()
|
2967 |
+
);
|
2968 |
+
}
|
2969 |
+
|
2970 |
+
$responseBody = $response->getBody();
|
2971 |
+
if ($returnType === '\SplFileObject') {
|
2972 |
+
$content = $responseBody; //stream goes to serializer
|
2973 |
+
} else {
|
2974 |
+
$content = $responseBody->getContents();
|
2975 |
+
if ($returnType !== 'string') {
|
2976 |
+
$content = json_decode($content);
|
2977 |
+
}
|
2978 |
+
}
|
2979 |
+
|
2980 |
+
return [
|
2981 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
2982 |
+
$response->getStatusCode(),
|
2983 |
+
$response->getHeaders()
|
2984 |
+
];
|
2985 |
+
|
2986 |
+
} catch (ApiException $e) {
|
2987 |
+
switch ($e->getCode()) {
|
2988 |
+
case 200:
|
2989 |
+
$data = ObjectSerializer::deserialize(
|
2990 |
+
$e->getResponseBody(),
|
2991 |
+
'\SendinBlue\Client\Model\Task',
|
2992 |
+
$e->getResponseHeaders()
|
2993 |
+
);
|
2994 |
+
$e->setResponseObject($data);
|
2995 |
+
break;
|
2996 |
+
case 400:
|
2997 |
+
$data = ObjectSerializer::deserialize(
|
2998 |
+
$e->getResponseBody(),
|
2999 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
3000 |
+
$e->getResponseHeaders()
|
3001 |
+
);
|
3002 |
+
$e->setResponseObject($data);
|
3003 |
+
break;
|
3004 |
+
case 404:
|
3005 |
+
$data = ObjectSerializer::deserialize(
|
3006 |
+
$e->getResponseBody(),
|
3007 |
+
'\SendinBlue\Client\Model\ErrorModel',
|
3008 |
+
$e->getResponseHeaders()
|
3009 |
+
);
|
3010 |
+
$e->setResponseObject($data);
|
3011 |
+
break;
|
3012 |
+
}
|
3013 |
+
throw $e;
|
3014 |
+
}
|
3015 |
+
}
|
3016 |
+
|
3017 |
+
/**
|
3018 |
+
* Operation crmTasksIdPatchAsync
|
3019 |
+
*
|
3020 |
+
* Update a task
|
3021 |
+
*
|
3022 |
+
* @param string $id (required)
|
3023 |
+
* @param \SendinBlue\Client\Model\Body1 $body Updated task details. (required)
|
3024 |
+
*
|
3025 |
+
* @throws \InvalidArgumentException
|
3026 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
3027 |
+
*/
|
3028 |
+
public function crmTasksIdPatchAsync($id, $body)
|
3029 |
+
{
|
3030 |
+
return $this->crmTasksIdPatchAsyncWithHttpInfo($id, $body)
|
3031 |
+
->then(
|
3032 |
+
function ($response) {
|
3033 |
+
return $response[0];
|
3034 |
+
}
|
3035 |
+
);
|
3036 |
+
}
|
3037 |
+
|
3038 |
+
/**
|
3039 |
+
* Operation crmTasksIdPatchAsyncWithHttpInfo
|
3040 |
+
*
|
3041 |
+
* Update a task
|
3042 |
+
*
|
3043 |
+
* @param string $id (required)
|
3044 |
+
* @param \SendinBlue\Client\Model\Body1 $body Updated task details. (required)
|
3045 |
+
*
|
3046 |
+
* @throws \InvalidArgumentException
|
3047 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
3048 |
+
*/
|
3049 |
+
public function crmTasksIdPatchAsyncWithHttpInfo($id, $body)
|
3050 |
+
{
|
3051 |
+
$returnType = '\SendinBlue\Client\Model\Task';
|
3052 |
+
$request = $this->crmTasksIdPatchRequest($id, $body);
|
3053 |
+
|
3054 |
+
return $this->client
|
3055 |
+
->sendAsync($request, $this->createHttpClientOption())
|
3056 |
+
->then(
|
3057 |
+
function ($response) use ($returnType) {
|
3058 |
+
$responseBody = $response->getBody();
|
3059 |
+
if ($returnType === '\SplFileObject') {
|
3060 |
+
$content = $responseBody; //stream goes to serializer
|
3061 |
+
} else {
|
3062 |
+
$content = $responseBody->getContents();
|
3063 |
+
if ($returnType !== 'string') {
|
3064 |
+
$content = json_decode($content);
|
3065 |
+
}
|
3066 |
+
}
|
3067 |
+
|
3068 |
+
return [
|
3069 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
3070 |
+
$response->getStatusCode(),
|
3071 |
+
$response->getHeaders()
|
3072 |
+
];
|
3073 |
+
},
|
3074 |
+
function ($exception) {
|
3075 |
+
$response = $exception->getResponse();
|
3076 |
+
$statusCode = $response->getStatusCode();
|
3077 |
+
throw new ApiException(
|
3078 |
+
sprintf(
|
3079 |
+
'[%d] Error connecting to the API (%s)',
|
3080 |
+
$statusCode,
|
3081 |
+
$exception->getRequest()->getUri()
|
3082 |
+
),
|
3083 |
+
$statusCode,
|
3084 |
+
$response->getHeaders(),
|
3085 |
+
$response->getBody()
|
3086 |
+
);
|
3087 |
+
}
|
3088 |
+
);
|
3089 |
+
}
|
3090 |
+
|
3091 |
+
/**
|
3092 |
+
* Create request for operation 'crmTasksIdPatch'
|
3093 |
+
*
|
3094 |
+
* @param string $id (required)
|
3095 |
+
* @param \SendinBlue\Client\Model\Body1 $body Updated task details. (required)
|
3096 |
+
*
|
3097 |
+
* @throws \InvalidArgumentException
|
3098 |
+
* @return \GuzzleHttp\Psr7\Request
|
3099 |
+
*/
|
3100 |
+
protected function crmTasksIdPatchRequest($id, $body)
|
3101 |
+
{
|
3102 |
+
// verify the required parameter 'id' is set
|
3103 |
+
if ($id === null || (is_array($id) && count($id) === 0)) {
|
3104 |
+
throw new \InvalidArgumentException(
|
3105 |
+
'Missing the required parameter $id when calling crmTasksIdPatch'
|
3106 |
+
);
|
3107 |
+
}
|
3108 |
+
// verify the required parameter 'body' is set
|
3109 |
+
if ($body === null || (is_array($body) && count($body) === 0)) {
|
3110 |
+
throw new \InvalidArgumentException(
|
3111 |
+
'Missing the required parameter $body when calling crmTasksIdPatch'
|
3112 |
+
);
|
3113 |
+
}
|
3114 |
+
|
3115 |
+
$resourcePath = '/crm/tasks/{id}';
|
3116 |
+
$formParams = [];
|
3117 |
+
$queryParams = [];
|
3118 |
+
$headerParams = [];
|
3119 |
+
$httpBody = '';
|
3120 |
+
$multipart = false;
|
3121 |
+
|
3122 |
+
|
3123 |
+
// path params
|
3124 |
+
if ($id !== null) {
|
3125 |
+
$resourcePath = str_replace(
|
3126 |
+
'{' . 'id' . '}',
|
3127 |
+
ObjectSerializer::toPathValue($id),
|
3128 |
+
$resourcePath
|
3129 |
+
);
|
3130 |
+
}
|
3131 |
+
|
3132 |
+
// body params
|
3133 |
+
$_tempBody = null;
|
3134 |
+
if (isset($body)) {
|
3135 |
+
$_tempBody = $body;
|
3136 |
+
}
|
3137 |
+
|
3138 |
+
if ($multipart) {
|
3139 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
3140 |
+
['application/json']
|
3141 |
+
);
|
3142 |
+
} else {
|
3143 |
+
$headers = $this->headerSelector->selectHeaders(
|
3144 |
+
['application/json'],
|
3145 |
+
['application/json']
|
3146 |
+
);
|
3147 |
+
}
|
3148 |
+
|
3149 |
+
// for model (json/xml)
|
3150 |
+
if (isset($_tempBody)) {
|
3151 |
+
// $_tempBody is the method argument, if present
|
3152 |
+
$httpBody = $_tempBody;
|
3153 |
+
|
3154 |
+
if($headers['Content-Type'] === 'application/json') {
|
3155 |
+
// \stdClass has no __toString(), so we should encode it manually
|
3156 |
+
if ($httpBody instanceof \stdClass) {
|
3157 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
3158 |
+
}
|
3159 |
+
// array has no __toString(), so we should encode it manually
|
3160 |
+
if(is_array($httpBody)) {
|
3161 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
3162 |
+
}
|
3163 |
+
}
|
3164 |
+
} elseif (count($formParams) > 0) {
|
3165 |
+
if ($multipart) {
|
3166 |
+
$multipartContents = [];
|
3167 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
3168 |
+
$multipartContents[] = [
|
3169 |
+
'name' => $formParamName,
|
3170 |
+
'contents' => $formParamValue
|
3171 |
+
];
|
3172 |
+
}
|
3173 |
+
// for HTTP post (form)
|
3174 |
+
$httpBody = new MultipartStream($multipartContents);
|
3175 |
+
|
3176 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
3177 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
3178 |
+
|
3179 |
+
} else {
|
3180 |
+
// for HTTP post (form)
|
3181 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
3182 |
+
}
|
3183 |
+
}
|
3184 |
+
|
3185 |
+
// this endpoint requires API key authentication
|
3186 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
3187 |
+
if ($apiKey !== null) {
|
3188 |
+
$headers['api-key'] = $apiKey;
|
3189 |
+
}
|
3190 |
+
// this endpoint requires API key authentication
|
3191 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
3192 |
+
if ($apiKey !== null) {
|
3193 |
+
$headers['partner-key'] = $apiKey;
|
3194 |
+
}
|
3195 |
+
|
3196 |
+
$defaultHeaders = [];
|
3197 |
+
if ($this->config->getUserAgent()) {
|
3198 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
3199 |
+
}
|
3200 |
+
|
3201 |
+
$headers = array_merge(
|
3202 |
+
$defaultHeaders,
|
3203 |
+
$headerParams,
|
3204 |
+
$headers
|
3205 |
+
);
|
3206 |
+
|
3207 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
3208 |
+
return new Request(
|
3209 |
+
'PATCH',
|
3210 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
3211 |
+
$headers,
|
3212 |
+
$httpBody
|
3213 |
+
);
|
3214 |
+
}
|
3215 |
+
|
3216 |
+
/**
|
3217 |
+
* Operation crmTasksPost
|
3218 |
+
*
|
3219 |
+
* Create a task
|
3220 |
+
*
|
3221 |
+
* @param \SendinBlue\Client\Model\Body $body Task name. (required)
|
3222 |
+
*
|
3223 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
3224 |
+
* @throws \InvalidArgumentException
|
3225 |
+
* @return \SendinBlue\Client\Model\InlineResponse201
|
3226 |
+
*/
|
3227 |
+
public function crmTasksPost($body)
|
3228 |
+
{
|
3229 |
+
list($response) = $this->crmTasksPostWithHttpInfo($body);
|
3230 |
+
return $response;
|
3231 |
+
}
|
3232 |
+
|
3233 |
+
/**
|
3234 |
+
* Operation crmTasksPostWithHttpInfo
|
3235 |
+
*
|
3236 |
+
* Create a task
|
3237 |
+
*
|
3238 |
+
* @param \SendinBlue\Client\Model\Body $body Task name. (required)
|
3239 |
+
*
|
3240 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
3241 |
+
* @throws \InvalidArgumentException
|
3242 |
+
* @return array of \SendinBlue\Client\Model\InlineResponse201, HTTP status code, HTTP response headers (array of strings)
|
3243 |
+
*/
|
3244 |
+
public function crmTasksPostWithHttpInfo($body)
|
3245 |
+
{
|
3246 |
+
$returnType = '\SendinBlue\Client\Model\InlineResponse201';
|
3247 |
+
$request = $this->crmTasksPostRequest($body);
|
3248 |
+
|
3249 |
+
try {
|
3250 |
+
$options = $this->createHttpClientOption();
|
3251 |
+
try {
|
3252 |
+
$response = $this->client->send($request, $options);
|
3253 |
+
} catch (RequestException $e) {
|
3254 |
+
throw new ApiException(
|
3255 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
3256 |
+
$e->getCode(),
|
3257 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
3258 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
3259 |
+
);
|
3260 |
+
}
|
3261 |
+
|
3262 |
+
$statusCode = $response->getStatusCode();
|
3263 |
+
|
3264 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
3265 |
+
throw new ApiException(
|
3266 |
+
sprintf(
|
3267 |
+
'[%d] Error connecting to the API (%s)',
|
3268 |
+
$statusCode,
|
3269 |
+
$request->getUri()
|
3270 |
+
),
|
3271 |
+
$statusCode,
|
3272 |
+
$response->getHeaders(),
|
3273 |
+
$response->getBody()
|
3274 |
+
);
|
3275 |
+
}
|
3276 |
+
|
3277 |
+
$responseBody = $response->getBody();
|
3278 |
+
if ($returnType === '\SplFileObject') {
|
3279 |
+
$content = $responseBody; //stream goes to serializer
|
3280 |
+
} else {
|
3281 |
+
$content = $responseBody->getContents();
|
3282 |
+
if ($returnType !== 'string') {
|
3283 |
+
$content = json_decode($content);
|
3284 |
+
}
|
3285 |
+
}
|
3286 |
+
|
3287 |
+
return [
|
3288 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
3289 |
+
$response->getStatusCode(),
|
3290 |
+
$response->getHeaders()
|
3291 |
+
];
|
3292 |
+
|
3293 |
+
} catch (ApiException $e) {
|
3294 |
+
switch ($e->getCode()) {
|
3295 |
+
case 201:
|
3296 |
+
$data = ObjectSerializer::deserialize(
|
3297 |
+
$e->getResponseBody(),
|
3298 |
+
'\SendinBlue\Client\Model\InlineResponse201',
|
3299 |
+
$e->getResponseHeaders()
|
3300 |
+
);
|
3301 |
+
$e->setResponseObject($data);
|
3302 |
+
break;
|
3303 |
+
}
|
3304 |
+
throw $e;
|
3305 |
+
}
|
3306 |
+
}
|
3307 |
+
|
3308 |
+
/**
|
3309 |
+
* Operation crmTasksPostAsync
|
3310 |
+
*
|
3311 |
+
* Create a task
|
3312 |
+
*
|
3313 |
+
* @param \SendinBlue\Client\Model\Body $body Task name. (required)
|
3314 |
+
*
|
3315 |
+
* @throws \InvalidArgumentException
|
3316 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
3317 |
+
*/
|
3318 |
+
public function crmTasksPostAsync($body)
|
3319 |
+
{
|
3320 |
+
return $this->crmTasksPostAsyncWithHttpInfo($body)
|
3321 |
+
->then(
|
3322 |
+
function ($response) {
|
3323 |
+
return $response[0];
|
3324 |
+
}
|
3325 |
+
);
|
3326 |
+
}
|
3327 |
+
|
3328 |
+
/**
|
3329 |
+
* Operation crmTasksPostAsyncWithHttpInfo
|
3330 |
+
*
|
3331 |
+
* Create a task
|
3332 |
+
*
|
3333 |
+
* @param \SendinBlue\Client\Model\Body $body Task name. (required)
|
3334 |
+
*
|
3335 |
+
* @throws \InvalidArgumentException
|
3336 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
3337 |
+
*/
|
3338 |
+
public function crmTasksPostAsyncWithHttpInfo($body)
|
3339 |
+
{
|
3340 |
+
$returnType = '\SendinBlue\Client\Model\InlineResponse201';
|
3341 |
+
$request = $this->crmTasksPostRequest($body);
|
3342 |
+
|
3343 |
+
return $this->client
|
3344 |
+
->sendAsync($request, $this->createHttpClientOption())
|
3345 |
+
->then(
|
3346 |
+
function ($response) use ($returnType) {
|
3347 |
+
$responseBody = $response->getBody();
|
3348 |
+
if ($returnType === '\SplFileObject') {
|
3349 |
+
$content = $responseBody; //stream goes to serializer
|
3350 |
+
} else {
|
3351 |
+
$content = $responseBody->getContents();
|
3352 |
+
if ($returnType !== 'string') {
|
3353 |
+
$content = json_decode($content);
|
3354 |
+
}
|
3355 |
+
}
|
3356 |
+
|
3357 |
+
return [
|
3358 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
3359 |
+
$response->getStatusCode(),
|
3360 |
+
$response->getHeaders()
|
3361 |
+
];
|
3362 |
+
},
|
3363 |
+
function ($exception) {
|
3364 |
+
$response = $exception->getResponse();
|
3365 |
+
$statusCode = $response->getStatusCode();
|
3366 |
+
throw new ApiException(
|
3367 |
+
sprintf(
|
3368 |
+
'[%d] Error connecting to the API (%s)',
|
3369 |
+
$statusCode,
|
3370 |
+
$exception->getRequest()->getUri()
|
3371 |
+
),
|
3372 |
+
$statusCode,
|
3373 |
+
$response->getHeaders(),
|
3374 |
+
$response->getBody()
|
3375 |
+
);
|
3376 |
+
}
|
3377 |
+
);
|
3378 |
+
}
|
3379 |
+
|
3380 |
+
/**
|
3381 |
+
* Create request for operation 'crmTasksPost'
|
3382 |
+
*
|
3383 |
+
* @param \SendinBlue\Client\Model\Body $body Task name. (required)
|
3384 |
+
*
|
3385 |
+
* @throws \InvalidArgumentException
|
3386 |
+
* @return \GuzzleHttp\Psr7\Request
|
3387 |
+
*/
|
3388 |
+
protected function crmTasksPostRequest($body)
|
3389 |
+
{
|
3390 |
+
// verify the required parameter 'body' is set
|
3391 |
+
if ($body === null || (is_array($body) && count($body) === 0)) {
|
3392 |
+
throw new \InvalidArgumentException(
|
3393 |
+
'Missing the required parameter $body when calling crmTasksPost'
|
3394 |
+
);
|
3395 |
+
}
|
3396 |
+
|
3397 |
+
$resourcePath = '/crm/tasks';
|
3398 |
+
$formParams = [];
|
3399 |
+
$queryParams = [];
|
3400 |
+
$headerParams = [];
|
3401 |
+
$httpBody = '';
|
3402 |
+
$multipart = false;
|
3403 |
+
|
3404 |
+
|
3405 |
+
|
3406 |
+
// body params
|
3407 |
+
$_tempBody = null;
|
3408 |
+
if (isset($body)) {
|
3409 |
+
$_tempBody = $body;
|
3410 |
+
}
|
3411 |
+
|
3412 |
+
if ($multipart) {
|
3413 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
3414 |
+
['application/json']
|
3415 |
+
);
|
3416 |
+
} else {
|
3417 |
+
$headers = $this->headerSelector->selectHeaders(
|
3418 |
+
['application/json'],
|
3419 |
+
['application/json']
|
3420 |
+
);
|
3421 |
+
}
|
3422 |
+
|
3423 |
+
// for model (json/xml)
|
3424 |
+
if (isset($_tempBody)) {
|
3425 |
+
// $_tempBody is the method argument, if present
|
3426 |
+
$httpBody = $_tempBody;
|
3427 |
+
|
3428 |
+
if($headers['Content-Type'] === 'application/json') {
|
3429 |
+
// \stdClass has no __toString(), so we should encode it manually
|
3430 |
+
if ($httpBody instanceof \stdClass) {
|
3431 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
3432 |
+
}
|
3433 |
+
// array has no __toString(), so we should encode it manually
|
3434 |
+
if(is_array($httpBody)) {
|
3435 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
3436 |
+
}
|
3437 |
+
}
|
3438 |
+
} elseif (count($formParams) > 0) {
|
3439 |
+
if ($multipart) {
|
3440 |
+
$multipartContents = [];
|
3441 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
3442 |
+
$multipartContents[] = [
|
3443 |
+
'name' => $formParamName,
|
3444 |
+
'contents' => $formParamValue
|
3445 |
+
];
|
3446 |
+
}
|
3447 |
+
// for HTTP post (form)
|
3448 |
+
$httpBody = new MultipartStream($multipartContents);
|
3449 |
+
|
3450 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
3451 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
3452 |
+
|
3453 |
+
} else {
|
3454 |
+
// for HTTP post (form)
|
3455 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
3456 |
+
}
|
3457 |
+
}
|
3458 |
+
|
3459 |
+
// this endpoint requires API key authentication
|
3460 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
3461 |
+
if ($apiKey !== null) {
|
3462 |
+
$headers['api-key'] = $apiKey;
|
3463 |
+
}
|
3464 |
+
// this endpoint requires API key authentication
|
3465 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
3466 |
+
if ($apiKey !== null) {
|
3467 |
+
$headers['partner-key'] = $apiKey;
|
3468 |
+
}
|
3469 |
+
|
3470 |
+
$defaultHeaders = [];
|
3471 |
+
if ($this->config->getUserAgent()) {
|
3472 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
3473 |
+
}
|
3474 |
+
|
3475 |
+
$headers = array_merge(
|
3476 |
+
$defaultHeaders,
|
3477 |
+
$headerParams,
|
3478 |
+
$headers
|
3479 |
+
);
|
3480 |
+
|
3481 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
3482 |
+
return new Request(
|
3483 |
+
'POST',
|
3484 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
3485 |
+
$headers,
|
3486 |
+
$httpBody
|
3487 |
+
);
|
3488 |
+
}
|
3489 |
+
|
3490 |
+
/**
|
3491 |
+
* Operation crmTasktypesGet
|
3492 |
+
*
|
3493 |
+
* Get all task types
|
3494 |
+
*
|
3495 |
+
*
|
3496 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
3497 |
+
* @throws \InvalidArgumentException
|
3498 |
+
* @return \SendinBlue\Client\Model\TaskTypes
|
3499 |
+
*/
|
3500 |
+
public function crmTasktypesGet()
|
3501 |
+
{
|
3502 |
+
list($response) = $this->crmTasktypesGetWithHttpInfo();
|
3503 |
+
return $response;
|
3504 |
+
}
|
3505 |
+
|
3506 |
+
/**
|
3507 |
+
* Operation crmTasktypesGetWithHttpInfo
|
3508 |
+
*
|
3509 |
+
* Get all task types
|
3510 |
+
*
|
3511 |
+
*
|
3512 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
3513 |
+
* @throws \InvalidArgumentException
|
3514 |
+
* @return array of \SendinBlue\Client\Model\TaskTypes, HTTP status code, HTTP response headers (array of strings)
|
3515 |
+
*/
|
3516 |
+
public function crmTasktypesGetWithHttpInfo()
|
3517 |
+
{
|
3518 |
+
$returnType = '\SendinBlue\Client\Model\TaskTypes';
|
3519 |
+
$request = $this->crmTasktypesGetRequest();
|
3520 |
+
|
3521 |
+
try {
|
3522 |
+
$options = $this->createHttpClientOption();
|
3523 |
+
try {
|
3524 |
+
$response = $this->client->send($request, $options);
|
3525 |
+
} catch (RequestException $e) {
|
3526 |
+
throw new ApiException(
|
3527 |
+
"[{$e->getCode()}] {$e->getMessage()}",
|
3528 |
+
$e->getCode(),
|
3529 |
+
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
3530 |
+
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
3531 |
+
);
|
3532 |
+
}
|
3533 |
+
|
3534 |
+
$statusCode = $response->getStatusCode();
|
3535 |
+
|
3536 |
+
if ($statusCode < 200 || $statusCode > 299) {
|
3537 |
+
throw new ApiException(
|
3538 |
+
sprintf(
|
3539 |
+
'[%d] Error connecting to the API (%s)',
|
3540 |
+
$statusCode,
|
3541 |
+
$request->getUri()
|
3542 |
+
),
|
3543 |
+
$statusCode,
|
3544 |
+
$response->getHeaders(),
|
3545 |
+
$response->getBody()
|
3546 |
+
);
|
3547 |
+
}
|
3548 |
+
|
3549 |
+
$responseBody = $response->getBody();
|
3550 |
+
if ($returnType === '\SplFileObject') {
|
3551 |
+
$content = $responseBody; //stream goes to serializer
|
3552 |
+
} else {
|
3553 |
+
$content = $responseBody->getContents();
|
3554 |
+
if ($returnType !== 'string') {
|
3555 |
+
$content = json_decode($content);
|
3556 |
+
}
|
3557 |
+
}
|
3558 |
+
|
3559 |
+
return [
|
3560 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
3561 |
+
$response->getStatusCode(),
|
3562 |
+
$response->getHeaders()
|
3563 |
+
];
|
3564 |
+
|
3565 |
+
} catch (ApiException $e) {
|
3566 |
+
switch ($e->getCode()) {
|
3567 |
+
case 200:
|
3568 |
+
$data = ObjectSerializer::deserialize(
|
3569 |
+
$e->getResponseBody(),
|
3570 |
+
'\SendinBlue\Client\Model\TaskTypes',
|
3571 |
+
$e->getResponseHeaders()
|
3572 |
+
);
|
3573 |
+
$e->setResponseObject($data);
|
3574 |
+
break;
|
3575 |
+
}
|
3576 |
+
throw $e;
|
3577 |
+
}
|
3578 |
+
}
|
3579 |
+
|
3580 |
+
/**
|
3581 |
+
* Operation crmTasktypesGetAsync
|
3582 |
+
*
|
3583 |
+
* Get all task types
|
3584 |
+
*
|
3585 |
+
*
|
3586 |
+
* @throws \InvalidArgumentException
|
3587 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
3588 |
+
*/
|
3589 |
+
public function crmTasktypesGetAsync()
|
3590 |
+
{
|
3591 |
+
return $this->crmTasktypesGetAsyncWithHttpInfo()
|
3592 |
+
->then(
|
3593 |
+
function ($response) {
|
3594 |
+
return $response[0];
|
3595 |
+
}
|
3596 |
+
);
|
3597 |
+
}
|
3598 |
+
|
3599 |
+
/**
|
3600 |
+
* Operation crmTasktypesGetAsyncWithHttpInfo
|
3601 |
+
*
|
3602 |
+
* Get all task types
|
3603 |
+
*
|
3604 |
+
*
|
3605 |
+
* @throws \InvalidArgumentException
|
3606 |
+
* @return \GuzzleHttp\Promise\PromiseInterface
|
3607 |
+
*/
|
3608 |
+
public function crmTasktypesGetAsyncWithHttpInfo()
|
3609 |
+
{
|
3610 |
+
$returnType = '\SendinBlue\Client\Model\TaskTypes';
|
3611 |
+
$request = $this->crmTasktypesGetRequest();
|
3612 |
+
|
3613 |
+
return $this->client
|
3614 |
+
->sendAsync($request, $this->createHttpClientOption())
|
3615 |
+
->then(
|
3616 |
+
function ($response) use ($returnType) {
|
3617 |
+
$responseBody = $response->getBody();
|
3618 |
+
if ($returnType === '\SplFileObject') {
|
3619 |
+
$content = $responseBody; //stream goes to serializer
|
3620 |
+
} else {
|
3621 |
+
$content = $responseBody->getContents();
|
3622 |
+
if ($returnType !== 'string') {
|
3623 |
+
$content = json_decode($content);
|
3624 |
+
}
|
3625 |
+
}
|
3626 |
+
|
3627 |
+
return [
|
3628 |
+
ObjectSerializer::deserialize($content, $returnType, []),
|
3629 |
+
$response->getStatusCode(),
|
3630 |
+
$response->getHeaders()
|
3631 |
+
];
|
3632 |
+
},
|
3633 |
+
function ($exception) {
|
3634 |
+
$response = $exception->getResponse();
|
3635 |
+
$statusCode = $response->getStatusCode();
|
3636 |
+
throw new ApiException(
|
3637 |
+
sprintf(
|
3638 |
+
'[%d] Error connecting to the API (%s)',
|
3639 |
+
$statusCode,
|
3640 |
+
$exception->getRequest()->getUri()
|
3641 |
+
),
|
3642 |
+
$statusCode,
|
3643 |
+
$response->getHeaders(),
|
3644 |
+
$response->getBody()
|
3645 |
+
);
|
3646 |
+
}
|
3647 |
+
);
|
3648 |
+
}
|
3649 |
+
|
3650 |
+
/**
|
3651 |
+
* Create request for operation 'crmTasktypesGet'
|
3652 |
+
*
|
3653 |
+
*
|
3654 |
+
* @throws \InvalidArgumentException
|
3655 |
+
* @return \GuzzleHttp\Psr7\Request
|
3656 |
+
*/
|
3657 |
+
protected function crmTasktypesGetRequest()
|
3658 |
+
{
|
3659 |
+
|
3660 |
+
$resourcePath = '/crm/tasktypes';
|
3661 |
+
$formParams = [];
|
3662 |
+
$queryParams = [];
|
3663 |
+
$headerParams = [];
|
3664 |
+
$httpBody = '';
|
3665 |
+
$multipart = false;
|
3666 |
+
|
3667 |
+
|
3668 |
+
|
3669 |
+
// body params
|
3670 |
+
$_tempBody = null;
|
3671 |
+
|
3672 |
+
if ($multipart) {
|
3673 |
+
$headers = $this->headerSelector->selectHeadersForMultipart(
|
3674 |
+
['application/json']
|
3675 |
+
);
|
3676 |
+
} else {
|
3677 |
+
$headers = $this->headerSelector->selectHeaders(
|
3678 |
+
['application/json'],
|
3679 |
+
['application/json']
|
3680 |
+
);
|
3681 |
+
}
|
3682 |
+
|
3683 |
+
// for model (json/xml)
|
3684 |
+
if (isset($_tempBody)) {
|
3685 |
+
// $_tempBody is the method argument, if present
|
3686 |
+
$httpBody = $_tempBody;
|
3687 |
+
|
3688 |
+
if($headers['Content-Type'] === 'application/json') {
|
3689 |
+
// \stdClass has no __toString(), so we should encode it manually
|
3690 |
+
if ($httpBody instanceof \stdClass) {
|
3691 |
+
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
3692 |
+
}
|
3693 |
+
// array has no __toString(), so we should encode it manually
|
3694 |
+
if(is_array($httpBody)) {
|
3695 |
+
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
3696 |
+
}
|
3697 |
+
}
|
3698 |
+
} elseif (count($formParams) > 0) {
|
3699 |
+
if ($multipart) {
|
3700 |
+
$multipartContents = [];
|
3701 |
+
foreach ($formParams as $formParamName => $formParamValue) {
|
3702 |
+
$multipartContents[] = [
|
3703 |
+
'name' => $formParamName,
|
3704 |
+
'contents' => $formParamValue
|
3705 |
+
];
|
3706 |
+
}
|
3707 |
+
// for HTTP post (form)
|
3708 |
+
$httpBody = new MultipartStream($multipartContents);
|
3709 |
+
|
3710 |
+
} elseif ($headers['Content-Type'] === 'application/json') {
|
3711 |
+
$httpBody = \GuzzleHttp\json_encode($formParams);
|
3712 |
+
|
3713 |
+
} else {
|
3714 |
+
// for HTTP post (form)
|
3715 |
+
$httpBody = \GuzzleHttp\Psr7\Query::build($formParams);
|
3716 |
+
}
|
3717 |
+
}
|
3718 |
+
|
3719 |
+
// this endpoint requires API key authentication
|
3720 |
+
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
3721 |
+
if ($apiKey !== null) {
|
3722 |
+
$headers['api-key'] = $apiKey;
|
3723 |
+
}
|
3724 |
+
// this endpoint requires API key authentication
|
3725 |
+
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
3726 |
+
if ($apiKey !== null) {
|
3727 |
+
$headers['partner-key'] = $apiKey;
|
3728 |
+
}
|
3729 |
+
|
3730 |
+
$defaultHeaders = [];
|
3731 |
+
if ($this->config->getUserAgent()) {
|
3732 |
+
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
3733 |
+
}
|
3734 |
+
|
3735 |
+
$headers = array_merge(
|
3736 |
+
$defaultHeaders,
|
3737 |
+
$headerParams,
|
3738 |
+
$headers
|
3739 |
+
);
|
3740 |
+
|
3741 |
+
$query = \GuzzleHttp\Psr7\Query::build($queryParams);
|
3742 |
+
return new Request(
|
3743 |
+
'GET',
|
3744 |
+
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
3745 |
+
$headers,
|
3746 |
+
$httpBody
|
3747 |
+
);
|
3748 |
+
}
|
3749 |
+
|
3750 |
+
/**
|
3751 |
+
* Create http client option
|
3752 |
+
*
|
3753 |
+
* @throws \RuntimeException on file opening failure
|
3754 |
+
* @return array of http client options
|
3755 |
+
*/
|
3756 |
+
protected function createHttpClientOption()
|
3757 |
+
{
|
3758 |
+
$options = [];
|
3759 |
+
if ($this->config->getDebug()) {
|
3760 |
+
$options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
|
3761 |
+
if (!$options[RequestOptions::DEBUG]) {
|
3762 |
+
throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile());
|
3763 |
+
}
|
3764 |
+
}
|
3765 |
+
|
3766 |
+
return $options;
|
3767 |
+
}
|
3768 |
+
}
|
Postman/Postman-Mail/sendinblue/lib/Api/ContactsApi.php
ADDED
@@ -0,0 +1,8128 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
/**
|
3 |
+
* ContactsApi
|
4 |
+
* PHP version 5
|
5 |
+
*
|
6 |
+
* @category Class
|
7 |
+
* @package SendinBlue\Client
|
8 |
+
* @author Swagger Codegen team
|
9 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
10 |
+
*/
|
11 |
+
|
12 |
+
/**
|
13 |
+
* SendinBlue API
|
14 |
+
*
|
15 |
+
* 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 |
|
16 |
+
*
|
17 |
+
* OpenAPI spec version: 3.0.0
|
18 |
+
* Contact: contact@sendinblue.com
|
19 |
+
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
20 |
+
* Swagger Codegen version: 2.4.12
|
21 |
+
*/
|
22 |
+
|
23 |
+
/**
|
24 |
+
* NOTE: This class is auto generated by the swagger code generator program.
|
25 |
+
* https://github.com/swagger-api/swagger-codegen
|
26 |
+
* Do not edit the class manually.
|
27 |
+
*/
|
28 |
+
|
29 |
+
namespace SendinBlue\Client\Api;
|
30 |
+
|
31 |
+
use GuzzleHttp\Client;
|
32 |
+
use GuzzleHttp\ClientInterface;
|
33 |
+
use GuzzleHttp\Exception\RequestException;
|
34 |
+
use GuzzleHttp\Psr7\MultipartStream;
|
35 |
+
use GuzzleHttp\Psr7\Request;
|
36 |
+
use GuzzleHttp\RequestOptions;
|
37 |
+
use SendinBlue\Client\ApiException;
|
38 |
+
use SendinBlue\Client\Configuration;
|
39 |
+
use SendinBlue\Client\HeaderSelector;
|
40 |
+
use SendinBlue\Client\ObjectSerializer;
|
41 |
+
|
42 |
+
/**
|
43 |
+
* ContactsApi Class Doc Comment
|
44 |
+
*
|
45 |
+
* @category Class
|
46 |
+
* @package SendinBlue\Client
|
47 |
+
* @author Swagger Codegen team
|
48 |
+
* @link https://github.com/swagger-api/swagger-codegen
|
49 |
+
*/
|
50 |
+
class ContactsApi
|
51 |
+
{
|
52 |
+
/**
|
53 |
+
* @var ClientInterface
|
54 |
+
*/
|
55 |
+
protected $client;
|
56 |
+
|
57 |
+
/**
|
58 |
+
* @var Configuration
|
59 |
+
*/
|
60 |
+
protected $config;
|
61 |
+
|
62 |
+
/**
|
63 |
+
* @var HeaderSelector
|
64 |
+
*/
|
65 |
+
protected $headerSelector;
|
66 |
+
|
67 |
+
/**
|
68 |
+
* @param ClientInterface $client
|
69 |
+
* @param Configuration $config
|
70 |
+
* @param HeaderSelector $selector
|
71 |
+
*/
|
72 |
+
public function __construct(
|
73 |
+
ClientInterface $client = null,
|
74 |
+
Configuration $config = null,
|
75 |
+
HeaderSelector $selector = null
|
76 |
+
) {
|
77 |
+
$this->client = $client ?: new Client();
|
78 |
+
$this->config = $config ?: new Configuration();
|
79 |
+
$this->headerSelector = $selector ?: new HeaderSelector();
|
80 |
+
}
|
81 |
+
|
82 |
+
/**
|
83 |
+
* @return Configuration
|
84 |
+
*/
|
85 |
+
public function getConfig()
|
86 |
+
{
|
87 |
+
return $this->config;
|
88 |
+
}
|
89 |
+
|
90 |
+
/**
|
91 |
+
* Operation addContactToList
|
92 |
+
*
|
93 |
+
* Add existing contacts to a list
|
94 |
+
*
|
95 |
+
* @param int $listId Id of the list (required)
|
96 |
+
* @param \SendinBlue\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required)
|
97 |
+
*
|
98 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
99 |
+
* @throws \InvalidArgumentException
|
100 |
+
* @return \SendinBlue\Client\Model\PostContactInfo
|
101 |
+
*/
|
102 |
+
public function addContactToList($listId, $contactEmails)
|
103 |
+
{
|
104 |
+
list($response) = $this->addContactToListWithHttpInfo($listId, $contactEmails);
|
105 |
+
return $response;
|
106 |
+
}
|
107 |
+
|
108 |
+
/**
|
109 |
+
* Operation addContactToListWithHttpInfo
|
110 |
+
*
|
111 |
+
* Add existing contacts to a list
|
112 |
+
*
|
113 |
+
* @param int $listId Id of the list (required)
|
114 |
+
* @param \SendinBlue\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required)
|
115 |
+
*
|
116 |
+
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
117 |
+
|