├── .swagger-codegen └── VERSION ├── .rspec ├── Gemfile ├── Rakefile ├── docs ├── FileList.md ├── NoteList.md ├── DealAttributes.md ├── CompanyAttributes.md ├── GetChildDomains.md ├── GetStatsByBrowser.md ├── GetStatsByDomain.md ├── AbTestVersionClicks.md ├── GetSmsCampaignRecipients.md ├── Body11.md ├── Body9.md ├── ManageIp.md ├── NoteId.md ├── GetExtendedCampaignStatsGlobalStats.md ├── GetWebhooks.md ├── CreateModel.md ├── InlineResponse201.md ├── InlineResponse200.md ├── InlineResponse2011.md ├── BlockDomain.md ├── UploadImageModel.md ├── CreateUpdateFolder.md ├── CreatedProcessId.md ├── DealsList.md ├── TaskList.md ├── GetSsoToken.md ├── CreateSubAccountResponse.md ├── GetBlockedDomains.md ├── GetIps.md ├── CompaniesList.md ├── GetReports.md ├── PostContactInfo.md ├── Pipeline.md ├── AddChildDomain.md ├── FileDownloadableLink.md ├── GetContacts.md ├── CreateUpdateContactModel.md ├── GetSmsEventReport.md ├── PipelineStage.md ├── SubAccountUpdatePlanRequestCredits.md ├── Body3.md ├── GetIpsFromSender.md ├── UpdateChildDomain.md ├── GetEmailEventReport.md ├── TaskTypes.md ├── Body4.md ├── GetTransacSmsReport.md ├── GetCampaignRecipients.md ├── GetInboundEmailEvents.md ├── CreateAttributeEnumeration.md ├── UpdateAttributeEnumeration.md ├── GetChildInfoApiKeysV2.md ├── GetChildInfoApiKeysV3.md ├── GetFolderLists.md ├── UpdateCampaignStatus.md ├── CreateList.md ├── CreateReseller.md ├── GetAttributes.md ├── GetFolders.md ├── GetSendersList.md ├── GetSmsCampaigns.md ├── ErrorModel.md ├── UpdateBatchContacts.md ├── GetChildDomain.md ├── GetEmailCampaigns.md ├── SsoTokenRequest.md ├── UpdateBatchContactsModel.md ├── AbTestVersionStats.md ├── CreateSmtpEmail.md ├── GetChildAccountCreationStatus.md ├── GetExtendedListCampaignStats.md ├── GetInboundEmailEventsByUuidLogs.md ├── GetSharedTemplateUrl.md ├── RemainingCreditModelChild.md ├── SendReportEmail.md ├── SendSmtpEmailReplyTo.md ├── SendSmtpEmailTo.md ├── GetChildrenList.md ├── GetLists.md ├── SendSmtpEmailReplyTo1.md ├── SendSmtpEmailTo1.md ├── GetTransacEmailContentEvents.md ├── RemainingCreditModelReseller.md ├── SendSmtpEmailBcc.md ├── SendSmtpEmailCc.md ├── MasterDetailsResponseBillingInfoName.md ├── SendReport.md ├── SendTestSms.md ├── AbTestCampaignResultClickedLinks.md ├── GetChildInfoCredits.md ├── GetClient.md ├── RemainingCreditModel.md ├── GetAccountRelay.md ├── GetAttributesEnumeration.md ├── GetChildInfoApiKeys.md ├── GetSendersListIps.md ├── GetSmtpTemplates.md ├── GetAccountRelayData.md ├── GetExtendedContactDetailsStatisticsDelivered.md ├── GetIpFromSender.md ├── GetProcesses.md ├── SubAccountsResponse.md ├── Body.md ├── GetContactCampaignStatsTransacAttributes.md ├── GetExtendedContactDetailsStatisticsMessagesSent.md ├── SubAccountDetailsResponsePlanInfoFeaturesInbox.md ├── GetScheduledEmailByBatchId.md ├── Body1.md ├── GetIp.md ├── AbTestVersionClicksInner.md ├── ConversationsMessageFileImageInfo.md ├── GetExtendedClientAddress.md ├── GetTransacBlockedContacts.md ├── SubAccountDetailsResponsePlanInfoFeaturesUsers.md ├── TaskReminder.md ├── GetSmtpTemplateOverviewSender.md ├── SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md ├── AddCredits.md ├── GetContactCampaignStatsClicked.md ├── SubAccountDetailsResponsePlanInfoCreditsEmails.md ├── SubAccountUpdatePlanRequestFeatures.md ├── GetAccountMarketingAutomation.md ├── GetExtendedCampaignOverviewSender.md ├── PostSendSmsTestFailed.md ├── SendTestEmail.md ├── RemoveCredits.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md ├── GetProcess.md ├── SubAccountUpdatePlanRequest.md ├── UploadImageToGallery.md ├── GetScheduledEmailByMessageId.md ├── ScheduleSmtpEmail.md ├── CreateSmsCampaignRecipients.md ├── EmailExportRecipients.md ├── GetScheduledEmailByBatchIdBatches.md ├── GetTransacBlockedContactsReason.md ├── SubAccountDetailsResponsePlanInfoCredits.md ├── DealAttributesInner.md ├── GetExtendedClient.md ├── CompanyAttributesInner.md ├── UpdateList.md ├── GetInboundEmailEventsEvents.md ├── GetTransacEmailsList.md ├── PostSendFailed.md ├── CreateSubAccount.md ├── GetExtendedContactDetailsStatisticsClicked.md ├── NoteData.md ├── RequestSMSRecipientExport.md ├── SendSmtpEmailAttachment.md ├── SubAccountsResponseSubAccounts.md ├── RequestContactImportNewList.md ├── GetChildInfoStatistics.md ├── GetContactCampaignStatsOpened.md ├── CreateSender.md ├── GetExtendedContactDetailsStatisticsLinks.md ├── GetList.md ├── CreateEmailCampaignSender.md ├── SendSms.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md ├── UpdateSender.md ├── GetExtendedContactDetailsStatisticsOpened.md ├── GetFolder.md ├── Deal.md ├── CreateSenderIps.md ├── Company.md ├── MasterDetailsResponseBillingInfoAddress.md ├── SubAccountDetailsResponsePlanInfo.md ├── UpdateSmtpTemplateSender.md ├── SubAccountDetailsResponse.md ├── ConversationsMessageFile.md ├── CreateSenderModel.md ├── CreateSmtpTemplateSender.md ├── CreateEmailCampaignRecipients.md ├── GetTransacBlockedContactsContacts.md ├── MasterDetailsResponsePlanInfoFeatures.md ├── UpdateEmailCampaignSender.md ├── Body5.md ├── MasterDetailsResponseBillingInfo.md ├── PostContactInfoContacts.md ├── GetDeviceBrowserStats.md ├── GetInboundEmailEventsByUuidAttachments.md ├── Body2.md ├── GetAttributesAttributes.md ├── GetSmsCampaignStats.md ├── CreateChild.md ├── UpdateChild.md ├── GetSendersListSenders.md ├── AbTestCampaignResultStatistics.md ├── SubAccountDetailsResponsePlanInfoFeatures.md ├── GetWebhook.md ├── Task.md ├── DeleteHardbounces.md ├── Note.md ├── FileData.md ├── MasterDetailsResponsePlanInfo.md ├── AddContactToList.md ├── SendSmtpEmailSender.md ├── UpdateAttribute.md ├── GetContactCampaignStatsUnsubscriptions.md ├── GetAccount.md ├── RequestContactExport.md ├── GetExtendedContactDetailsStatisticsUnsubscriptions.md ├── GetSmsEventReportEvents.md ├── UpdateEmailCampaignRecipients.md ├── GetChildInfo.md ├── GetTransacEmailContent.md ├── GetStatsByDevice.md ├── UpdateChildAccountStatus.md ├── GetTransacEmailsListTransactionalEmails.md ├── GetSmsCampaignOverview.md ├── MasterDetailsResponse.md ├── RemoveContactFromList.md ├── GetExtendedList.md ├── Body10.md ├── GetExtendedCampaignStats.md ├── Body7.md ├── GetSmsCampaign.md ├── CreateSmsCampaign.md ├── GetContactDetails.md ├── GetTransacSmsReportReports.md ├── UpdateSmsCampaign.md ├── Body6.md ├── GetTransacAggregatedSmsReport.md ├── GetAccountPlan.md ├── Body12.md ├── CreateDoiContact.md ├── GetReportsReports.md ├── CreateAttribute.md ├── GetExtendedContactDetails.md ├── AbTestCampaignResult.md ├── UpdateWebhook.md ├── SendTransacSms.md ├── GetInboundEmailEventsByUuid.md ├── GetEmailEventReportEvents.md ├── CreateWebhook.md ├── SendSmtpEmailMessageVersions.md ├── ConversationsMessage.md ├── GetAggregatedReport.md ├── Body8.md ├── GetSmtpTemplateOverview.md ├── GetContactCampaignStats.md ├── CreateContact.md ├── UpdateContact.md ├── CreateSmtpTemplate.md ├── GetCampaignStats.md ├── UpdateSmtpTemplate.md ├── AccountApi.md ├── GetCampaignOverview.md └── GetExtendedContactDetailsStatistics.md ├── .gitignore ├── .swagger-codegen-ignore ├── lib └── sib-api-v3-sdk │ ├── version.rb │ └── api_error.rb ├── LICENSE.md └── spec └── models ├── file_list_spec.rb ├── note_list_spec.rb ├── deal_attributes_spec.rb ├── get_child_domains_spec.rb ├── get_stats_by_domain_spec.rb ├── company_attributes_spec.rb ├── get_stats_by_browser_spec.rb ├── ab_test_version_clicks_spec.rb ├── get_sms_campaign_recipients_spec.rb ├── body_9_spec.rb ├── get_extended_campaign_stats_global_stats_spec.rb ├── note_id_spec.rb ├── body_11_spec.rb ├── get_ips_spec.rb ├── manage_ip_spec.rb ├── pipeline_spec.rb ├── task_list_spec.rb ├── deals_list_spec.rb ├── create_model_spec.rb ├── get_reports_spec.rb ├── block_domain_spec.rb ├── get_sso_token_spec.rb ├── get_webhooks_spec.rb ├── send_test_sms_spec.rb └── companies_list_spec.rb /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | 2.4.19 2 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | --require spec_helper 3 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | 5 | group :development, :test do 6 | gem 'rake', '~> 12.3.3' 7 | end 8 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | begin 2 | require 'rspec/core/rake_task' 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | task default: :spec 6 | rescue LoadError 7 | # no rspec available 8 | end 9 | -------------------------------------------------------------------------------- /docs/FileList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::FileList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/NoteList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::NoteList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/DealAttributes.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::DealAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/CompanyAttributes.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CompanyAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/GetChildDomains.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildDomains 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/GetStatsByBrowser.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetStatsByBrowser 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/GetStatsByDomain.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetStatsByDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/AbTestVersionClicks.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AbTestVersionClicks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/Body11.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body11 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **text** | **String** | edited message text | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/Body9.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body9 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **text** | **String** | edited message text | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/ManageIp.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::ManageIp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ip** | **String** | Dedicated ID | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/NoteId.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::NoteId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique note Id | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignStatsGlobalStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/GetWebhooks.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetWebhooks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **webhooks** | **Array<Object>** | | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CreateModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the object created | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/InlineResponse201.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::InlineResponse201 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique deal id | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::InlineResponse200 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique company id | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/InlineResponse2011.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::InlineResponse2011 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique task id | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/BlockDomain.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::BlockDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domain** | **String** | name of the domain to be blocked | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/UploadImageModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UploadImageModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **String** | URL of the image uploaded | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CreateUpdateFolder.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateUpdateFolder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of the folder | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CreatedProcessId.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreatedProcessId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **process_id** | **Integer** | Id of the process created | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/DealsList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::DealsList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **items** | [**Array<Deal>**](Deal.md) | List of deals | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/TaskList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::TaskList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **items** | [**Array<Task>**](Task.md) | List of tasks | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetSsoToken.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSsoToken 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **token** | **String** | Session token, it will remain valid for 15 days. | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CreateSubAccountResponse.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateSubAccountResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the sub-account created | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetBlockedDomains.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetBlockedDomains 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domains** | **Array<String>** | List of all blocked domains | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetIps.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetIps 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ips** | [**Array<GetIp>**](GetIp.md) | Dedicated IP(s) available on your account | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CompaniesList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CompaniesList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **items** | [**Array<Company>**](Company.md) | List of compaies | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetReports.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetReports 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reports** | [**Array<GetReportsReports>**](GetReportsReports.md) | | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/PostContactInfo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::PostContactInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) | | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/Pipeline.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Pipeline 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **stages** | [**Array<PipelineStage>**](PipelineStage.md) | List of stages | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/AddChildDomain.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 9 | -------------------------------------------------------------------------------- /docs/FileDownloadableLink.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::FileDownloadableLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **file_url** | **String** | A unique link to download the requested file. | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetContacts.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contacts** | **Array<Object>** | | 7 | **count** | **Integer** | Number of contacts | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreateUpdateContactModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateUpdateContactModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the contact when a new contact is created | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetSmsEventReport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsEventReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**Array<GetSmsEventReportEvents>**](GetSmsEventReportEvents.md) | | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/PipelineStage.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::PipelineStage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Stage id | [optional] 7 | **name** | **String** | Stage name | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequestCredits.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountUpdatePlanRequestCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **Integer** | Number of email credits | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/Body3.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body3 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of deal | 7 | **attributes** | **Object** | Attributes fo\\r deal creation | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetIpsFromSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetIpsFromSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ips** | [**Array<GetIpFromSender>**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/UpdateChildDomain.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 9 | -------------------------------------------------------------------------------- /docs/GetEmailEventReport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetEmailEventReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**Array<GetEmailEventReportEvents>**](GetEmailEventReportEvents.md) | | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/TaskTypes.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::TaskTypes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Id of task type | [optional] 7 | **title** | **String** | Title of task type | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Body4.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body4 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of deal | [optional] 7 | **attributes** | **Object** | Attributes for deal update | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetTransacSmsReport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetTransacSmsReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reports** | [**Array<GetTransacSmsReportReports>**](GetTransacSmsReportReports.md) | | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **lists** | **Array<Integer>** | | 7 | **exclusion_lists** | **Array<Integer>** | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEvents.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetInboundEmailEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**Array<GetInboundEmailEventsEvents>**](GetInboundEmailEventsEvents.md) | | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CreateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateAttributeEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **Integer** | Id of the value | 7 | **label** | **String** | Label of the value | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UpdateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateAttributeEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **Integer** | Id of the value | 7 | **label** | **String** | Label of the value | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeysV2.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeysV3.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/GetFolderLists.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetFolderLists 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **lists** | **Array<Object>** | | [optional] 7 | **count** | **Integer** | Number of lists in the folder | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UpdateCampaignStatus.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 9 | -------------------------------------------------------------------------------- /docs/CreateList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of the list | 7 | **folder_id** | **Integer** | Id of the parent folder in which this list is to be created | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreateReseller.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateReseller 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **auth_key** | **String** | AuthKey of Reseller child created | 7 | **id** | **Integer** | Id of Reseller child created | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAttributes.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **attributes** | [**Array<GetAttributesAttributes>**](GetAttributesAttributes.md) | Listing of available contact attributes in your account | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetFolders.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetFolders 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **folders** | **Array<Object>** | | [optional] 7 | **count** | **Integer** | Number of folders available in your account | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetSendersList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSendersList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **senders** | [**Array<GetSendersListSenders>**](GetSendersListSenders.md) | List of the senders available in your account | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetSmsCampaigns.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsCampaigns 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaigns** | **Array<Object>** | | [optional] 7 | **count** | **Integer** | Number of SMS campaigns retrieved | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ErrorModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/UpdateBatchContacts.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateBatchContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contacts** | [**Array<UpdateBatchContactsContacts>**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetChildDomain.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domain** | **String** | Sender domain | [optional] 7 | **active** | **BOOLEAN** | indicates whether a domain is verified or not | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetEmailCampaigns.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetEmailCampaigns 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaigns** | **Array<Object>** | | [optional] 7 | **count** | **Integer** | Number of Email campaigns retrieved | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SsoTokenRequest.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SsoTokenRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | Id of the sub-account organization | 7 | **email** | **String** | User email of sub-account organization | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UpdateBatchContactsModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateBatchContactsModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **success_ids** | **Array<Integer>** | | [optional] 7 | **failure_ids** | **Array<Integer>** | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AbTestVersionStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AbTestVersionStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **version_a** | **String** | percentage of an event for version A | 7 | **version_b** | **String** | percentage of an event for version B | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreateSmtpEmail.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateSmtpEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **String** | Message ID of the transactional email sent | [optional] 7 | **message_ids** | **Array<String>** | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildAccountCreationStatus.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildAccountCreationStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **child_account_created** | **BOOLEAN** | Status of child account creation whether it is successfully created (exists) or not. | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/GetExtendedListCampaignStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedListCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign | 7 | **stats** | [**GetCampaignStats**](GetCampaignStats.md) | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuidLogs.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/GetSharedTemplateUrl.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSharedTemplateUrl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **shared_url** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/RemainingCreditModelChild.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RemainingCreditModelChild 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **Float** | SMS Credits remaining for child account | 7 | **email** | **Float** | Email Credits remaining for child account | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendReportEmail.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SendReportEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | **Array<String>** | Email addresses of the recipients | 7 | **body** | **String** | Custom text message to be presented in the report email. | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailReplyTo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailTo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/GetChildrenList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildrenList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **children** | **Array<Object>** | Your children's account information | [optional] 7 | **count** | **Integer** | Number of child accounts | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetLists.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetLists 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **lists** | **Array<Object>** | Listing of all the lists available in your account | [optional] 7 | **count** | **Integer** | Number of lists in your account | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailReplyTo1.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailTo1.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/GetTransacEmailContentEvents.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/RemainingCreditModelReseller.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RemainingCreditModelReseller 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **Float** | SMS Credits remaining for reseller account | 7 | **email** | **Float** | Email Credits remaining for reseller account | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailBcc.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailCc.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfoName.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::MasterDetailsResponseBillingInfoName 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **given_name** | **String** | First name for billing | [optional] 7 | **family_name** | **String** | Last name for billing | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendReport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**SendReportEmail**](SendReportEmail.md) | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendTestSms.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SendTestSms 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **phone_number** | **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 | 9 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResultClickedLinks.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AbTestCampaignResultClickedLinks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **version_a** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | 7 | **version_b** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfoCredits.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildInfoCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_credits** | **Integer** | Email credits available for your child | [optional] 7 | **sms_credits** | **Integer** | SMS credits available for your child | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetClient.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetClient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Login Email | 7 | **first_name** | **String** | First Name | 8 | **last_name** | **String** | Last Name | 9 | **company_name** | **String** | Name of the company | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemainingCreditModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RemainingCreditModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) | | 7 | **reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAccountRelay.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAccountRelay 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **enabled** | **BOOLEAN** | Status of your transactional email Account (true=Enabled, false=Disabled) | 7 | **data** | [**GetAccountRelayData**](GetAccountRelayData.md) | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAttributesEnumeration.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAttributesEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **Integer** | ID of Value of the \"category\" type attribute | 7 | **label** | **String** | Label of the \"category\" type attribute | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeys.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildInfoApiKeys 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **v2** | [**Array<GetChildInfoApiKeysV2>**](GetChildInfoApiKeysV2.md) | | 7 | **v3** | [**Array<GetChildInfoApiKeysV3>**](GetChildInfoApiKeysV3.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetSendersListIps.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | Weight of the IP for this sender | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplates.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmtpTemplates 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **Integer** | Count of transactional email templates | [optional] 7 | **templates** | [**Array<GetSmtpTemplateOverview>**](GetSmtpTemplateOverview.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAccountRelayData.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAccountRelayData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_name** | **String** | Email to use as login on transactional platform | 7 | **relay** | **String** | URL of the SMTP Relay | 8 | **port** | **Integer** | Port used for SMTP Relay | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsDelivered.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsDelivered 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **event_time** | **String** | UTC date-time of the event | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetIpFromSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetIpFromSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the dedicated IP | 7 | **ip** | **String** | Dedicated IP | 8 | **domain** | **String** | Domain associated to the IP | 9 | **weight** | **Integer** | Weight of the IP | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetProcesses.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetProcesses 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **processes** | [**Array<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional] 7 | **count** | **Integer** | Number of processes available on your account | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountsResponse.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **Integer** | Total number of subaccounts | [optional] 7 | **sub_accounts** | [**Array<SubAccountsResponseSubAccounts>**](SubAccountsResponseSubAccounts.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Body.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of company | 7 | **attributes** | **Object** | Attributes for company creation | [optional] 8 | **country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsTransacAttributes.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetContactCampaignStatsTransacAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **order_date** | **Date** | Date of the order | 7 | **order_price** | **Float** | Price of the order | 8 | **order_id** | **Integer** | ID of the order | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsMessagesSent.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsMessagesSent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **event_time** | **String** | UTC date-time of the event | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesInbox 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **Integer** | Quantity of inbox provided | [optional] 7 | **remaining** | **Integer** | Available inboxes for use | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByBatchId.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetScheduledEmailByBatchId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **Integer** | Total number of batches | [optional] 7 | **batches** | [**Array<GetScheduledEmailByBatchIdBatches>**](GetScheduledEmailByBatchIdBatches.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Body1.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body1 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of company | [optional] 7 | **attributes** | **Object** | Attributes for company update | [optional] 8 | **country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetIp.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetIp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the dedicated IP | 7 | **ip** | **String** | Dedicated IP | 8 | **active** | **BOOLEAN** | Status of the IP (true=active, false=inactive) | 9 | **domain** | **String** | Domain associated to the IP | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AbTestVersionClicksInner.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AbTestVersionClicksInner 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link** | **String** | URL of the link | 7 | **clicks_count** | **Float** | Number of times a link is clicked | 8 | **click_rate** | **String** | Percentage of clicks of link with respect to total clicks | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ConversationsMessageFileImageInfo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::ConversationsMessageFileImageInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **width** | **Integer** | Width of the image | [optional] 7 | **height** | **Integer** | height of the image | [optional] 8 | **preview_url** | **String** | URL of the preview | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedClientAddress.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedClientAddress 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **street** | **String** | Street information | 7 | **city** | **String** | City information | 8 | **zip_code** | **String** | Zip Code information | 9 | **country** | **String** | Country information | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContacts.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetTransacBlockedContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **Integer** | Count of blocked or unsubscribed contact | [optional] 7 | **contacts** | [**Array<GetTransacBlockedContactsContacts>**](GetTransacBlockedContactsContacts.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesUsers 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **Integer** | Quantity of multi-account's provided | [optional] 7 | **remaining** | **Integer** | Available multi-accounts for use | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TaskReminder.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::TaskReminder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **Integer** | Value of time unit before reminder is to be sent | 7 | **unit** | **String** | Unit of time before reminder is to be sent | 8 | **types** | **Array<String>** | Type of task reminder e.g email, push | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplateOverviewSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 11 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesLandingPage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **Integer** | Quantity of landing pages provided | [optional] 7 | **remaining** | **Integer** | Available landing pages for use | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AddCredits.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AddCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **Integer** | Required if email credits are empty. SMS credits to be added to the child account | [optional] 7 | **email** | **Integer** | Required if sms credits are empty. Email credits to be added to the child account | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsClicked.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetContactCampaignStatsClicked 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **links** | [**Array<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfoCreditsEmails 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **Integer** | Quantity of email messaging limits provided | [optional] 7 | **remaining** | **Integer** | Available email messaging limits for use | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequestFeatures.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountUpdatePlanRequestFeatures 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **users** | **Integer** | Number of multi-users | [optional] 7 | **landing_page** | **Integer** | Number of landing pages | [optional] 8 | **inbox** | **Integer** | Number of inboxes | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetAccountMarketingAutomation.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAccountMarketingAutomation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **String** | Marketing Automation Tracker ID | [optional] 7 | **enabled** | **BOOLEAN** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignOverviewSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 11 | -------------------------------------------------------------------------------- /docs/PostSendSmsTestFailed.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::PostSendSmsTestFailed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **Integer** | Response code | 7 | **message** | **String** | Response message | 8 | **unexisting_sms** | **Array<String>** | | [optional] 9 | **without_list_sms** | **Array<String>** | | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendTestEmail.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SendTestEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_to** | **Array<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 | 9 | -------------------------------------------------------------------------------- /docs/RemoveCredits.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RemoveCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **Integer** | Required if email credits are empty. SMS credits to be removed from the child account | [optional] 7 | **email** | **Integer** | Required if sms credits are empty. Email credits to be removed from the child account | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **event_time** | **String** | UTC date-time of the event | 7 | **ip** | **String** | IP from which the user has been unsubscribed | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetProcess.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetProcess 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | Id of the process | 7 | **status** | **String** | Status of the process | 8 | **name** | **String** | Process name | 9 | **export_url** | **String** | URL on which send export the of contacts once the process is completed | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequest.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountUpdatePlanRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **credits** | [**SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) | | [optional] 7 | **features** | [**SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UploadImageToGallery.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UploadImageToGallery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **image_url** | **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 | 10 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByMessageId.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetScheduledEmailByMessageId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **scheduled_at** | **DateTime** | Datetime for which the email was scheduled | 7 | **created_at** | **DateTime** | Datetime on which the email was scheduled | 8 | **status** | **String** | Current status of the scheduled email | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScheduleSmtpEmail.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::ScheduleSmtpEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **String** | Message ID of the transactional email scheduled | [optional] 7 | **message_ids** | **Array<String>** | | [optional] 8 | **batch_id** | **String** | Batch ID of the batch transactional email scheduled | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateSmsCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateSmsCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 7 | **exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/EmailExportRecipients.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::EmailExportRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **notify_url** | **String** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 7 | **recipients_type** | **String** | Type of recipients to export for a campaign | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByBatchIdBatches.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetScheduledEmailByBatchIdBatches 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **scheduled_at** | **DateTime** | Datetime for which the batch was scheduled | 7 | **created_at** | **DateTime** | Datetime on which the batch was scheduled | 8 | **status** | **String** | Current status of the scheduled batch | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContactsReason.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 10 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoCredits.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfoCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **Integer** | SMS credits remaining on the sub-account | [optional] 7 | **emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DealAttributesInner.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::DealAttributesInner 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **internal_name** | **String** | | [optional] 7 | **label** | **String** | | [optional] 8 | **attribute_type_name** | **String** | | [optional] 9 | **attribute_options** | **Array<Object>** | | [optional] 10 | **is_required** | **BOOLEAN** | | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetExtendedClient.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedClient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Login Email | 7 | **first_name** | **String** | First Name | 8 | **last_name** | **String** | Last Name | 9 | **company_name** | **String** | Name of the company | 10 | **address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CompanyAttributesInner.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CompanyAttributesInner 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **internal_name** | **String** | | [optional] 7 | **label** | **String** | | [optional] 8 | **attribute_type_name** | **String** | | [optional] 9 | **attribute_options** | **Array<Object>** | | [optional] 10 | **is_required** | **BOOLEAN** | | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **folder_id** | **Integer** | 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 | 10 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsEvents.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacEmailsList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetTransacEmailsList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **Integer** | Total number of transactional emails available on your account according to the passed filter | [optional] 7 | **transactional_emails** | [**Array<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/PostSendFailed.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::PostSendFailed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **Integer** | Response code | 7 | **message** | **String** | Response message | 8 | **unexisting_emails** | **Array<String>** | | [optional] 9 | **without_list_emails** | **Array<String>** | | [optional] 10 | **black_listed_emails** | **Array<String>** | | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSubAccount.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateSubAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **company_name** | **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 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsClicked.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **links** | [**Array<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/NoteData.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::NoteData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **text** | **String** | Text content of a note | 7 | **contact_ids** | **Array<Integer>** | Contact Ids linked to a note | [optional] 8 | **deal_ids** | **Array<String>** | Deal Ids linked to a note | [optional] 9 | **company_ids** | **Array<String>** | Company Ids linked to a note | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RequestSMSRecipientExport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RequestSmsRecipientExport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **notify_url** | **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 | **recipients_type** | **String** | Filter the recipients based on how they interacted with the campaign | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailAttachment.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | 11 | -------------------------------------------------------------------------------- /docs/SubAccountsResponseSubAccounts.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountsResponseSubAccounts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | id of the sub-account | 7 | **company_name** | **String** | Name of the sub-account company | 8 | **active** | **BOOLEAN** | Whether the sub-account is active or not | 9 | **created_at** | **Integer** | Timestamp when the sub-account was created | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RequestContactImportNewList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RequestContactImportNewList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_name** | **String** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] 7 | **folder_id** | **Integer** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfoStatistics.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildInfoStatistics 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **previous_month_total_sent** | **Integer** | Overall emails sent for the previous month | [optional] 7 | **current_month_total_sent** | **Integer** | Overall emails sent for current month | [optional] 8 | **total_sent** | **Integer** | Overall emails sent for since the account exists | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsOpened.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetContactCampaignStatsOpened 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **count** | **Integer** | Number of openings of the campaign | 8 | **event_time** | **String** | UTC date-time of the event | 9 | **ip** | **String** | IP from which the user has opened the campaign | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**Array<CreateSenderIps>**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsLinks.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **Integer** | Number of clicks on this link for the campaign | 7 | **event_time** | **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 | 12 | -------------------------------------------------------------------------------- /docs/GetList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the list | 7 | **name** | **String** | Name of the list | 8 | **total_blacklisted** | **Integer** | Number of blacklisted contacts in the list | 9 | **total_subscribers** | **Integer** | Number of contacts in the list | 10 | **unique_subscribers** | **Integer** | Number of unique contacts in the list | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateEmailCampaignSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateEmailCampaignSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Sender Name | [optional] 7 | **email** | **String** | Sender email | 8 | **id** | **Integer** | 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 | 11 | -------------------------------------------------------------------------------- /docs/SendSms.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SendSms 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reference** | **String** | | 7 | **message_id** | **Integer** | | 8 | **sms_count** | **Integer** | Count of SMS's to send multiple text messages | [optional] 9 | **used_credits** | **Float** | SMS credits used per text message | [optional] 10 | **remaining_credits** | **Float** | Remaining SMS credits of the user | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **event_time** | **String** | UTC date-time of the event | 8 | **ip** | **String** | IP from which the user has unsubscribed | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**Array<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 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsOpened.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsOpened 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **Integer** | ID of the campaign which generated the event | 7 | **count** | **Integer** | Number of openings for the campaign | 8 | **event_time** | **String** | UTC date-time of the event | 9 | **ip** | **String** | IP from which the user has opened the email | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetFolder.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetFolder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the folder | 7 | **name** | **String** | Name of the folder | 8 | **total_blacklisted** | **Integer** | Number of blacklisted contacts in the folder | 9 | **total_subscribers** | **Integer** | Number of contacts in the folder | 10 | **unique_subscribers** | **Integer** | Number of unique contacts in the folder | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Deal.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Deal 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique deal id | [optional] 7 | **attributes** | **Object** | Deal attributes with values | [optional] 8 | **linked_contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this deal | [optional] 9 | **linked_companies_ids** | **Array<String>** | Companies ids for companies linked to this deal | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSenderIps.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | 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 | 11 | -------------------------------------------------------------------------------- /docs/Company.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Company 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique company id | [optional] 7 | **attributes** | **Object** | Company attributes with values | [optional] 8 | **linked_contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this company | [optional] 9 | **linked_deals_ids** | **Array<String>** | Deals ids for companies linked to this company | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfoAddress.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::MasterDetailsResponseBillingInfoAddress 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **street_address** | **String** | Street address | [optional] 7 | **locality** | **String** | Locality | [optional] 8 | **postal_code** | **String** | Postal code | [optional] 9 | **state_code** | **String** | State code | [optional] 10 | **country_code** | **String** | Country code | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **credits** | [**SubAccountDetailsResponsePlanInfoCredits**](SubAccountDetailsResponsePlanInfoCredits.md) | | [optional] 7 | **features** | [**SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) | | [optional] 8 | **plan_type** | **String** | type of the plan | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateSmtpTemplateSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | 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 | 11 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **company_name** | **String** | Sub-account company name | [optional] 9 | **plan_info** | [**SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) | | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ConversationsMessageFile.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::ConversationsMessageFile 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filename** | **String** | Name of the file | [optional] 7 | **size** | **Integer** | Size in bytes | [optional] 8 | **is_image** | **BOOLEAN** | Whether the file is an image | [optional] 9 | **url** | **String** | URL of the file | [optional] 10 | **image_info** | [**ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSenderModel.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateSenderModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the Sender created | 7 | **spf_error** | **BOOLEAN** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] 8 | **dkim_error** | **BOOLEAN** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateSmtpTemplateSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | 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 | 11 | -------------------------------------------------------------------------------- /docs/CreateEmailCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateEmailCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **exclusion_list_ids** | **Array<Integer>** | List ids to exclude from the campaign | [optional] 7 | **list_ids** | **Array<Integer>** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 8 | **segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContactsContacts.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetTransacBlockedContactsContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Email address of the blocked or unsubscribed contact | 7 | **sender_email** | **String** | Sender email address of the blocked or unsubscribed contact | 8 | **reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | | 9 | **blocked_at** | **String** | Date when the contact was blocked or unsubscribed on | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponsePlanInfoFeatures.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::MasterDetailsResponsePlanInfoFeatures 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of the feature | [optional] 7 | **unit_value** | **String** | Unit value of the feature | [optional] 8 | **quantity** | **Integer** | Quantity provided in the plan | [optional] 9 | **used** | **Integer** | Quantity consumed by master | [optional] 10 | **remaining** | **Integer** | Quantity remaining in the plan | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateEmailCampaignSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | 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 | 11 | -------------------------------------------------------------------------------- /docs/Body5.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body5 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with deal | [optional] 7 | **unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from deal | [optional] 8 | **link_company_ids** | **Array<String>** | Company ids to be linked with deal | [optional] 9 | **unlink_company_ids** | **Array<String>** | Company ids to be unlinked from deal | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::MasterDetailsResponseBillingInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Billing email id of master account | [optional] 7 | **company_name** | **String** | Company name of master account | [optional] 8 | **name** | [**MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) | | [optional] 9 | **address** | [**MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) | | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PostContactInfoContacts.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::PostContactInfoContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **success** | **Array<String>** | | [optional] 7 | **failure** | **Array<String>** | | [optional] 8 | **total** | **Integer** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] 9 | **process_id** | **Integer** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetDeviceBrowserStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetDeviceBrowserStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **clickers** | **Integer** | Number of total clicks for the campaign using the particular browser | 7 | **unique_clicks** | **Integer** | Number of unique clicks for the campaign using the particular browser | 8 | **viewed** | **Integer** | Number of openings for the campaign using the particular browser | 9 | **unique_views** | **Integer** | Number of unique openings for the campaign using the particular browser | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuidAttachments.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **content_type** | **String** | value of the Content-Type header of the attachment | [optional] 8 | **content_id** | **String** | value of the Content-ID header of the attachment. | [optional] 9 | **content_length** | **Integer** | size of the attachment in bytes | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Body2.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body2 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with company | [optional] 7 | **unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from company | [optional] 8 | **link_deals_ids** | **Array<String>** | Deals ids for deals to be linked with company | [optional] 9 | **unlink_deals_ids** | **Array<String>** | Deals ids for deals to be unlinked from company | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetAttributesAttributes.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**Array<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional] 10 | **calculated_value** | **String** | Calculated value formula | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **delivered** | **Integer** | Number of delivered SMS | 7 | **sent** | **Integer** | Number of sent SMS | 8 | **processing** | **Integer** | Number of processing SMS | 9 | **soft_bounces** | **Integer** | Number of softbounced SMS | 10 | **hard_bounces** | **Integer** | Number of hardbounced SMS | 11 | **unsubscriptions** | **Integer** | Number of unsubscription SMS | 12 | **answered** | **Integer** | Number of replies to the SMS | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateChild.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateChild 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Email address to create the child account | 7 | **first_name** | **String** | First name to use to create the child account | 8 | **last_name** | **String** | Last name to use to create the child account | 9 | **company_name** | **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 | 14 | -------------------------------------------------------------------------------- /docs/UpdateChild.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateChild 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | New Email address to update the child account | [optional] 7 | **first_name** | **String** | New First name to use to update the child account | [optional] 8 | **last_name** | **String** | New Last name to use to update the child account | [optional] 9 | **company_name** | **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 | 13 | -------------------------------------------------------------------------------- /docs/GetSendersListSenders.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSendersListSenders 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | Id of the sender | 7 | **name** | **String** | From Name associated to the sender | 8 | **email** | **String** | From Email associated to the sender | 9 | **active** | **BOOLEAN** | Status of sender (true=activated, false=deactivated) | 10 | **ips** | [**Array<GetSendersListIps>**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResultStatistics.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AbTestCampaignResultStatistics 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 7 | **clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 8 | **unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 9 | **hard_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 10 | **soft_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 11 | **complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeatures.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeatures 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **inbox** | [**SubAccountDetailsResponsePlanInfoFeaturesInbox**](SubAccountDetailsResponsePlanInfoFeaturesInbox.md) | | [optional] 7 | **landing_page** | [**SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) | | [optional] 8 | **users** | [**SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesUsers.md) | | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetWebhook.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **String** | URL of the webhook | 7 | **id** | **Integer** | ID of the webhook | 8 | **description** | **String** | Description of the webhook | 9 | **events** | **Array<String>** | | 10 | **type** | **String** | Type of webhook (marketing or transac) | 11 | **created_at** | **String** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **modified_at** | **String** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Task.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Task 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Unique task id | [optional] 7 | **task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | 8 | **name** | **String** | Name of task | 9 | **contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional] 10 | **deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional] 11 | **companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DeleteHardbounces.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::DeleteHardbounces 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **start_date** | **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 | **end_date** | **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 | **contact_email** | **String** | Target a specific email address | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Note.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **contact_ids** | **Array<Integer>** | Contact ids linked to a note | [optional] 9 | **deal_ids** | **Array<String>** | Deal ids linked to a note | [optional] 10 | **author_id** | **Object** | Account details of user which created the note | [optional] 11 | **created_at** | **DateTime** | Note created date/time | [optional] 12 | **updated_at** | **DateTime** | Note updated date/time | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/FileData.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::FileData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of uploaded file | [optional] 7 | **author_id** | **String** | Account id of user which created the file | [optional] 8 | **contact_id** | **Integer** | Contact id of contact on which file is uploaded | [optional] 9 | **deal_id** | **String** | Deal id linked to a file | [optional] 10 | **company_id** | **String** | Company id linked to a file | [optional] 11 | **size** | **Integer** | Size of file in bytes | [optional] 12 | **created_at** | **DateTime** | File created date/time | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponsePlanInfo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::MasterDetailsResponsePlanInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **currency_code** | **String** | Plan currency | [optional] 7 | **next_billing_at** | **Integer** | Timestamp of next billing date | [optional] 8 | **price** | **Float** | Plan amount | [optional] 9 | **plan_period** | **String** | Plan period type | [optional] 10 | **sub_accounts** | **Integer** | Number of sub-accounts | [optional] 11 | **features** | [**Array<MasterDetailsResponsePlanInfoFeatures>**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AddContactToList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AddContactToList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **emails** | **Array<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** | **Array<Integer>** | 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 | 10 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailSender.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | 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 | 11 | -------------------------------------------------------------------------------- /docs/UpdateAttribute.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**Array<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 | 10 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsUnsubscriptions.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email | 7 | **admin_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAccount.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Login Email | 7 | **first_name** | **String** | First Name | 8 | **last_name** | **String** | Last Name | 9 | **company_name** | **String** | Name of the company | 10 | **address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | 11 | **plan** | [**Array<GetAccountPlan>**](GetAccountPlan.md) | Information about your plans and credits | 12 | **relay** | [**GetAccountRelay**](GetAccountRelay.md) | | 13 | **marketing_automation** | [**GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RequestContactExport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RequestContactExport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **export_attributes** | **Array<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 | **custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | 8 | **notify_url** | **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 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign | 7 | **admin_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetSmsEventReportEvents.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsEventReportEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **phone_number** | **String** | Phone number which has generated the event | [optional] 7 | **date** | **String** | UTC date-time on which the event has been generated | [optional] 8 | **message_id** | **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 | 15 | -------------------------------------------------------------------------------- /docs/UpdateEmailCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateEmailCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional] 7 | **list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] 8 | **segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetChildInfo.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetChildInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Login Email | 7 | **first_name** | **String** | First Name | 8 | **last_name** | **String** | Last Name | 9 | **company_name** | **String** | Name of the company | 10 | **credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional] 11 | **statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional] 12 | **password** | **String** | The encrypted password of child account | 13 | **ips** | **Array<String>** | IP(s) associated to a child account user | [optional] 14 | **api_keys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional] 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetTransacEmailContent.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **template_id** | **Integer** | Id of the template | [optional] 9 | **date** | **String** | Date on which transactional email was sent | 10 | **events** | [**Array<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 | **attachment_count** | **Integer** | Count of the attachments that were sent in the email | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetStatsByDevice.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetStatsByDevice 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **desktop** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] 7 | **mobile** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] 8 | **tablet** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] 9 | **unknown** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateChildAccountStatus.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateChildAccountStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **transactional_email** | **BOOLEAN** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] 7 | **transactional_sms** | **BOOLEAN** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] 8 | **marketing_automation** | **BOOLEAN** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] 9 | **sms_campaign** | **BOOLEAN** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by: https://github.com/swagger-api/swagger-codegen.git 2 | # 3 | 4 | *.gem 5 | *.rbc 6 | /.config 7 | /coverage/ 8 | /InstalledFiles 9 | /pkg/ 10 | /spec/reports/ 11 | /spec/examples.txt 12 | /test/tmp/ 13 | /test/version_tmp/ 14 | /tmp/ 15 | 16 | ## Specific to RubyMotion: 17 | .dat* 18 | .repl_history 19 | build/ 20 | 21 | ## Documentation cache and generated files: 22 | /.yardoc/ 23 | /_yardoc/ 24 | /doc/ 25 | /rdoc/ 26 | 27 | ## Environment normalization: 28 | /.bundle/ 29 | /vendor/bundle 30 | /lib/bundler/man/ 31 | 32 | # for a library or gem, you might want to ignore these files since the code is 33 | # intended to run in multiple environments; otherwise, check them in: 34 | # Gemfile.lock 35 | # .ruby-version 36 | # .ruby-gemset 37 | 38 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 39 | .rvmrc 40 | -------------------------------------------------------------------------------- /docs/GetTransacEmailsListTransactionalEmails.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **template_id** | **Integer** | Id of the template | [optional] 9 | **message_id** | **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** | **Array<String>** | Tags used for your email | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignOverview.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsCampaignOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | 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 | **scheduled_at** | **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 | **created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::MasterDetailsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **String** | Email id of master account | [optional] 7 | **company_name** | **String** | Company name of master account organization | [optional] 8 | **id** | **Integer** | Unique identifier of the master account organization | [optional] 9 | **currency_code** | **String** | Currency code of the master account organization | [optional] 10 | **timezone** | **String** | Timezone of the master account organization | [optional] 11 | **billing_info** | [**MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) | | [optional] 12 | **plan_info** | [**MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) | | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RemoveContactFromList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::RemoveContactFromList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **emails** | **Array<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** | **Array<Integer>** | 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** | **BOOLEAN** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedList.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the list | 7 | **name** | **String** | Name of the list | 8 | **total_blacklisted** | **Integer** | Number of blacklisted contacts in the list | 9 | **total_subscribers** | **Integer** | Number of contacts in the list | 10 | **unique_subscribers** | **Integer** | Number of unique contacts in the list | 11 | **folder_id** | **Integer** | ID of the folder | 12 | **created_at** | **String** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional] 14 | **dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional] 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Body10.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body10 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> | 7 | **text** | **String** | message text | 8 | **agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional] 9 | **group_id** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **global_stats** | [**GetExtendedCampaignStatsGlobalStats**](GetExtendedCampaignStatsGlobalStats.md) | | 7 | **campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. | 8 | **mirror_click** | **Integer** | Number of clicks on mirror link | 9 | **remaining** | **Integer** | Number of remaning emails to send | 10 | **links_stats** | **Object** | Statistics about the number of clicks for the links | 11 | **stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) | | 12 | **stats_by_device** | [**GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices | 13 | **stats_by_browser** | [**GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Body7.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body7 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of task | [optional] 7 | **duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 8 | **task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional] 9 | **date** | **DateTime** | Task date/time | [optional] 10 | **notes** | **String** | Notes added to a task | [optional] 11 | **done** | **BOOLEAN** | Task marked as done | [optional] 12 | **assign_to_id** | **String** | User id to whom task is assigned | [optional] 13 | **contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional] 14 | **deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional] 15 | **companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetSmsCampaign.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmsCampaign 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | 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 | **scheduled_at** | **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 | **created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | **recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | | 15 | **statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CreateSmsCampaign.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] 10 | **scheduled_at** | **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 | **unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetContactDetails.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | ID of the contact for which you requested the details | 8 | **email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 9 | **sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 10 | **created_at** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 11 | **modified_at** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **list_ids** | **Array<Integer>** | | 13 | **list_unsubscribed** | **Array<Integer>** | | [optional] 14 | **attributes** | **Object** | Set of attributes of the contact | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetTransacSmsReportReports.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetTransacSmsReportReports 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **date** | **Date** | Date for which statistics are retrieved | [optional] 7 | **requests** | **Integer** | Number of requests for the date | [optional] 8 | **delivered** | **Integer** | Number of delivered SMS for the date | [optional] 9 | **hard_bounces** | **Integer** | Number of hardbounces for the date | [optional] 10 | **soft_bounces** | **Integer** | Number of softbounces for the date | [optional] 11 | **blocked** | **Integer** | Number of blocked contact for the date | [optional] 12 | **unsubscribed** | **Integer** | Number of unsubscription for the date | [optional] 13 | **replied** | **Integer** | Number of answered SMS for the date | [optional] 14 | **accepted** | **Integer** | Number of accepted for the date | [optional] 15 | **rejected** | **Integer** | Number of rejected for the date | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UpdateSmsCampaign.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] 10 | **scheduled_at** | **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 | **unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body6.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body6 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | Name of task | 7 | **duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 8 | **task_type_id** | **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** | **BOOLEAN** | Task marked as done | [optional] 12 | **assign_to_id** | **String** | User id to whom task is assigned | [optional] 13 | **contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional] 14 | **deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional] 15 | **companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional] 16 | **reminder** | [**TaskReminder**](TaskReminder.md) | | [optional] 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetTransacAggregatedSmsReport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetTransacAggregatedSmsReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **range** | **String** | Time frame of the report | [optional] 7 | **requests** | **Integer** | Number of requests for the timeframe | [optional] 8 | **delivered** | **Integer** | Number of delivered SMS for the timeframe | [optional] 9 | **hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional] 10 | **soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional] 11 | **blocked** | **Integer** | Number of blocked contact for the timeframe | [optional] 12 | **unsubscribed** | **Integer** | Number of unsubscription for the timeframe | [optional] 13 | **replied** | **Integer** | Number of answered SMS for the timeframe | [optional] 14 | **accepted** | **Integer** | Number of accepted for the timeframe | [optional] 15 | **rejected** | **Integer** | Number of rejected for the timeframe | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetAccountPlan.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAccountPlan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **String** | Displays the plan type of the user | 7 | **credits_type** | **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 | **start_date** | **Date** | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional] 10 | **end_date** | **Date** | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional] 11 | **user_limit** | **Integer** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body12.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body12 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional] 7 | **received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional] 8 | **agent_email** | **String** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Sendinblue organization, a dummy agent will be created automatically. | [optional] 9 | **agent_name** | **String** | agent name. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateDoiContact.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **include_list_ids** | **Array<Integer>** | Lists under user account where contact should be added | 9 | **exclude_list_ids** | **Array<Integer>** | Lists under user account where contact should not be added | [optional] 10 | **template_id** | **Integer** | Id of the Double opt-in (DOI) template | 11 | **redirection_url** | **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 | 14 | -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /docs/GetReportsReports.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetReportsReports 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **date** | **Date** | Date of the statistics | 7 | **requests** | **Integer** | Number of requests for the date | 8 | **delivered** | **Integer** | Number of delivered emails for the date | 9 | **hard_bounces** | **Integer** | Number of hardbounces for the date | 10 | **soft_bounces** | **Integer** | Number of softbounces for the date | 11 | **clicks** | **Integer** | Number of clicks for the date | 12 | **unique_clicks** | **Integer** | Number of unique clicks for the date | 13 | **opens** | **Integer** | Number of openings for the date | 14 | **unique_opens** | **Integer** | Number of unique openings for the date | 15 | **spam_reports** | **Integer** | Number of complaints (spam reports) for the date | 16 | **blocked** | **Integer** | Number of blocked emails for the date | 17 | **invalid** | **Integer** | Number of invalid emails for the date | 18 | **unsubscribed** | **Integer** | Number of unsubscribed emails for the date | 19 | 20 | 21 | -------------------------------------------------------------------------------- /lib/sib-api-v3-sdk/version.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | module SibApiV3Sdk 14 | VERSION = "9.1.0" 15 | end 16 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2020 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. 22 | -------------------------------------------------------------------------------- /docs/CreateAttribute.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | [**Array<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 | 11 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetails.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Integer** | ID of the contact for which you requested the details | 8 | **email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 9 | **sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 10 | **created_at** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 11 | **modified_at** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **list_ids** | **Array<Integer>** | | 13 | **list_unsubscribed** | **Array<Integer>** | | [optional] 14 | **attributes** | **Object** | Set of attributes of the contact | 15 | **statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResult.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AbTestCampaignResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **winning_version** | **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 | **winning_criteria** | **String** | Criteria choosen for winning version (Open/Click) | [optional] 8 | **winning_subject_line** | **String** | Subject Line of current winning version | [optional] 9 | **open_rate** | **String** | Open rate for current winning version | [optional] 10 | **click_rate** | **String** | Click rate for current winning version | [optional] 11 | **winning_version_rate** | **String** | Open/Click rate for the winner version | [optional] 12 | **statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional] 13 | **clicked_links** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateWebhook.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Array<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 | 12 | -------------------------------------------------------------------------------- /docs/SendTransacSms.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] 12 | **unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuid.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetInboundEmailEventsByUuid 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **received_at** | **DateTime** | Date when email was received on SMTP relay | [optional] 7 | **delivered_at** | **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 | **message_id** | **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** | [**Array<GetInboundEmailEventsByUuidAttachments>**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional] 13 | **logs** | [**Array<GetInboundEmailEventsByUuidLogs>**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetEmailEventReportEvents.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 | **message_id** | **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 | **template_id** | **Integer** | ID of the template (only available if the email is template based) | [optional] 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/CreateWebhook.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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** | **Array<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 | 13 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailMessageVersions.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::SendSmtpEmailMessageVersions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | [**Array<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** | **Hash<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** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] 9 | **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] 10 | **reply_to** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional] 11 | **subject** | **String** | Custom subject specific to message version | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConversationsMessage.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::ConversationsMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | Message ID. It can be used for further manipulations with the message. | [optional] 7 | **type** | **String** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional] 8 | **text** | **String** | Message text or name of the attached file | [optional] 9 | **visitor_id** | **String** | visitor’s ID | [optional] 10 | **agent_id** | **String** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] 11 | **agent_name** | **String** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] 12 | **created_at** | **Integer** | Timestamp in milliseconds. | [optional] 13 | **is_pushed** | **BOOLEAN** | `true` for pushed messages | [optional] 14 | **received_from** | **String** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional] 15 | **file** | [**ConversationsMessageFile**](ConversationsMessageFile.md) | | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetAggregatedReport.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetAggregatedReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **range** | **String** | Time frame of the report | [optional] 7 | **requests** | **Integer** | Number of requests for the timeframe | [optional] 8 | **delivered** | **Integer** | Number of delivered emails for the timeframe | [optional] 9 | **hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional] 10 | **soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional] 11 | **clicks** | **Integer** | Number of clicks for the timeframe | [optional] 12 | **unique_clicks** | **Integer** | Number of unique clicks for the timeframe | [optional] 13 | **opens** | **Integer** | Number of openings for the timeframe | [optional] 14 | **unique_opens** | **Integer** | Number of unique openings for the timeframe | [optional] 15 | **spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe | [optional] 16 | **blocked** | **Integer** | Number of blocked contact emails for the timeframe | [optional] 17 | **invalid** | **Integer** | Number of invalid emails for the timeframe | [optional] 18 | **unsubscribed** | **Integer** | Number of unsubscribed emails for the timeframe | [optional] 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/Body8.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::Body8 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> | 7 | **text** | **String** | message text | 8 | **agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional] 9 | **received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional] 10 | **agent_email** | **String** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional] 11 | **agent_name** | **String** | agent name | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplateOverview.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetSmtpTemplateOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | ID of the template | 7 | **name** | **String** | Name of the template | 8 | **subject** | **String** | Subject of the template | 9 | **is_active** | **BOOLEAN** | Status of template (true=active, false=inactive) | 10 | **test_sent** | **BOOLEAN** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) | 11 | **sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | | 12 | **reply_to** | **String** | Email defined as the \"Reply to\" for the template | 13 | **to_field** | **String** | Customisation of the \"to\" field for the template | 14 | **tag** | **String** | Tag of the template | 15 | **html_content** | **String** | HTML content of the template | 16 | **created_at** | **String** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 17 | **modified_at** | **String** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 18 | **doi_template** | **BOOLEAN** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetContactCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messages_sent** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 7 | **hard_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 8 | **soft_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 9 | **complaints** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 10 | **unsubscriptions** | [**GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) | | [optional] 11 | **opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) | | [optional] 12 | **clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) | | [optional] 13 | **transac_attributes** | [**Array<GetContactCampaignStatsTransacAttributes>**](GetContactCampaignStatsTransacAttributes.md) | | [optional] 14 | **delivered** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateContact.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] 8 | **email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 9 | **sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 10 | **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 11 | **update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false] 12 | **smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UpdateContact.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::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 attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] 7 | **email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] 8 | **sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 9 | **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 10 | **unlink_list_ids** | **Array<Integer>** | Ids of the lists to remove the contact from | [optional] 11 | **smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CreateSmtpTemplate.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::CreateSmtpTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **tag** | **String** | Tag of the template | [optional] 7 | **sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | | 8 | **template_name** | **String** | Name of the template | 9 | **html_content** | **String** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional] 10 | **html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 11 | **subject** | **String** | Subject of the template | 12 | **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 13 | **to_field** | **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 | **attachment_url** | **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 | **is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /spec/models/file_list_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::FileList 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'FileList' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::FileList.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of FileList' do 31 | it 'should create an instance of FileList' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::FileList) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /spec/models/note_list_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::NoteList 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'NoteList' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::NoteList.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of NoteList' do 31 | it 'should create an instance of NoteList' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::NoteList) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /docs/GetCampaignStats.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional] 7 | **unique_clicks** | **Integer** | Number of unique clicks for the campaign | 8 | **clickers** | **Integer** | Number of total clicks for the campaign | 9 | **complaints** | **Integer** | Number of complaints (Spam reports) for the campaign | 10 | **delivered** | **Integer** | Number of delivered emails for the campaign | 11 | **sent** | **Integer** | Number of sent emails for the campaign | 12 | **soft_bounces** | **Integer** | Number of softbounce for the campaign | 13 | **hard_bounces** | **Integer** | Number of harbounce for the campaign | 14 | **unique_views** | **Integer** | Number of unique openings for the campaign | 15 | **trackable_views** | **Integer** | Recipients without any privacy protection option enabled in their email client | 16 | **trackable_views_rate** | **Float** | Rate of recipients without any privacy protection option enabled in their email client | [optional] 17 | **estimated_views** | **Integer** | Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails | [optional] 18 | **unsubscriptions** | **Integer** | Number of unsubscription for the campaign | 19 | **viewed** | **Integer** | Number of openings for the campaign | 20 | **deferred** | **Integer** | Number of deferred emails for the campaign | [optional] 21 | **return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional] 22 | 23 | 24 | -------------------------------------------------------------------------------- /spec/models/deal_attributes_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::DealAttributes 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'DealAttributes' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::DealAttributes.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of DealAttributes' do 31 | it 'should create an instance of DealAttributes' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::DealAttributes) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /spec/models/get_child_domains_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetChildDomains 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetChildDomains' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetChildDomains.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetChildDomains' do 31 | it 'should create an instance of GetChildDomains' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetChildDomains) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /spec/models/get_stats_by_domain_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetStatsByDomain 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetStatsByDomain' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetStatsByDomain.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetStatsByDomain' do 31 | it 'should create an instance of GetStatsByDomain' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetStatsByDomain) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /docs/UpdateSmtpTemplate.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::UpdateSmtpTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **tag** | **String** | Tag of the template | [optional] 7 | **sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional] 8 | **template_name** | **String** | Name of the template | [optional] 9 | **html_content** | **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 | **html_url** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 11 | **subject** | **String** | Subject of the email | [optional] 12 | **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 13 | **to_field** | **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 | **attachment_url** | **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 | **is_active** | **BOOLEAN** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /spec/models/company_attributes_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::CompanyAttributes 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'CompanyAttributes' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::CompanyAttributes.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of CompanyAttributes' do 31 | it 'should create an instance of CompanyAttributes' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::CompanyAttributes) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /spec/models/get_stats_by_browser_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetStatsByBrowser 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetStatsByBrowser' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetStatsByBrowser.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetStatsByBrowser' do 31 | it 'should create an instance of GetStatsByBrowser' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetStatsByBrowser) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /spec/models/ab_test_version_clicks_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::AbTestVersionClicks 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'AbTestVersionClicks' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::AbTestVersionClicks.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of AbTestVersionClicks' do 31 | it 'should create an instance of AbTestVersionClicks' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::AbTestVersionClicks) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /docs/AccountApi.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::AccountApi 2 | 3 | All URIs are relative to *https://api.sendinblue.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details 8 | 9 | 10 | # **get_account** 11 | > GetAccount get_account 12 | 13 | Get your account information, plan and credits details 14 | 15 | ### Example 16 | ```ruby 17 | # load the gem 18 | require 'sib-api-v3-sdk' 19 | # setup authorization 20 | SibApiV3Sdk.configure do |config| 21 | # Configure API key authorization: api-key 22 | config.api_key['api-key'] = 'YOUR API KEY' 23 | # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) 24 | #config.api_key_prefix['api-key'] = 'Bearer' 25 | 26 | # Configure API key authorization: partner-key 27 | config.api_key['partner-key'] = 'YOUR API KEY' 28 | # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) 29 | #config.api_key_prefix['partner-key'] = 'Bearer' 30 | end 31 | 32 | api_instance = SibApiV3Sdk::AccountApi.new 33 | 34 | begin 35 | #Get your account information, plan and credits details 36 | result = api_instance.get_account 37 | p result 38 | rescue SibApiV3Sdk::ApiError => e 39 | puts "Exception when calling AccountApi->get_account: #{e}" 40 | end 41 | ``` 42 | 43 | ### Parameters 44 | This endpoint does not need any parameter. 45 | 46 | ### Return type 47 | 48 | [**GetAccount**](GetAccount.md) 49 | 50 | ### Authorization 51 | 52 | [api-key](../README.md#api-key), [partner-key](../README.md#partner-key) 53 | 54 | ### HTTP request headers 55 | 56 | - **Content-Type**: application/json 57 | - **Accept**: application/json 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /spec/models/get_sms_campaign_recipients_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetSmsCampaignRecipients 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetSmsCampaignRecipients' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetSmsCampaignRecipients.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetSmsCampaignRecipients' do 31 | it 'should create an instance of GetSmsCampaignRecipients' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetSmsCampaignRecipients) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /docs/GetCampaignOverview.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetCampaignOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | 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 | **scheduled_at** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] 12 | **ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] 13 | **subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] 14 | **subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] 15 | **split_rule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] 16 | **winner_criteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] 17 | **winner_delay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] 18 | **send_at_best_time** | **BOOLEAN** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] 19 | 20 | 21 | -------------------------------------------------------------------------------- /lib/sib-api-v3-sdk/api_error.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | module SibApiV3Sdk 14 | class ApiError < StandardError 15 | attr_reader :code, :response_headers, :response_body 16 | 17 | # Usage examples: 18 | # ApiError.new 19 | # ApiError.new("message") 20 | # ApiError.new(:code => 500, :response_headers => {}, :response_body => "") 21 | # ApiError.new(:code => 404, :message => "Not Found") 22 | def initialize(arg = nil) 23 | if arg.is_a? Hash 24 | if arg.key?(:message) || arg.key?('message') 25 | super(arg[:message] || arg['message']) 26 | else 27 | super arg 28 | end 29 | 30 | arg.each do |k, v| 31 | instance_variable_set "@#{k}", v 32 | end 33 | else 34 | super arg 35 | end 36 | end 37 | end 38 | end 39 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatistics.md: -------------------------------------------------------------------------------- 1 | # SibApiV3Sdk::GetExtendedContactDetailsStatistics 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messages_sent** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the sent campaign for the contact | [optional] 7 | **hard_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the hardbounes generated by the contact | [optional] 8 | **soft_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the softbounes generated by the contact | [optional] 9 | **complaints** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the complaints generated by the contact | [optional] 10 | **unsubscriptions** | [**GetExtendedContactDetailsStatisticsUnsubscriptions**](GetExtendedContactDetailsStatisticsUnsubscriptions.md) | | [optional] 11 | **opened** | [**Array<GetExtendedContactDetailsStatisticsOpened>**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional] 12 | **clicked** | [**Array<GetExtendedContactDetailsStatisticsClicked>**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional] 13 | **transac_attributes** | **Array<Object>** | Listing of the transactional attributes for the contact | [optional] 14 | **delivered** | [**Array<GetExtendedContactDetailsStatisticsDelivered>**](GetExtendedContactDetailsStatisticsDelivered.md) | Listing of the delivered campaign for the contact | [optional] 15 | 16 | 17 | -------------------------------------------------------------------------------- /spec/models/body_9_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::Body9 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'Body9' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::Body9.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of Body9' do 31 | it 'should create an instance of Body9' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::Body9) 33 | end 34 | end 35 | describe 'test attribute "text"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/get_extended_campaign_stats_global_stats_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetExtendedCampaignStatsGlobalStats' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetExtendedCampaignStatsGlobalStats' do 31 | it 'should create an instance of GetExtendedCampaignStatsGlobalStats' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats) 33 | end 34 | end 35 | end 36 | -------------------------------------------------------------------------------- /spec/models/note_id_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::NoteId 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'NoteId' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::NoteId.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of NoteId' do 31 | it 'should create an instance of NoteId' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::NoteId) 33 | end 34 | end 35 | describe 'test attribute "id"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/body_11_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::Body11 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'Body11' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::Body11.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of Body11' do 31 | it 'should create an instance of Body11' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::Body11) 33 | end 34 | end 35 | describe 'test attribute "text"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/get_ips_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetIps 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetIps' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetIps.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetIps' do 31 | it 'should create an instance of GetIps' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetIps) 33 | end 34 | end 35 | describe 'test attribute "ips"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/manage_ip_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::ManageIp 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'ManageIp' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::ManageIp.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of ManageIp' do 31 | it 'should create an instance of ManageIp' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::ManageIp) 33 | end 34 | end 35 | describe 'test attribute "ip"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/pipeline_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::Pipeline 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'Pipeline' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::Pipeline.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of Pipeline' do 31 | it 'should create an instance of Pipeline' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::Pipeline) 33 | end 34 | end 35 | describe 'test attribute "stages"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/task_list_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::TaskList 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'TaskList' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::TaskList.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of TaskList' do 31 | it 'should create an instance of TaskList' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::TaskList) 33 | end 34 | end 35 | describe 'test attribute "items"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/deals_list_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::DealsList 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'DealsList' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::DealsList.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of DealsList' do 31 | it 'should create an instance of DealsList' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::DealsList) 33 | end 34 | end 35 | describe 'test attribute "items"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/create_model_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::CreateModel 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'CreateModel' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::CreateModel.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of CreateModel' do 31 | it 'should create an instance of CreateModel' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::CreateModel) 33 | end 34 | end 35 | describe 'test attribute "id"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/get_reports_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetReports 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetReports' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetReports.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetReports' do 31 | it 'should create an instance of GetReports' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetReports) 33 | end 34 | end 35 | describe 'test attribute "reports"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/block_domain_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::BlockDomain 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'BlockDomain' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::BlockDomain.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of BlockDomain' do 31 | it 'should create an instance of BlockDomain' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::BlockDomain) 33 | end 34 | end 35 | describe 'test attribute "domain"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/get_sso_token_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetSsoToken 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetSsoToken' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetSsoToken.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetSsoToken' do 31 | it 'should create an instance of GetSsoToken' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetSsoToken) 33 | end 34 | end 35 | describe 'test attribute "token"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/get_webhooks_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::GetWebhooks 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'GetWebhooks' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::GetWebhooks.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of GetWebhooks' do 31 | it 'should create an instance of GetWebhooks' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::GetWebhooks) 33 | end 34 | end 35 | describe 'test attribute "webhooks"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/send_test_sms_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::SendTestSms 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'SendTestSms' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::SendTestSms.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of SendTestSms' do 31 | it 'should create an instance of SendTestSms' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::SendTestSms) 33 | end 34 | end 35 | describe 'test attribute "phone_number"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | -------------------------------------------------------------------------------- /spec/models/companies_list_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #SendinBlue API 3 | 4 | #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 | 5 | 6 | OpenAPI spec version: 3.0.0 7 | Contact: contact@sendinblue.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | Swagger Codegen version: 2.4.19 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | require 'date' 16 | 17 | # Unit tests for SibApiV3Sdk::CompaniesList 18 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 19 | # Please update as you see appropriate 20 | describe 'CompaniesList' do 21 | before do 22 | # run before each test 23 | @instance = SibApiV3Sdk::CompaniesList.new 24 | end 25 | 26 | after do 27 | # run after each test 28 | end 29 | 30 | describe 'test an instance of CompaniesList' do 31 | it 'should create an instance of CompaniesList' do 32 | expect(@instance).to be_instance_of(SibApiV3Sdk::CompaniesList) 33 | end 34 | end 35 | describe 'test attribute "items"' do 36 | it 'should work' do 37 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 38 | end 39 | end 40 | 41 | end 42 | --------------------------------------------------------------------------------